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

Class RelatedTermMapper

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.mappers.relationships.RelationshipMapper<RelatedTerm>

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

All Implemented Interfaces:

IRelationshipMapper<RelatedTerm>, Mapper<Relationship,RelatedTerm>

public class RelatedTermMapper
extends RelationshipMapper<RelatedTerm>

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	RELATED_TERM

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

omrsapiHelper, repositoryHelper

Constructor Summary

Constructors

Constructor and Description
RelatedTermMapper(OMRSAPIHelper omrsapiHelper)

Method Summary

Modifier and Type	Method and Description
protected RelatedTerm	getRelationshipInstance()
String	getTypeName() get type name
protected boolean	mapEnumToRelationship(RelatedTerm relatedTerm, String propertyName, EnumPropertyValue enumPropertyValue) Map an omrs enum property to a Subject Area relationship property.
protected boolean	mapPrimitiveToRelationship(RelatedTerm relatedTerm, String propertyName, Object value) Map a primitive omrs property to the relatedTerm object.
protected void	mapRelationshipToInstanceProperties(RelatedTerm relatedTerm, InstanceProperties instanceProperties) Map the supplied relationship to omrs InstanceProperties.

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

getTypeDefGuid, map, map, mapInstancePropertiesToRelationship, mapMapToRelationship

Methods inherited from class java.lang.Object

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

Field Detail

RELATED_TERM

public static final String RELATED_TERM

See Also:

Constant Field Values

Constructor Detail

RelatedTermMapper

public RelatedTermMapper(OMRSAPIHelper omrsapiHelper)

Method Detail

mapRelationshipToInstanceProperties

protected void mapRelationshipToInstanceProperties(RelatedTerm relatedTerm,
                                                   InstanceProperties instanceProperties)

Map the supplied relationship to omrs InstanceProperties.

Overrides:

mapRelationshipToInstanceProperties in class RelationshipMapper<RelatedTerm>

Parameters:

relatedTerm - supplied relationship

instanceProperties - equivalent instance properties to the relationship

mapPrimitiveToRelationship

protected boolean mapPrimitiveToRelationship(RelatedTerm relatedTerm,
                                             String propertyName,
                                             Object value)

Map a primitive omrs property to the relatedTerm object.

Overrides:

mapPrimitiveToRelationship in class RelationshipMapper<RelatedTerm>

Parameters:

relatedTerm - the omas relationship 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 relationship, otherwise false

mapEnumToRelationship

protected boolean mapEnumToRelationship(RelatedTerm relatedTerm,
                                        String propertyName,
                                        EnumPropertyValue enumPropertyValue)

Description copied from class: RelationshipMapper

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

Overrides:

mapEnumToRelationship in class RelationshipMapper<RelatedTerm>

Parameters:

relatedTerm - the relationship 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;

getTypeName

public String getTypeName()

Description copied from class: RelationshipMapper

get type name

Specified by:

getTypeName in interface Mapper<Relationship,RelatedTerm>

Specified by:

getTypeName in class RelationshipMapper<RelatedTerm>

Returns:

the omrs type name.

getRelationshipInstance

protected RelatedTerm getRelationshipInstance()