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

Class RelationshipMapping

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.relationships.RelationshipMapping

Direct Known Subclasses:

AssetSchemaTypeMapper, AssetSchemaTypeMapper_DatabaseSchema, AssetSchemaTypeMapper_FileRecord, AttachedTagMapper, AttributeForSchemaMapper, AttributeForSchemaMapper_RecordField, AttributeForSchemaMapper_TableColumn, AttributeForSchemaMapper_TableSchema, CategoryHierarchyLinkMapper, ConnectionConnectorTypeMapper, ConnectionEndpointMapper, ConnectionToAssetMapper, ConnectionToAssetMapper_Database, ConnectionToAssetMapper_FileFolder, ContactThroughMapper, ContactThroughMapper_Person, ContactThroughMapper_Team, DataClassAssignmentMapper, DataClassHierarchyMapper, DataContentForDataSetMapper, FolderHierarchyMapper, ForeignKeyMapper, GovernancePolicyLinkMapper, NestedFileMapper, RelatedTermMapper, ReplacementTermMapper, SchemaAttributeTypeMapper, SchemaAttributeTypeMapper_DatabaseColumn, SchemaAttributeTypeMapper_DatabaseTable, SchemaAttributeTypeMapper_FileField, SemanticAssignmentMapper, SynonymMapper, TermCategorizationMapper, TermHASARelationshipMapper, TermISATypeOFRelationshipMapper, TranslationMapper

public abstract class RelationshipMapping
extends Object

Provides the base class for all relationship mappings, as well as base methods for calculating the transformed relationships.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelationshipMapping.OptimalStart The optimal endpoint from which to retrieve the relationship: - ONE = from ProxyOne - TWO = from ProxyTwo - OPPOSITE = from whichever Proxy does not match the entity for which relationships are being retrieved - CUSTOM = must be custom implemented via a complexRelationshipMappings method
class	RelationshipMapping.ProxyMapping Class to represent each side of a relationship mapping, keeping the details of that side of the mapping together.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SELF_REFERENCE_SENTINEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelationshipMapping(String igcAssetTypeProxyOne, String igcAssetTypeProxyTwo, String igcRelationshipPropertyFromOne, String igcRelationshipPropertyFromTwo, String omrsRelationshipType, String omrsRelationshipProxyOneProperty, String omrsRelationshipProxyTwoProperty)
protected	RelationshipMapping(String igcAssetTypeProxyOne, String igcAssetTypeProxyTwo, String igcRelationshipPropertyFromOne, String igcRelationshipPropertyFromTwo, String omrsRelationshipType, String omrsRelationshipProxyOneProperty, String omrsRelationshipProxyTwoProperty, String igcProxyOneRidPrefix, String igcProxyTwoRidPrefix)

Method Summary

