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

Class ClassificationMapping

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.classifications.ClassificationMapping

Direct Known Subclasses:

ConfidentialityMapper, PrimaryKeyMapper, SpineObjectMapper, SubjectAreaMapper

public abstract class ClassificationMapping
extends Object

The base class for all mappings between OMRS Classification TypeDefs and IGC assets.

Constructor Summary

Constructors

Constructor and Description
ClassificationMapping(String igcAssetType, String igcRelationshipProperty, String omrsClassificationType)

Method Summary

Modifier and Type	Method and Description
abstract EntityDetail	addClassificationToIGCAsset(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, Reference igcAsset, String entityGUID, InstanceProperties initialProperties, String userId) Implement this method to define how to add an OMRS classification to an existing IGC asset.
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.
void	addIgcRelationshipProperty(String property) Add the provided property as one of the IGC properties needed to setup this classification.
abstract void	addMappedOMRSClassifications(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, List<Classification> classifications, Reference fromIgcObject, String userId) Implement this method to actually define the logic for the classification.
void	addMappedOmrsProperty(String name) Add the provided property name as one supported by this classification mapping.
void	addSupportedStatus(InstanceStatus status) Add the provided status as one supported by this classification mapping.
String	getIgcAssetType() Retrieve the IGC asset type to which this classification mapping applies.
List<String>	getIgcRelationshipProperties() Retrieve the list of IGC properties used to apply this classification mapping.
abstract IGCSearchConditionSet	getIGCSearchCriteria(InstanceProperties matchClassificationProperties) Implement this method to define how IGC assets can be searched based on this classification.
protected static Classification	getMappedClassification(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String omrsClassificationType, String omrsEntityType, InstanceProperties classificationProperties, Reference fromIgcObject, String userId) Retrieve a Classification instance based on the provided information.
Set<String>	getMappedOmrsPropertyNames() Retrieve the set of OMRS properties that are supported by the classification mapping.
String	getOmrsClassificationType() Retrieve the name of the OMRS ClassificationDef represented by this mapping.
List<InstanceStatus>	getSupportedStatuses() Retrieve the list of statuses that are supported by the classification mapping.
boolean	matchesAssetType(String igcAssetType) Indicates whether this classification 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

Constructor Detail

ClassificationMapping

public ClassificationMapping(String igcAssetType,
                             String igcRelationshipProperty,
                             String omrsClassificationType)

Method Detail

addSupportedStatus

public void addSupportedStatus(InstanceStatus status)

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

getIgcAssetType

public String getIgcAssetType()

Retrieve the IGC asset type to which this classification mapping applies.

Returns:

String

getIgcRelationshipProperties

public List<String> getIgcRelationshipProperties()

Retrieve the list of IGC properties used to apply this classification mapping.

Returns:

List<String>

getOmrsClassificationType

public String getOmrsClassificationType()

Retrieve the name of the OMRS ClassificationDef represented by this mapping.

Returns:

String

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

addIgcRelationshipProperty

public void addIgcRelationshipProperty(String property)

Add the provided property as one of the IGC properties needed to setup this classification.

Parameters:

property - the IGC asset's property name

addMappedOMRSClassifications

public abstract void addMappedOMRSClassifications(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                                  List<Classification> classifications,
                                                  Reference fromIgcObject,
                                                  String userId)

Implement this method to actually define the logic for the classification. (Since IGC has no actual concept of classification, this is left as a method to-be-implemented depending on how the implementation desires the classification to be represented within IGC.)

Parameters:

igcomrsRepositoryConnector - connectivity to the IGC repository via OMRS connector

classifications - the list of classifications to which new classifications should be added

fromIgcObject - the IGC object from which to determine the classifications

userId - the user requesting the classifications (currently unused)

getIGCSearchCriteria

public abstract IGCSearchConditionSet getIGCSearchCriteria(InstanceProperties matchClassificationProperties)

Implement this method to define how IGC assets can be searched based on this classification. (Since IGC has no actual concept of classification, this is left as a method to-be-implemented depending on how the implementation desires the classification to be represented within IGC.)

Parameters:

matchClassificationProperties - the criteria to use when searching for the classification

Returns:

IGCSearchConditionSet - the IGC search criteria to find entities based on this classification

addClassificationToIGCAsset

public abstract EntityDetail addClassificationToIGCAsset(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                                         Reference igcAsset,
                                                         String entityGUID,
                                                         InstanceProperties initialProperties,
                                                         String userId)
                                                  throws RepositoryErrorException,
                                                         EntityNotKnownException

Implement this method to define how to add an OMRS classification to an existing IGC asset. (Since IGC has no actual concept of classification, this is left as a method to-be-implemented depending on how the implementation desires the classification to be represented within IGC.)

Parameters:

igcomrsRepositoryConnector - connectivity to the IGC repository via OMRS connector

igcAsset - the IGC object to which to add the OMRS classification

entityGUID - the GUID of the OMRS entity (ie. including any prefix)

initialProperties - the set of classification-specific properties to add to the classification

userId - the user requesting the classification to be added (currently unused)

Returns:

EntityDetail the updated entity with the OMRS classification added

Throws:

RepositoryErrorException

EntityNotKnownException

matchesAssetType

public boolean matchesAssetType(String igcAssetType)

Indicates whether this classification 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

getMappedClassification

protected static Classification getMappedClassification(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                                        String omrsClassificationType,
                                                        String omrsEntityType,
                                                        InstanceProperties classificationProperties,
                                                        Reference fromIgcObject,
                                                        String userId)
                                                 throws RepositoryErrorException

Retrieve a Classification instance based on the provided information.

Parameters:

omrsClassificationType - the type name of the OMRS classification

omrsEntityType - the OMRS type of entity the OMRS classification is being linked against

classificationProperties - the properties to setup on the classification

Returns:

Classification

Throws:

RepositoryErrorException