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

Class ReferenceableMapper

java.lang.Object

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

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

Direct Known Subclasses:

ConnectionMapper, ConnectorTypeMapper, ContactDetailsMapper, DatabaseMapper, DataClassMapper, DataFileMapper, DeployedDatabaseSchemaMapper, EndpointMapper, FileFolderMapper, GlossaryCategoryMapper, GlossaryTermMapper, GovernancePolicyMapper, InformalTagMapper, PersonMapper, RelationalColumnMapper, RelationalColumnTypeMapper, RelationalDBSchemaTypeMapper, RelationalTableMapper, RelationalTableTypeMapper, TabularColumnMapper, TabularColumnTypeMapper, TabularSchemaTypeMapper, TeamMapper

public class ReferenceableMapper
extends EntityMapping

Defines the default mapping to an OMRS entity (the OMRS "Referenceable" entity), along with the base methods for all other entity mappings.

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.entities.EntityMapping

igcEntity, igcEntityAlternative, igcomrsMetadataCollection, igcomrsRepositoryConnector, omrsClassifications, omrsDetail, omrsRelationships, omrsSummary, userId

Constructor Summary

Constructors

Constructor and Description
ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String userId)
ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String igcAssetTypeName, String igcAssetTypeDisplayName, String omrsEntityTypeName, String userId)
ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String igcAssetTypeName, String igcAssetTypeDisplayName, String omrsEntityTypeName, String userId, String igcRidPrefix)
ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String igcAssetTypeName, String igcAssetTypeDisplayName, String omrsEntityTypeName, String userId, String igcRidPrefix, boolean includeDefaultRelationships)

Method Summary

Modifier and Type	Method and Description
protected void	complexPropertyMappings(InstanceProperties instanceProperties) This method needs to be implemented to define any complex property mapping logic, if any.
protected ReferenceableMapper	getNewInstance() Retrieves a new instance of this same class, which is needed to ensure there are distinct protected members to populate for each instance of an object that needs to be mapped.
EntityDetail	getOMRSEntityDetail() Map the IGC entity to an OMRS EntityDetail object.
EntitySummary	getOMRSEntitySummary() Map the IGC entity to an OMRS EntitySummary object.
List<Relationship>	getOMRSRelationships(String relationshipTypeGUID, int fromRelationshipElement, SequencingOrder sequencingOrder, int pageSize) Map the IGC entity's relationships to OMRS Relationship objects.
ReferenceableMapper	initialize(Reference baseObject, Reference receivedObject) Initialize the mapper with an IGC object to be mapped.

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.entities.EntityMapping

addClassificationMapper, addComplexIgcProperty, addComplexOmrsProperty, addOtherIGCAssetType, addRelationshipMapper, addSimplePropertyMapping, addSupportedStatus, getBaseIgcAssetFromAlternative, getClassificationMappers, getIgcAssetType, getIgcAssetTypeDisplayName, getIgcPOJO, getIgcRidPrefix, getOmrsTypeDefName, getOtherIGCAssetTypes, getOtherIGCPOJOs, getPropertyMappings, getRelationshipMappers, getSupportedStatuses, igcRidNeedsPrefix, mapIGCToOMRSEntityDetail, mapIGCToOMRSEntitySummary, matchesAssetType

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceableMapper

public ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                           String userId)

ReferenceableMapper

public ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                           String igcAssetTypeName,
                           String igcAssetTypeDisplayName,
                           String omrsEntityTypeName,
                           String userId)

ReferenceableMapper

public ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                           String igcAssetTypeName,
                           String igcAssetTypeDisplayName,
                           String omrsEntityTypeName,
                           String userId,
                           String igcRidPrefix)

ReferenceableMapper

public ReferenceableMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                           String igcAssetTypeName,
                           String igcAssetTypeDisplayName,
                           String omrsEntityTypeName,
                           String userId,
                           String igcRidPrefix,
                           boolean includeDefaultRelationships)

Method Detail

getNewInstance

protected ReferenceableMapper getNewInstance()

Retrieves a new instance of this same class, which is needed to ensure there are distinct protected members to populate for each instance of an object that needs to be mapped.

Returns:

EntityMapping

initialize

public ReferenceableMapper initialize(Reference baseObject,
                                      Reference receivedObject)

Initialize the mapper with an IGC object to be mapped. This method MUST be called before any of the subsequent mapping functions!

Parameters:

baseObject - the IGC object to be mapped into an OMRS entity

receivedObject - the IGC object actually looked up (if different from baseObject, null otherwise)

Returns:

ReferenceableMapper initialised with the provided object

complexPropertyMappings

protected void complexPropertyMappings(InstanceProperties instanceProperties)

Description copied from class: EntityMapping

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

Specified by:

complexPropertyMappings in class EntityMapping

Parameters:

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

getOMRSEntitySummary

public EntitySummary getOMRSEntitySummary()

Map the IGC entity to an OMRS EntitySummary object.

Returns:

EntitySummary

getOMRSEntityDetail

public EntityDetail getOMRSEntityDetail()

Map the IGC entity to an OMRS EntityDetail object.

Returns:

EntityDetail

getOMRSRelationships

public List<Relationship> getOMRSRelationships(String relationshipTypeGUID,
                                               int fromRelationshipElement,
                                               SequencingOrder sequencingOrder,
                                               int pageSize)

Map the IGC entity's relationships to OMRS Relationship objects.

Parameters:

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

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Relationship>