Modifier and Type	Method and Description
void	addAlternativePropertyFromOne(String property) Add an alternative IGC property that can be used to traverse the relationship from proxy one to proxy two.
void	addAlternativePropertyFromTwo(String property) Add an alternative IGC property that can be used to traverse the relationship from proxy two to proxy one.
static Relationship	addIgcRelationship(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, RelationshipMapping relationshipMapping, InstanceProperties initialProperties, Reference proxyOne, Reference proxyTwo, String userId) Adds the provided relationship to IGC (if possible), or throws a RepositoryErrorException if the relationship cannot be created in IGC.
void	addMappedOmrsProperty(String name) Add the provided property name as one supported by this classification mapping.
void	addMappedOMRSRelationships(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, List<Relationship> relationships, Reference fromIgcObject, String userId) Must be implemented to define how to map the relationships defined by the mapper, if there are any complex custom mappings to be done for relationships.
void	addSubType(RelationshipMapping subRelationshipMapping) Adds a subtype to this relationship mapping.
void	addSupportedStatus(InstanceStatus status) Add the provided status as one supported by this relationship mapping.
static EntityProxy	getEntityProxyForObject(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, Reference igcObj, String userId, String ridPrefix) Retrieves an EntityProxy object for the provided IGC object.
List<String>	getIgcRelationshipPropertiesForType(String igcAssetType) Retrieve the IGC relationship properties that define the relationship for the provided IGC asset type.
String	getLinkingAssetType() Retrieve the name of the asset type needed to link together the two endpoints of the relationship (if any), or null.
Set<String>	getMappedOmrsPropertyNames() Retrieve the set of OMRS properties that are supported by the classification mapping.
protected static Relationship	getMappedRelationship(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, RelationshipMapping relationshipMapping, RelationshipDef omrsRelationshipDef, Reference proxyOne, Reference proxyTwo, String igcPropertyName, String userId) Retrieve a Relationship instance based on the provided definition and endpoints.
static Relationship	getMappedRelationship(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, RelationshipMapping relationshipMapping, RelationshipDef omrsRelationshipDef, Reference proxyOne, Reference proxyTwo, String igcPropertyName, String userId, String relationshipLevelRid) Retrieve a Relationship instance based on the provided definition, endpoints, and optional prefixes.
static void	getMappedRelationships(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, List<Relationship> relationships, List<RelationshipMapping> mappings, String relationshipTypeGUID, Reference fromIgcObject, String userId) Utility function that actually does the Relationship object setup and addition to 'relationships' member.
String	getOmrsRelationshipType() Retrieve the type of OMRS relationship this mapping handles.
RelationshipMapping.OptimalStart	getOptimalStart() Get the optimal starting point for traversing this relationship.
RelationshipMapping.ProxyMapping	getOtherProxyFromType(String igcAssetType) Retrieve the proxy details for the other side of the relationship from the IGC asset type provided.
RelationshipMapping.ProxyMapping	getProxyFromType(String igcAssetType) Retrieve the proxy details for the side of the relationship given by the asset type provided.
List<Reference>	getProxyOneAssetFromAsset(Reference relationshipAsset, IGCRestClient igcRestClient) By default, return the asset itself.
static String	getProxyOneGUIDFromRelationshipGUID(String relationshipGUID) Retrieve the portion of the provided relationship GUID that represents the GUID for proxy one of the relationship.
RelationshipMapping.ProxyMapping	getProxyOneMapping() Retrieves the mapping details for endpoint 1 (proxy 1) of the OMRS relationship.
List<Reference>	getProxyTwoAssetFromAsset(Reference relationshipAsset, IGCRestClient igcRestClient) By default, return the asset itself.
static String	getProxyTwoGUIDFromRelationshipGUID(String relationshipGUID) Retrieve the portion of the provided relationship GUID that represents the GUID for proxy two of the relationship.
RelationshipMapping.ProxyMapping	getProxyTwoMapping() Retrieves the mapping detals for endpoint 2 (proxy 2) of the OMRS relationship.
static String	getRelationshipGUID(RelationshipMapping relationshipMapping, Reference endOne, Reference endTwo, String igcPropertyName, String relationshipLevelRid) Generates a unique relationship GUID based on the provided parameters.
String	getRelationshipLevelIgcAsset() Retrieve the name of the IGC asset type that represents the relationship itself.
static String	getRelationshipTypeFromRelationshipGUID(String relationshipGUID) Retrieve the portion of the provided relationship GUID that represents the OMRS relationship type.
List<RelationshipMapping>	getSubTypes() Retrieve the listing of sub-relationship mappings of this mapping.
List<InstanceStatus>	getSupportedStatuses() Retrieve the list of statuses that are supported by the relationship mapping.
boolean	hasLinkingAsset() Indicates whether this mapping needs an IGC asset linking the endpoints (true) or not (false).
boolean	hasRelationshipLevelAsset() Indicates whether this mapping has an IGC asset that represents the relationship directly (true) or not (false).
boolean	hasSubTypes() Indicates whether this relationship mapping has subtypes (true) or not (false).
boolean	isSelfReferencing() Indicates whether the relationship references the same IGC object (true) or not (false).
boolean	samePropertiesOnBothEnds() Indicates whether the same relationship properties are used on both ends of the relationship (true) or not (false).
boolean	sameTypeOnBothEnds() Indicates whether the same asset / entity type is used on both ends of the relationship (true) or not (false).
void	setLinkingAssetType(String igcAssetType) Define an IGC asset type as linking together the two endpoints of the relationship translated by this mapping.
void	setOptimalStart(RelationshipMapping.OptimalStart optimalStart) Set the optimal starting point for traversing this relationship.
void	setRelationshipLevelIgcAsset(String igcAssetType) Sets a relationship-level IGC asset type (these very rarely exist, only known example is 'classification').
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SELF_REFERENCE_SENTINEL

public static final String SELF_REFERENCE_SENTINEL

See Also:

Constant Field Values

Constructor Detail

RelationshipMapping

protected RelationshipMapping(String igcAssetTypeProxyOne,
                              String igcAssetTypeProxyTwo,
                              String igcRelationshipPropertyFromOne,
                              String igcRelationshipPropertyFromTwo,
                              String omrsRelationshipType,
                              String omrsRelationshipProxyOneProperty,
                              String omrsRelationshipProxyTwoProperty)

RelationshipMapping

