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

Class EntityDetailMapper

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.mappers.entities.EntityDetailMapper

Direct Known Subclasses:

CategoryMapper, GlossaryMapper, ProjectMapper, TermMapper

public abstract class EntityDetailMapper
extends Object

This class provides a mapping between OMRS object EntityDetail and Subject Area OMAS object Node. Sub-classes of Node are expected to provide a mapper that extends this class, to provide the mappings for the properties that they support.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EntityDetailMapper(OMRSAPIHelper omrsapiHelper)

Method Summary

Modifier and Type	Method and Description
protected void	mapEntityDetailToNode(Node node, EntityDetail omrsEntityDetail) map the EntityDetail to the Node
protected boolean	mapEnumToNode(Node node, String propertyName, EnumPropertyValue enumPropertyValue) Map an omrs entityDetail enum property to a Subject Area Node property.
protected boolean	mapMapToNode(Node node, String propertyName, InstanceProperties instancePropertyForMap) Map an omrs entityDetail map property to a Subject Area Node property.
EntityDetail	mapNodeToEntityDetail(Node node) Map a Node (a Subject Area OMAS) concept to an EntityDetail (an OMRS concept)
protected void	mapNodeToInstanceProperties(Node node, InstanceProperties instanceProperties) Map the supplied Node to omrs InstanceProperties.
protected boolean	mapPrimitiveToNode(Node node, String propertyName, Object value) Map an omrs entityDetail primitive property to a Subject Area Node property.
protected void	populateAdditionalProperties(Node node, InstanceProperties instanceProperties)

Methods inherited from class java.lang.Object

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

Field Detail

repositoryHelper

protected final OMRSRepositoryHelper repositoryHelper

omrsapiHelper

protected final OMRSAPIHelper omrsapiHelper

Constructor Detail

EntityDetailMapper

public EntityDetailMapper(OMRSAPIHelper omrsapiHelper)

Method Detail

mapEntityDetailToNode

protected void mapEntityDetailToNode(Node node,
                                     EntityDetail omrsEntityDetail)

map the EntityDetail to the Node

Parameters:

node - to be mapped to (the target of the map)

omrsEntityDetail - entitytDetail to be mapped from (the source of the mapping)

mapPrimitiveToNode

protected boolean mapPrimitiveToNode(Node node,
                                     String propertyName,
                                     Object value)

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

Parameters:

node - the node 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;

mapEnumToNode

protected boolean mapEnumToNode(Node node,
                                String propertyName,
                                EnumPropertyValue enumPropertyValue)

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

Parameters:

node - the node 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;

mapMapToNode

protected boolean mapMapToNode(Node node,
                               String propertyName,
                               InstanceProperties instancePropertyForMap)

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

Parameters:

node - the node 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;

mapNodeToEntityDetail

public EntityDetail mapNodeToEntityDetail(Node node)

Map a Node (a Subject Area OMAS) concept to an EntityDetail (an OMRS concept)

Parameters:

node - supplied node, which is a Subject Area Concept

Returns:

EntityDetail, which is an OMRS concept

populateAdditionalProperties

protected void populateAdditionalProperties(Node node,
                                            InstanceProperties instanceProperties)

mapNodeToInstanceProperties

protected void mapNodeToInstanceProperties(Node node,
                                           InstanceProperties instanceProperties)

Map the supplied Node to omrs InstanceProperties. Subclasses are expected to override this method to provide logic to map their Node properties to instanceProperties

Parameters:

node - supplied node

instanceProperties - equivalent instance properties to the Node