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

Class RelationshipMapping.ProxyMapping

java.lang.Object

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

Enclosing class:

RelationshipMapping

public class RelationshipMapping.ProxyMapping
extends Object

Class to represent each side of a relationship mapping, keeping the details of that side of the mapping together.

Constructor Summary

Constructors

Constructor and Description
ProxyMapping(String igcAssetType, String igcRelationshipProperty, String omrsRelationshipProperty, String igcRidPrefix)

Method Summary

Modifier and Type	Method and Description
void	addAlternativeIgcRelationshipProperty(String igcRelationshipProperty) Add an alternative IGC relationship property to this side of the relationship, that can be additionally used to traverse to the other side of the relationship.
void	addExcludedIgcAssetType(String igcAssetType) When the asset this applies to is a 'main_object', use this method to add any objects that should NOT be included under that umbrella.
String	getIgcAssetType() Retrieve the type of IGC asset that is expected by this side of the relationship mapping.
List<String>	getIgcRelationshipProperties() Retrieve the list of IGC relationship properties that can be used from this side of the relationship mapping to traverse to the other side of the relationship.
String	getIgcRidPrefix() Retrieve the prefix that should be added to the IGC Repository ID (RID) in order to make this side of the relationship point to a generated IGC entity instance (ie.
String	getOmrsRelationshipProperty() Retrieve the name of the OMRS relationship property that represents this side of the relationship.
boolean	isSelfReferencing() Indicates whether this side of the relationship is self-referencing (true) or not (false).
boolean	matchesAssetType(String igcAssetType) Indicates whether this side of the relationship matches the provided IGC asset type: that is, this side of the relationship can be used to relate to the provided IGC asset type.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyMapping

public ProxyMapping(String igcAssetType,
                    String igcRelationshipProperty,
                    String omrsRelationshipProperty,
                    String igcRidPrefix)

Method Detail

getIgcAssetType

public String getIgcAssetType()

Retrieve the type of IGC asset that is expected by this side of the relationship mapping.

Returns:

String

getIgcRelationshipProperties

public List<String> getIgcRelationshipProperties()

Retrieve the list of IGC relationship properties that can be used from this side of the relationship mapping to traverse to the other side of the relationship. (In most cases this will just be a single relationship in the list.)

Returns:

List<String>

addAlternativeIgcRelationshipProperty

public void addAlternativeIgcRelationshipProperty(String igcRelationshipProperty)

Add an alternative IGC relationship property to this side of the relationship, that can be additionally used to traverse to the other side of the relationship.

Parameters:

igcRelationshipProperty - the name of the additional IGC relationship property

getOmrsRelationshipProperty

public String getOmrsRelationshipProperty()

Retrieve the name of the OMRS relationship property that represents this side of the relationship.

Returns:

String

getIgcRidPrefix

public String getIgcRidPrefix()

Retrieve the prefix that should be added to the IGC Repository ID (RID) in order to make this side of the relationship point to a generated IGC entity instance (ie. one that does not exist distinctly within IGC). If no such entity is required, this will be null.

Returns:

String

isSelfReferencing

public boolean isSelfReferencing()

Indicates whether this side of the relationship is self-referencing (true) or not (false). Generally when the relationship is self-referencing, at least one end of the relationship will require a prefix.

Returns:

boolean

addExcludedIgcAssetType

public void addExcludedIgcAssetType(String igcAssetType)

When the asset this applies to is a 'main_object', use this method to add any objects that should NOT be included under that umbrella.

Parameters:

igcAssetType - the IGC asset type to exclude from 'main_object' consideration

matchesAssetType

public boolean matchesAssetType(String igcAssetType)

Indicates whether this side of the relationship matches the provided IGC asset type: that is, this side of the relationship can be used to relate to the provided IGC asset type.

Parameters:

igcAssetType - the IGC asset type to check this side of the relationship against

Returns:

boolean

toString

public String toString()

Overrides:

toString in class Object