protected RelationshipMapping(String igcAssetTypeProxyOne,
                              String igcAssetTypeProxyTwo,
                              String igcRelationshipPropertyFromOne,
                              String igcRelationshipPropertyFromTwo,
                              String omrsRelationshipType,
                              String omrsRelationshipProxyOneProperty,
                              String omrsRelationshipProxyTwoProperty,
                              String igcProxyOneRidPrefix,
                              String igcProxyTwoRidPrefix)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

addSupportedStatus

public void addSupportedStatus(InstanceStatus status)

Add the provided status as one supported by this relationship 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 relationship mapping.

Returns:

List<InstanceStatus>

addMappedOmrsProperty

public void addMappedOmrsProperty(String name)

Add the provided property name as one supported by this classification mapping.

Parameters:

name - the name of the OMRS property supported by the mapping

getMappedOmrsPropertyNames

public Set<String> getMappedOmrsPropertyNames()

Retrieve the set of OMRS properties that are supported by the classification mapping.

Returns:

Set<String>

setRelationshipLevelIgcAsset

public void setRelationshipLevelIgcAsset(String igcAssetType)

Sets a relationship-level IGC asset type (these very rarely exist, only known example is 'classification').

Parameters:

igcAssetType - the name of the IGC asset that represents this relationship in IGC

hasRelationshipLevelAsset

public boolean hasRelationshipLevelAsset()

Indicates whether this mapping has an IGC asset that represents the relationship directly (true) or not (false).

Returns:

boolean

getRelationshipLevelIgcAsset

public String getRelationshipLevelIgcAsset()

Retrieve the name of the IGC asset type that represents the relationship itself.

Returns:

String

setLinkingAssetType

public void setLinkingAssetType(String igcAssetType)

Define an IGC asset type as linking together the two endpoints of the relationship translated by this mapping.

Parameters:

igcAssetType - the IGC asset type that links together the two endpoints of the relationship

hasLinkingAsset

public boolean hasLinkingAsset()

Indicates whether this mapping needs an IGC asset linking the endpoints (true) or not (false).

Returns:

boolean

getLinkingAssetType

public String getLinkingAssetType()

Retrieve the name of the asset type needed to link together the two endpoints of the relationship (if any), or null.

Returns:

String

getProxyOneAssetFromAsset

public List<Reference> getProxyOneAssetFromAsset(Reference relationshipAsset,
                                                 IGCRestClient igcRestClient)

By default, return the asset itself. Override this method if the relationship mapping has a relationship-level asset, or other complexity (multi-hops) to translate from a provided asset to the actual asset for the first endpoint of the relationship in IGC.

Parameters:

relationshipAsset - the asset to use to lookup the actual first endpoint in IGC

igcRestClient - REST API connectivity

Returns:

Reference - the asset to be used for endpoint one of the relationship

getProxyTwoAssetFromAsset

public List<Reference> getProxyTwoAssetFromAsset(Reference relationshipAsset,
                                                 IGCRestClient igcRestClient)

By default, return the asset itself. Override this method if the relationship mapping has a relationship-level asset, or other complexity (multi-hops) to translate from a provided asset to the actual asset for the second endpoint of the relationship in IGC.

Parameters:

relationshipAsset - the asset to use to lookup the actual second endpoint in IGC

igcRestClient - REST API connectivity

Returns:

Reference - the asset to be used for endpoint two of the relationship

hasSubTypes

public boolean hasSubTypes()

Indicates whether this relationship mapping has subtypes (true) or not (false). Subtypes can be used where the same relationship may represent relationships between a number of different IGC objects and each needs to be distinguished to appropriately apply a mapping.

Returns:

boolean

addSubType

public void addSubType(RelationshipMapping subRelationshipMapping)

Adds a subtype to this relationship mapping. Subtypes can be used where the same relationship may represent relationships between a number of different IGC objects and each needs to be distinguished to appropriately apply a mapping.

Parameters:

subRelationshipMapping - the relationship mapping that defines a subtype of this mapping

getSubTypes

public List<RelationshipMapping> getSubTypes()

Retrieve the listing of sub-relationship mappings of this mapping. Subtypes can be used where the same relationship may represent relationships between a number of different IGC objects and each needs to be distinguished to appropriately apply a mapping.

Returns:

List<RelationshipMapping>

addMappedOMRSRelationships

public void addMappedOMRSRelationships(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                       List<Relationship> relationships,
                                       Reference fromIgcObject,
                                       String userId)

Must be implemented to define how to map the relationships defined by the mapper, if there are any complex custom mappings to be done for relationships. (Simple mappings are handled automatically by the class.)

