org.odpi.openmetadata.accessservices.subjectarea.server.mappers.relationships

Class LineMapper<L extends Line>

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.mappers.relationships.LineMapper<L>

All Implemented Interfaces:

ILineMapper<L>, Mapper<Relationship,L>

Direct Known Subclasses:

AntonymMapper, CategoryAnchorMapper, CategoryHierarchyLinkMapper, IsARelationshipMapper, PreferredTermMapper, ProjectScopeMapper, RelatedTermMapper, ReplacementTermMapper, SemanticAssignmentMapper, SynonymMapper, TermAnchorMapper, TermCategorizationMapper, TermHasARelationshipMapper, TermIsATypeOfRelationshipMapper, TermTypedByRelationshipMapper, TranslationMapper, UsedInContextMapper, ValidValueMapper

public abstract class LineMapper<L extends Line>
extends Object
implements ILineMapper<L>

Static mapping methods to map between the antonym and the equivalent generated OMRSRelationshipBean

Field Summary

Fields

Modifier and Type	Field and Description
protected OMRSAPIHelper	omrsapiHelper
protected OMRSRepositoryHelper	repositoryHelper

Constructor Summary

Constructors

Constructor and Description
LineMapper(OMRSAPIHelper omrsapiHelper)

Method Summary

Modifier and Type	Method and Description
protected String	getProxy1Guid(L line) Get proxy 1 guid
protected String	getProxy2Guid(L line) Get proxy 2 guid
String	getTypeDefGuid() get the relationshipTypeDef Guid This method should be overridden to provide the appropriate guid for the type.
abstract String	getTypeName() get type name
Relationship	map(L line) Map Line to the omrs relationship equivalent
L	map(Relationship relationship) Map from an OMRS Relationship to a Subject Area OMAS Line
protected boolean	mapEnumToLine(L line, String propertyName, EnumPropertyValue enumPropertyValue) Map an omrs enum property to a Subject Area Line property.
protected void	mapInstancePropertiesToLine(L line, InstanceProperties instanceProperties) Map the instance properties to the Line This method should be overridden by subclasses to map the properties to the Line.
protected void	mapLineToInstanceProperties(L line, InstanceProperties instanceProperties) Map the supplied Line to omrs InstanceProperties.
protected boolean	mapMapToLine(L line, String propertyName, InstanceProperties instancePropertyForMap) Map an omrs map property to a Subject Area Line property.
protected boolean	mapPrimitiveToLine(L line, String propertyName, Object value) Map an omrs primitive property to a Subject Area Line property.
protected abstract void	setEnd1GuidInLine(L line, String guid) Pass the guid of the EntityProxy for end 1 to the Line ,so it can store it appropriately
protected abstract void	setEnd2GuidInLine(L line, String guid) Pass the guid of the EntityProxy for end 2 to the Line ,so it can store it appropriately

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

omrsapiHelper

protected final OMRSAPIHelper omrsapiHelper

repositoryHelper

protected final OMRSRepositoryHelper repositoryHelper

Constructor Detail

LineMapper

public LineMapper(OMRSAPIHelper omrsapiHelper)

Method Detail

map

public L map(Relationship relationship)

Description copied from interface: ILineMapper

Map from an OMRS Relationship to a Subject Area OMAS Line

Specified by:

map in interface ILineMapper<L extends Line>

Specified by:

map in interface Mapper<Relationship,L extends Line>

Parameters:

relationship - OMRS Lines

Returns:

Subject Area OMAS Line

setEnd1GuidInLine

protected abstract void setEnd1GuidInLine(L line,
                                          String guid)

Pass the guid of the EntityProxy for end 1 to the Line ,so it can store it appropriately

Parameters:

line - line to update

guid - guid to add into the Line

setEnd2GuidInLine

protected abstract void setEnd2GuidInLine(L line,
                                          String guid)

Pass the guid of the EntityProxy for end 2 to the Line ,so it can store it appropriately

Parameters:

line - line to update

guid - guid to add into the Line

mapInstancePropertiesToLine

protected void mapInstancePropertiesToLine(L line,
                                           InstanceProperties instanceProperties)

Map the instance properties to the Line This method should be overridden by subclasses to map the properties to the Line.

Parameters:

line - line to be updated

instanceProperties - properties to use for the update

map

public Relationship map(L line)

Map Line to the omrs relationship equivalent

Specified by:

map in interface ILineMapper<L extends Line>

Specified by:

map in interface Mapper<Relationship,L extends Line>

Parameters:

line - supplied line

Returns:

omrs relationship equivalent

getTypeName

public abstract String getTypeName()

get type name

Specified by:

getTypeName in interface Mapper<Relationship,L extends Line>

Returns:

the omrs type name.

getTypeDefGuid

public String getTypeDefGuid()

get the relationshipTypeDef Guid This method should be overridden to provide the appropriate guid for the type.

Specified by:

getTypeDefGuid in interface Mapper<Relationship,L extends Line>

Returns:

the guid of the relationship typedef

getProxy1Guid

protected String getProxy1Guid(L line)

Get proxy 1 guid

Parameters:

line - for this Line

Returns:

proxy 1 guid

getProxy2Guid

protected String getProxy2Guid(L line)

Get proxy 2 guid

Parameters:

line - for this Line

Returns:

proxy 2 guid

mapPrimitiveToLine

protected boolean mapPrimitiveToLine(L line,
                                     String propertyName,
                                     Object value)

Map an omrs primitive property to a Subject Area Line property. The child class is expected to override this method if the type has primitive properties

Parameters:

line - the line to be updated

propertyName - the omrs property name

value - the omrs primitive property value

Returns:

true if it was a property we were expecting , otherwise false;

mapEnumToLine

protected boolean mapEnumToLine(L line,
                                String propertyName,
                                EnumPropertyValue enumPropertyValue)

Map an omrs enum property to a Subject Area Line property. The child class is expected to override this method if the type has enum properties

Parameters:

line - the line to be updated

propertyName - the omrs property name

enumPropertyValue - the omrs enum property value

Returns:

true if it was a property we were expecting , otherwise false;

mapMapToLine

protected boolean mapMapToLine(L line,
                               String propertyName,
                               InstanceProperties instancePropertyForMap)

Map an omrs map property to a Subject Area Line property. The child class is expected to override this method if the type has map properties

Parameters:

line - the line to be updated

propertyName - the omrs property name

instancePropertyForMap - the omrs map property value

Returns:

true if it was a property we were expecting , otherwise false;

mapLineToInstanceProperties

protected void mapLineToInstanceProperties(L line,
                                           InstanceProperties instanceProperties)

Map the supplied Line to omrs InstanceProperties. This method should be overridden to populate the instance properties

Parameters:

line - supplied line

instanceProperties - equivalent instance properties to the Line