org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.entities

Class EntityMapping

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.entities.EntityMapping

Direct Known Subclasses:

ReferenceableMapper

public abstract class EntityMapping
extends Object

Provides the base class for all entity mappings.

Field Summary

Fields

Modifier and Type	Field and Description
protected Reference	igcEntity
protected Reference	igcEntityAlternative
protected IGCOMRSMetadataCollection	igcomrsMetadataCollection
protected IGCOMRSRepositoryConnector	igcomrsRepositoryConnector
protected ArrayList<Classification>	omrsClassifications
protected EntityDetail	omrsDetail
protected ArrayList<Relationship>	omrsRelationships
protected EntitySummary	omrsSummary
protected String	userId

Constructor Summary

Constructors

Constructor and Description
EntityMapping(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String igcAssetType, String igcAssetTypeDisplayName, String omrsTypeDefName, String userId, String igcRidPrefix)

Method Summary

Modifier and Type	Method and Description
void	addClassificationMapper(ClassificationMapping classificationMapping) Add the provided classification mapping as one that describes classifications for this entity.
void	addComplexIgcProperty(String igcPropertyName) Note the provided IGC property name as requiring more than a simple one-to-one mapping to an OMRS property.
void	addComplexOmrsProperty(String omrsPropertyName) Note the provided OMRS property name as requiring more than a simple one-to-one mapping to an IGC property.
void	addOtherIGCAssetType(String igcAssetTypeName) Add any other IGC asset type needed for this mapping.
void	addRelationshipMapper(RelationshipMapping relationshipMapping) Add the provided relationship mapping as one that describes relationships for this entity.
void	addSimplePropertyMapping(String igcPropertyName, String omrsPropertyName) Add a simple one-to-one property mapping between an IGC property and an OMRS property.
void	addSupportedStatus(InstanceStatus status) Add the provided status as one supported by this entity mapping.
protected abstract void	complexPropertyMappings(InstanceProperties instanceProperties) This method needs to be implemented to define any complex property mapping logic, if any.
Reference	getBaseIgcAssetFromAlternative(Reference otherAsset) Retrieve the base IGC asset expected for the mapper from one of its alternative assets.
List<ClassificationMapping>	getClassificationMappers() Retrieve the classification mappings for this entity.
String	getIgcAssetType() Retrieve the primary IGC asset type used by this mapping.
String	getIgcAssetTypeDisplayName() Retrieve the display name of the primary IGC asset type used by this mapping.
Class	getIgcPOJO() Retrieve the POJO used to translate the IGC REST API's JSON representation into a Java object.
String	getIgcRidPrefix() Retrieves the IGC Repository ID (RID) prefix required by this entity, if any (or null if none is needed).
String	getOmrsTypeDefName() Retrieves the name of the OMRS TypeDef that this mapping translates IGC objects into.
List<String>	getOtherIGCAssetTypes() Retrieve listing of any additional IGC asset types needed by this mapping.
List<Class>	getOtherIGCPOJOs() Retrieve listing of any additional IGC POJOs needed by this mapping.
PropertyMappingSet	getPropertyMappings() Retrieve the set of property mappings that are defined by this Mapper.
List<RelationshipMapping>	getRelationshipMappers() Retrieve the relationship mappings for this entity.
List<InstanceStatus>	getSupportedStatuses() Retrieve the list of statuses that are supported by the entity mapping.
boolean	igcRidNeedsPrefix() Indicates whether the IGC Repository ID (RID) requires a prefix (true) or not (false).
protected void	mapIGCToOMRSEntityDetail() Utility function to initalize an EntityDetail object based on the initialized IGC entity.
protected void	mapIGCToOMRSEntitySummary() Utility function to initialize an EntitySummary object based on the initialized IGC entity.
boolean	matchesAssetType(String igcAssetType) Indicates whether this entity mapping matches the provided IGC asset type: that is, this mapping can be used to translate to the provided IGC asset type.

Methods inherited from class java.lang.Object

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

Field Detail

igcomrsRepositoryConnector

protected IGCOMRSRepositoryConnector igcomrsRepositoryConnector

igcomrsMetadataCollection

protected IGCOMRSMetadataCollection igcomrsMetadataCollection

userId

protected String userId

igcEntity

protected Reference igcEntity

igcEntityAlternative

protected Reference igcEntityAlternative

omrsSummary

protected EntitySummary omrsSummary

omrsDetail

protected EntityDetail omrsDetail

omrsClassifications

protected ArrayList<Classification> omrsClassifications

omrsRelationships

protected ArrayList<Relationship> omrsRelationships

Constructor Detail

EntityMapping

public EntityMapping(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                     String igcAssetType,
                     String igcAssetTypeDisplayName,
                     String omrsTypeDefName,
                     String userId,
                     String igcRidPrefix)

Method Detail

addSupportedStatus

public void addSupportedStatus(InstanceStatus status)

Add the provided status as one supported by this entity mapping.

Parameters:

status - a status that is supported by the mapping

getSupportedStatuses

public List<InstanceStatus> getSupportedStatuses()