Parameters:

igcomrsRepositoryConnector -

relationships -

fromIgcObject -

userId -

getOmrsRelationshipType

public String getOmrsRelationshipType()

Retrieve the type of OMRS relationship this mapping handles.

Returns:

String

setOptimalStart

public void setOptimalStart(RelationshipMapping.OptimalStart optimalStart)

Set the optimal starting point for traversing this relationship.

Parameters:

optimalStart -

getOptimalStart

public RelationshipMapping.OptimalStart getOptimalStart()

Get the optimal starting point for traversing this relationship.

Returns:

OptimalStart

addAlternativePropertyFromOne

public void addAlternativePropertyFromOne(String property)

Add an alternative IGC property that can be used to traverse the relationship from proxy one to proxy two.

Parameters:

property - the name of the additional IGC relationship property

addAlternativePropertyFromTwo

public void addAlternativePropertyFromTwo(String property)

Add an alternative IGC property that can be used to traverse the relationship from proxy two to proxy one.

Parameters:

property - the name of the additional IGC relationship property

isSelfReferencing

public boolean isSelfReferencing()

Indicates whether the relationship references the same IGC object (true) or not (false). This is useful for determining if the relationship is actually to a type that will be generated for OMRS, but does not exist as a distinct instance within IGC.

Returns:

boolean

getProxyOneMapping

public RelationshipMapping.ProxyMapping getProxyOneMapping()

Retrieves the mapping details for endpoint 1 (proxy 1) of the OMRS relationship.

Returns:

ProxyMapping

getProxyTwoMapping

public RelationshipMapping.ProxyMapping getProxyTwoMapping()

Retrieves the mapping detals for endpoint 2 (proxy 2) of the OMRS relationship.

Returns:

ProxyMapping

sameTypeOnBothEnds

public boolean sameTypeOnBothEnds()

Indicates whether the same asset / entity type is used on both ends of the relationship (true) or not (false).

Returns:

boolean

samePropertiesOnBothEnds

public boolean samePropertiesOnBothEnds()

Indicates whether the same relationship properties are used on both ends of the relationship (true) or not (false).

Returns:

boolean

getProxyFromType

public RelationshipMapping.ProxyMapping getProxyFromType(String igcAssetType)

Retrieve the proxy details for the side of the relationship given by the asset type provided.

Parameters:

igcAssetType - the IGC asset type for which to find the same side of the relationship

Returns:

ProxyMapping

getOtherProxyFromType

public RelationshipMapping.ProxyMapping getOtherProxyFromType(String igcAssetType)

Retrieve the proxy details for the other side of the relationship from the IGC asset type provided.

Parameters:

igcAssetType - the IGC asset type for which to find the other side of the relationship

Returns:

ProxyMapping

getIgcRelationshipPropertiesForType

public List<String> getIgcRelationshipPropertiesForType(String igcAssetType)

Retrieve the IGC relationship properties that define the relationship for the provided IGC asset type.

Parameters:

igcAssetType - the IGC asset type for which to retrieve the relationship properties

Returns:

List<String>

getRelationshipGUID

public static String getRelationshipGUID(RelationshipMapping relationshipMapping,
                                         Reference endOne,
                                         Reference endTwo,
                                         String igcPropertyName,
                                         String relationshipLevelRid)

Generates a unique relationship GUID based on the provided parameters. The method will check the provided candidate endpoints against the mapping provided to ensure that they are appropriately matched to endpoint 1 and endpoint 2 of the OMRS relationship. (Therefore endOne and endTwo may not actually be proxyOne and proxyTwo of the OMRS relationship, but could be reversed.)

The intention of the method is to guarantee a unique, consistent GUID irrespective of the direction in which the relationship was traversed. For example: an IGC 'parent_category' relationship from B to A for a CategoryHierarchyLink should result in the same GUID as an IGC 'subcategories' relationship from A to B.

Parameters:

relationshipMapping - the relationship mapping defining how an IGC relationship maps to an OMRS relationship

endOne - the candidate to consider for endpoint 1 of the relationship

endTwo - the candidate to consider for endpoint 2 of the relationship

igcPropertyName - the name of the IGC property for which the relationship is being generated

relationshipLevelRid - the relationship-level RID (if any) within IGC (these are very rare)

Returns:

String - the unique GUID for the relationship

getProxyOneGUIDFromRelationshipGUID

public static String getProxyOneGUIDFromRelationshipGUID(String relationshipGUID)

Retrieve the portion of the provided relationship GUID that represents the GUID for proxy one of the relationship.

Parameters:

relationshipGUID - the relationship GUID

