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

Class GlossaryMapper

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.mappers.entities.EntityDetailMapper<Glossary>

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

All Implemented Interfaces:

INodeMapper<Glossary>, Mapper<EntityDetail,Glossary>

public class GlossaryMapper
extends EntityDetailMapper<Glossary>

Mapping methods to map between Glossary (or a subtype of Glossary) and EntityDetail. These mapping methods map classifications and attributes that directly map to OMRS.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GLOSSARY
static String	OMRS_CANONICAL_VOCABULARY_NAME
static String	OMRS_TAXONOMY_NAME

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.mappers.entities.EntityDetailMapper

omrsapiHelper, repositoryHelper

Constructor Summary

Constructors

Constructor and Description
GlossaryMapper(OMRSAPIHelper omrsapiHelper)

Method Summary

Modifier and Type	Method and Description
protected List<Classification>	getInlinedClassifications(Glossary node) A Classification either exists in the classifications associated with a node or as an inlined attribute (these are properties / attributes of a node that correspond to OMRS Classifications).
String	getTypeName() Get the type name
Glossary	map(EntityDetail entityDetail) Map EntityDetail to Glossary or a sub type of Glossary
EntityDetail	map(Glossary node) Map from a Subject Area OMAS Node to an OMRS EntityDetail
protected void	mapNodeToInstanceProperties(Glossary node, InstanceProperties instanceProperties) Map the supplied Node to omrs InstanceProperties.
protected boolean	mapPrimitiveToNode(Glossary glossary, String propertyName, Object value) Map a primitive omrs property to the glossary object.
protected boolean	updateNodeWithClassification(Glossary glossary, Classification omasClassification) Update Node with classification This method should be overridden by types of node if they want to use the Classification as an in lined property

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.mappers.entities.EntityDetailMapper

getTypeDefGuid, mapEntityDetailToNode, mapEnumToNode, populateAdditionalProperties, toEntityDetail

Methods inherited from class java.lang.Object

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

Field Detail

GLOSSARY

public static final String GLOSSARY

See Also:

Constant Field Values

OMRS_TAXONOMY_NAME

public static final String OMRS_TAXONOMY_NAME

See Also:

Constant Field Values

OMRS_CANONICAL_VOCABULARY_NAME

public static final String OMRS_CANONICAL_VOCABULARY_NAME

See Also:

Constant Field Values

Constructor Detail

GlossaryMapper

public GlossaryMapper(OMRSAPIHelper omrsapiHelper)

Method Detail

map

public Glossary map(EntityDetail entityDetail)

Map EntityDetail to Glossary or a sub type of Glossary

Parameters:

entityDetail - the supplied EntityDetail

Returns:

Glossary the equivalent Glossary to the supplied entityDetail.

map

public EntityDetail map(Glossary node)

Description copied from interface: INodeMapper

Map from a Subject Area OMAS Node to an OMRS EntityDetail

Parameters:

node - a Subject Area OMAS Node

Returns:

an OMRS EntityDetail

getInlinedClassifications

protected List<Classification> getInlinedClassifications(Glossary node)

Description copied from class: EntityDetailMapper

A Classification either exists in the classifications associated with a node or as an inlined attribute (these are properties / attributes of a node that correspond to OMRS Classifications). This method should be overridden by a child class if it has inlined attributes that correspond to an OMRS classifications.

Parameters:

node - supplied node

Returns:

inlined classifications.

mapPrimitiveToNode

protected boolean mapPrimitiveToNode(Glossary glossary,
                                     String propertyName,
                                     Object value)

Map a primitive omrs property to the glossary object.

Overrides:

mapPrimitiveToNode in class EntityDetailMapper<Glossary>

Parameters:

glossary - 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 Node, otherwise false

mapNodeToInstanceProperties

protected void mapNodeToInstanceProperties(Glossary node,
                                           InstanceProperties instanceProperties)

Map the supplied Node to omrs InstanceProperties.

Overrides:

mapNodeToInstanceProperties in class EntityDetailMapper<Glossary>

Parameters:

node - supplied node

instanceProperties - equivalent instance properties to the Node

updateNodeWithClassification

protected boolean updateNodeWithClassification(Glossary glossary,
                                               Classification omasClassification)

Description copied from class: EntityDetailMapper

Update Node with classification This method should be overridden by types of node if they want to use the Classification as an in lined property

Parameters:

glossary - node to update

omasClassification - classification

Returns:

flag true if the classification has been dealt with

getTypeName

public String getTypeName()

Description copied from interface: Mapper

Get the type name

Specified by:

getTypeName in interface Mapper<EntityDetail,Glossary>

Specified by:

getTypeName in class EntityDetailMapper<Glossary>

Returns:

type name