Retrieve the list of statuses that are supported by the entity mapping.

Returns:

List<InstanceStatus>

getIgcAssetType

public String getIgcAssetType()

Retrieve the primary IGC asset type used by this mapping.

Returns:

String

getIgcAssetTypeDisplayName

public String getIgcAssetTypeDisplayName()

Retrieve the display name of the primary IGC asset type used by this mapping. (The display name is also the name used by the InfosphereEvents topic of the event mapper.)

Returns:

String

getIgcPOJO

public Class getIgcPOJO()

Retrieve the POJO used to translate the IGC REST API's JSON representation into a Java object.

Returns:

Class

igcRidNeedsPrefix

public boolean igcRidNeedsPrefix()

Indicates whether the IGC Repository ID (RID) requires a prefix (true) or not (false). A prefix is typically required when the entity represented by the RID does not actually exist as a distinct entity in IGC, but is rather a subset of properties, relationships and classifications from another IGC asset type. (The prefix allows us to effectively split such a singular IGC object into multiple OMRS entities.)

Returns:

boolean

See Also:

getIgcRidPrefix()

getIgcRidPrefix

public String getIgcRidPrefix()

Retrieves the IGC Repository ID (RID) prefix required by this entity, if any (or null if none is needed).

Returns:

String

See Also:

igcRidNeedsPrefix()

getOmrsTypeDefName

public String getOmrsTypeDefName()

Retrieves the name of the OMRS TypeDef that this mapping translates IGC objects into.

Returns:

String

matchesAssetType

public boolean matchesAssetType(String igcAssetType)

Indicates whether this entity mapping matches the provided IGC asset type: that is, this mapping can be used to translate to the provided IGC asset type.

Parameters:

igcAssetType - the IGC asset type to check the mapping against

Returns:

boolean

addOtherIGCAssetType

public void addOtherIGCAssetType(String igcAssetTypeName)

Add any other IGC asset type needed for this mapping.

Parameters:

igcAssetTypeName - name of additional IGC asset

getOtherIGCAssetTypes

public List<String> getOtherIGCAssetTypes()

Retrieve listing of any additional IGC asset types needed by this mapping.

Returns:

List<String>

getOtherIGCPOJOs

public List<Class> getOtherIGCPOJOs()

Retrieve listing of any additional IGC POJOs needed by this mapping.

Returns:

List<Class>

getBaseIgcAssetFromAlternative

public Reference getBaseIgcAssetFromAlternative(Reference otherAsset)

Retrieve the base IGC asset expected for the mapper from one of its alternative assets. By default, and in the vast majority of cases, there are no alternatives so will simply return the asset as-is. Override this method in any mappers where alternative assets are defined.

Parameters:

otherAsset - the alternative asset to translate into a base asset

Returns:

Reference - the base asset

addSimplePropertyMapping

public final void addSimplePropertyMapping(String igcPropertyName,
                                           String omrsPropertyName)

Add a simple one-to-one property mapping between an IGC property and an OMRS property.

Parameters:

igcPropertyName - the IGC property name to be mapped

omrsPropertyName - the OMRS property name to be mapped

addComplexIgcProperty

public final void addComplexIgcProperty(String igcPropertyName)

Note the provided IGC property name as requiring more than a simple one-to-one mapping to an OMRS property.

Parameters:

igcPropertyName - the IGC property name

addComplexOmrsProperty

public final void addComplexOmrsProperty(String omrsPropertyName)

Note the provided OMRS property name as requiring more than a simple one-to-one mapping to an IGC property.

Parameters:

omrsPropertyName - the OMRS property name

getPropertyMappings

public PropertyMappingSet getPropertyMappings()

Retrieve the set of property mappings that are defined by this Mapper.

Returns:

PropertyMappingSet

addRelationshipMapper

public final void addRelationshipMapper(RelationshipMapping relationshipMapping)

Add the provided relationship mapping as one that describes relationships for this entity.

Parameters:

relationshipMapping -

getRelationshipMappers

public List<RelationshipMapping> getRelationshipMappers()

Retrieve the relationship mappings for this entity.

Returns:

List<RelationshipMapping>

addClassificationMapper

public final void addClassificationMapper(ClassificationMapping classificationMapping)

Add the provided classification mapping as one that describes classifications for this entity.

Parameters:

classificationMapping -

getClassificationMappers

public List<ClassificationMapping> getClassificationMappers()

Retrieve the classification mappings for this entity.

Returns:

List<ClassificationMapping>

complexPropertyMappings

protected abstract void complexPropertyMappings(InstanceProperties instanceProperties)

This method needs to be implemented to define any complex property mapping logic, if any.

Parameters:

instanceProperties - the instance properties to which to add the complex-mapped properties

mapIGCToOMRSEntitySummary

protected final void mapIGCToOMRSEntitySummary()

Utility function to initialize an EntitySummary object based on the initialized IGC entity.

mapIGCToOMRSEntityDetail

protected final void mapIGCToOMRSEntityDetail()

Utility function to initalize an EntityDetail object based on the initialized IGC entity.