Returns:

String - giving just the GUID for proxy one of the relationship

getProxyTwoGUIDFromRelationshipGUID

public static String getProxyTwoGUIDFromRelationshipGUID(String relationshipGUID)

Retrieve the portion of the provided relationship GUID that represents the GUID for proxy two of the relationship.

Parameters:

relationshipGUID - the relationship GUID

Returns:

String - giving just the GUID for proxy two of the relationship

getRelationshipTypeFromRelationshipGUID

public static String getRelationshipTypeFromRelationshipGUID(String relationshipGUID)

Retrieve the portion of the provided relationship GUID that represents the OMRS relationship type.

Parameters:

relationshipGUID - the relationship GUID

Returns:

String - giving just the name of the OMRS relationship type

getEntityProxyForObject

public static EntityProxy getEntityProxyForObject(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                                  Reference igcObj,
                                                  String userId,
                                                  String ridPrefix)

Retrieves an EntityProxy object for the provided IGC object.

Parameters:

igcomrsRepositoryConnector - OMRS connector to the IBM IGC repository

igcObj - the IGC object for which to retrieve an EntityProxy

userId - the user through which to retrieve the EntityProxy (unused)

ridPrefix - any prefix required on the object's ID to make it unique

Returns:

EntityProxy

getMappedRelationships

public static void getMappedRelationships(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                          List<Relationship> relationships,
                                          List<RelationshipMapping> mappings,
                                          String relationshipTypeGUID,
                                          Reference fromIgcObject,
                                          String userId)

Utility function that actually does the Relationship object setup and addition to 'relationships' member.

Parameters:

igcomrsRepositoryConnector - connectivity to an IGC environment

relationships - the list of relationships to append to

mappings - the mappings to use for retrieving the relationships

relationshipTypeGUID - String GUID of the the type of relationship required (null for all).

fromIgcObject - the IGC object that is the source of the relationships

userId -

getMappedRelationship

protected static Relationship getMappedRelationship(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                                    RelationshipMapping relationshipMapping,
                                                    RelationshipDef omrsRelationshipDef,
                                                    Reference proxyOne,
                                                    Reference proxyTwo,
                                                    String igcPropertyName,
                                                    String userId)
                                             throws RepositoryErrorException

Retrieve a Relationship instance based on the provided definition and endpoints.

Parameters:

igcomrsRepositoryConnector - connectivity to the IGC repository

relationshipMapping - the definition of how to map the relationship

omrsRelationshipDef - the OMRS relationship definition

proxyOne - the IGC asset to use for endpoint 1 of the relationship

proxyTwo - the IGC asset to use for endpoint 2 of the relationship

igcPropertyName - the name of the IGC relationship property

userId -

Returns:

Relationship

Throws:

RepositoryErrorException

getMappedRelationship

public static Relationship getMappedRelationship(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                                 RelationshipMapping relationshipMapping,
                                                 RelationshipDef omrsRelationshipDef,
                                                 Reference proxyOne,
                                                 Reference proxyTwo,
                                                 String igcPropertyName,
                                                 String userId,
                                                 String relationshipLevelRid)
                                          throws RepositoryErrorException

Retrieve a Relationship instance based on the provided definition, endpoints, and optional prefixes.

Parameters:

igcomrsRepositoryConnector - connectivity to the IGC repository

relationshipMapping - the definition of how to map the relationship

omrsRelationshipDef - the OMRS relationship definition

proxyOne - the IGC asset to consider for endpoint 1 of the relationship

proxyTwo - the IGC asset to consider for endpoint 2 of the relationship

igcPropertyName - the name of the IGC relationship property

userId -

relationshipLevelRid - the IGC RID for the relationship itself (in rare instances where it exists)

Returns:

Relationship

Throws:

RepositoryErrorException

addIgcRelationship

public static Relationship addIgcRelationship(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                              RelationshipMapping relationshipMapping,
                                              InstanceProperties initialProperties,
                                              Reference proxyOne,
                                              Reference proxyTwo,
                                              String userId)
                                       throws RepositoryErrorException

Adds the provided relationship to IGC (if possible), or throws a RepositoryErrorException if the relationship cannot be created in IGC.

Parameters:

igcomrsRepositoryConnector - connectivity via an IGC OMRS Repository Connector

relationshipMapping - relationship mapping definition

initialProperties - the properties to set on the relationship

proxyOne - IGC object representing the first proxy of the relationship

proxyTwo - IGC object representing the second proxy of the relationship

userId - userId through which to create the relationship

Returns:

Relationship the created OMRS relationship

Throws:

RepositoryErrorException