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

Class SubjectAreaMapper

java.lang.Object

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

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

public class SubjectAreaMapper
extends ClassificationMapping

Singleton defining the mapping to the OMRS "SubjectArea" classification.

Method Summary

Modifier and Type	Method and Description
EntityDetail	addClassificationToIGCAsset(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, Reference igcEntity, String entityGUID, InstanceProperties initialProperties, String userId) Implement this method to define how to add an OMRS classification to an existing IGC asset.
void	addMappedOMRSClassifications(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, List<Classification> classifications, Reference fromIgcObject, String userId) Implements the SubjectArea classification for IGC 'category' assets.
IGCSearchConditionSet	getIGCSearchCriteria(InstanceProperties matchClassificationProperties) Search for SubjectArea by looking at ancestral categories of the term being under a "Subject Area" category.
static SubjectAreaMapper	getInstance()

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.classifications.ClassificationMapping

addExcludedIgcAssetType, addIgcRelationshipProperty, addMappedOmrsProperty, addSupportedStatus, getIgcAssetType, getIgcRelationshipProperties, getMappedClassification, getMappedOmrsPropertyNames, getOmrsClassificationType, getSupportedStatuses, matchesAssetType

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SubjectAreaMapper getInstance()

addMappedOMRSClassifications

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

Implements the SubjectArea classification for IGC 'category' assets. If a category comes under any higher-level 'Subject Areas' category, such a category should be treated as subject area and therefore will be mapped to a "SubjectArea" classification in OMRS.

Specified by:

addMappedOMRSClassifications in class ClassificationMapping

Parameters:

igcomrsRepositoryConnector -

classifications -

fromIgcObject -

userId -

getIGCSearchCriteria

public IGCSearchConditionSet getIGCSearchCriteria(InstanceProperties matchClassificationProperties)

Search for SubjectArea by looking at ancestral categories of the term being under a "Subject Area" category. (There are no properties on the SpineObject classification, so no need to even check the provided matchClassificationProperties.)

Specified by:

getIGCSearchCriteria in class ClassificationMapping

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 EntityDetail addClassificationToIGCAsset(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                                Reference igcEntity,
                                                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.)

Specified by:

addClassificationToIGCAsset in class ClassificationMapping

Parameters:

igcomrsRepositoryConnector - connectivity to the IGC repository via OMRS connector

igcEntity - 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