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

Class PreferredTermMapper

java.lang.Object

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

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

All Implemented Interfaces:

ILineMapper<PreferredTerm>, Mapper<Relationship,PreferredTerm>

public class PreferredTermMapper
extends LineMapper<PreferredTerm>

Mapping methods to map between the preferredTerm and the equivalent omrs Relationship.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFERRED_TERM

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.mappers.relationships.LineMapper

omrsapiHelper, repositoryHelper

Constructor Summary

Constructors

Constructor and Description
PreferredTermMapper(OMRSAPIHelper omrsapiHelper)

Method Summary

Modifier and Type	Method and Description
protected PreferredTerm	getLineInstance()
protected String	getProxy1Guid(PreferredTerm preferredTerm) Get proxy1 guid.
protected String	getProxy2Guid(PreferredTerm preferredTerm) Get proxy2 guid The proxy has omrs type GlossaryTerm
String	getTypeName() get type name
protected boolean	mapEnumToLine(PreferredTerm preferredTerm, String propertyName, EnumPropertyValue enumPropertyValue) Map an omrs enum property to a Subject Area Line property.
protected void	mapLineToInstanceProperties(PreferredTerm preferredTerm, InstanceProperties instanceProperties) Map the supplied Line to omrs InstanceProperties.
protected boolean	mapPrimitiveToLine(PreferredTerm preferredTerm, String propertyName, Object value) Map a primitive omrs property to the preferredTerm object.
protected void	setEnd1GuidInLine(PreferredTerm preferredTerm, String guid) Pass the guid of the EntityProxy for end 1 to the Line ,so it can store it appropriately
protected void	setEnd2GuidInLine(PreferredTerm preferredTerm, String guid) Pass the guid of the EntityProxy for end 2 to the Line ,so it can store it appropriately

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.mappers.relationships.LineMapper

getTypeDefGuid, map, map, mapInstancePropertiesToLine, mapMapToLine

Methods inherited from class java.lang.Object

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

Field Detail

PREFERRED_TERM

public static final String PREFERRED_TERM

See Also:

Constant Field Values

Constructor Detail

PreferredTermMapper

public PreferredTermMapper(OMRSAPIHelper omrsapiHelper)

Method Detail

mapLineToInstanceProperties

protected void mapLineToInstanceProperties(PreferredTerm preferredTerm,
                                           InstanceProperties instanceProperties)

Map the supplied Line to omrs InstanceProperties.

Overrides:

mapLineToInstanceProperties in class LineMapper<PreferredTerm>

Parameters:

preferredTerm - supplied line

instanceProperties - equivalent instance properties to the Line

mapPrimitiveToLine

protected boolean mapPrimitiveToLine(PreferredTerm preferredTerm,
                                     String propertyName,
                                     Object value)

Map a primitive omrs property to the preferredTerm object.

Overrides:

mapPrimitiveToLine in class LineMapper<PreferredTerm>

Parameters:

preferredTerm - the glossary to be updated

propertyName - the omrs property name

value - the omrs primitive property value

Returns:

true if the propertyName was recognised and mapped to the Line, otherwise false

mapEnumToLine

protected boolean mapEnumToLine(PreferredTerm preferredTerm,
                                String propertyName,
                                EnumPropertyValue enumPropertyValue)

Description copied from class: LineMapper

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

Overrides:

mapEnumToLine in class LineMapper<PreferredTerm>

Parameters:

preferredTerm - 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;

getProxy1Guid

protected String getProxy1Guid(PreferredTerm preferredTerm)

Get proxy1 guid. The proxy has omrs type GlossaryTerm

Overrides:

getProxy1Guid in class LineMapper<PreferredTerm>

Parameters:

preferredTerm - line

Returns:

guid for entity proxy 1

getProxy2Guid

protected String getProxy2Guid(PreferredTerm preferredTerm)

Get proxy2 guid The proxy has omrs type GlossaryTerm

Overrides:

getProxy2Guid in class LineMapper<PreferredTerm>

Parameters:

preferredTerm - for this Line

Returns:

guid for entity proxy 2

getTypeName

public String getTypeName()

Description copied from class: LineMapper

get type name

Specified by:

getTypeName in interface Mapper<Relationship,PreferredTerm>

Specified by:

getTypeName in class LineMapper<PreferredTerm>

Returns:

the omrs type name.

getLineInstance

protected PreferredTerm getLineInstance()

setEnd1GuidInLine

protected void setEnd1GuidInLine(PreferredTerm preferredTerm,
                                 String guid)

Description copied from class: LineMapper

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

Specified by:

setEnd1GuidInLine in class LineMapper<PreferredTerm>

Parameters:

preferredTerm - line to update

guid - guid to add into the Line

setEnd2GuidInLine

protected void setEnd2GuidInLine(PreferredTerm preferredTerm,
                                 String guid)

Description copied from class: LineMapper

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

Specified by:

setEnd2GuidInLine in class LineMapper<PreferredTerm>

Parameters:

preferredTerm - line to update

guid - guid to add into the Line