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

Class LineMapper

java.lang.Object

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

All Implemented Interfaces:

ILineMapper

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
extends Object
implements ILineMapper

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(Line line) Get proxy 1 guid
protected String	getProxy2Guid(Line line) Get proxy 2 guid
protected String	getRelationshipTypeDefGuid(Relationship relationship) get the relationshipTypeDef Guid This method should be overridden to provide the appropriate guid for the type.
protected boolean	mapEnumToLine(Line line, String propertyName, EnumPropertyValue enumPropertyValue) Map an omrs enum property to a Subject Area Line property.
protected void	mapInstancePropertiesToLine(Line 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(Line line, InstanceProperties instanceProperties) Map the supplied Line to omrs InstanceProperties.
Relationship	mapLineToRelationship(Line line) Map Line to the omrs relationship equivalent
protected boolean	mapMapToLine(Line line, String propertyName, InstanceProperties instancePropertyForMap) Map an omrs map property to a Subject Area Line property.
protected boolean	mapPrimitiveToLine(Line line, String propertyName, Object value) Map an omrs primitive property to a Subject Area Line property.
Line	mapRelationshipToLine(Relationship relationship) Map from an OMRS Relationship to a Subject Area OMAS Line
protected abstract void	setEnd1GuidInLine(Line 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(Line line, String guid) Pass the guid of the EntityProxy for end 2 to the Line ,so it can store it appropriately
protected void	throwWrongTypeException(Relationship relationship, String methodName, String type) relationship is not of the right type.

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

mapRelationshipToLine

public Line mapRelationshipToLine(Relationship relationship)

Description copied from interface: ILineMapper

Map from an OMRS Relationship to a Subject Area OMAS Line

Specified by:

mapRelationshipToLine in interface ILineMapper

Parameters:

relationship - OMRS Lines

Returns:

Subject Area OMAS Line

setEnd1GuidInLine

protected abstract void setEnd1GuidInLine(Line 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(Line 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(Line 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

mapLineToRelationship

public Relationship mapLineToRelationship(Line line)

Map Line to the omrs relationship equivalent

Specified by:

mapLineToRelationship in interface ILineMapper

Parameters:

line - supplied line

Returns:

omrs relationship equivalent

getRelationshipTypeDefGuid

protected String getRelationshipTypeDefGuid(Relationship relationship)

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

Parameters:

relationship - to get the guid from

Returns:

the guid of the relationship typedef

getProxy1Guid

protected String getProxy1Guid(Line line)

Get proxy 1 guid

Parameters:

line - for this Line

Returns:

proxy 1 guid

getProxy2Guid

protected String getProxy2Guid(Line line)

Get proxy 2 guid

Parameters:

line - for this Line

Returns:

proxy 2 guid

mapPrimitiveToLine

protected boolean mapPrimitiveToLine(Line 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(Line 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(Line 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(Line 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

throwWrongTypeException

protected void throwWrongTypeException(Relationship relationship,
                                       String methodName,
                                       String type)
                                throws InvalidParameterException

relationship is not of the right type. Throw an Exception

Parameters:

relationship - relationship of wrong type

methodName - method name for dignostics

type - expected type

Throws:

InvalidParameterException - one of the parameters is null or invalid.