org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.stores

Class EntityMappingStore

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.stores.EntityMappingStore

public class EntityMappingStore
extends Object

Store of implemented entity mappings for the repository.

Constructor Summary

Constructors

Constructor and Description
EntityMappingStore()

Method Summary

Modifier and Type	Method and Description
boolean	addMapping(TypeDef omrsTypeDef, Class mappingClass, IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String userId) Adds an entity mapping for the provided TypeDef, using the provided EntityMapping Java class and repository details.
List<EntityMapping>	getAllMappings() Retrieves all entity mappings that are implemented for this repository.
EntityMapping	getDefaultEntityMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector, String userId) Retrieves the entity mapping that can be applied by default to any entity.
EntityMapping	getMappingByIgcAssetDisplayName(String assetDisplayName) Retrieves the entity mapping that applies to the provided IGC asset type, by its display name.
EntityMapping	getMappingByIgcAssetTypeAndPrefix(String assetType, String prefix) Retrieves the entity mapping that applies to the provided IGC asset type and prefix (if any).
EntityMapping	getMappingByOmrsTypeGUID(String guid) Retrieves the entity mapping by GUID of the OMRS TypeDef.
EntityMapping	getMappingByOmrsTypeName(String name) Retrieves the entity mapping that applies to the provided OMRS entity type name.
List<EntityMapping>	getMappingsByIgcAssetType(String assetType) Retrieves all entity mappings that could be applied to the provided IGC asset type.
List<TypeDef>	getTypeDefs() Retrieves a listing of all TypeDefs for which entity mappings have been implemented.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityMappingStore

public EntityMappingStore()

Method Detail

getTypeDefs

public List<TypeDef> getTypeDefs()

Retrieves a listing of all TypeDefs for which entity mappings have been implemented.

Returns:

List<TypeDef>

addMapping

public boolean addMapping(TypeDef omrsTypeDef,
                          Class mappingClass,
                          IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                          String userId)

Adds an entity mapping for the provided TypeDef, using the provided EntityMapping Java class and repository details.

Parameters:

omrsTypeDef - the OMRS TypeDef for which the entity mapping is implemented

mappingClass - the Java class providing the EntityMapping

igcomrsRepositoryConnector - connectivity via an IGC OMRS Repository Connector

userId - the userId through which to apply the mapping

Returns:

boolean false if unable to configure an EntityMapping from the provided class

getMappingByOmrsTypeGUID

public EntityMapping getMappingByOmrsTypeGUID(String guid)

Retrieves the entity mapping by GUID of the OMRS TypeDef.

Parameters:

guid - of the OMRS TypeDef

Returns:

EntityMapping

getMappingsByIgcAssetType

public List<EntityMapping> getMappingsByIgcAssetType(String assetType)

Retrieves all entity mappings that could be applied to the provided IGC asset type. There can be multiple mappings in cases where a single IGC asset maps to multiple OMRS entities, and must use a generated prefix for one or more of them (this method will return both the prefix and non-prefix mappings).

Parameters:

assetType - IGC asset type

Returns:

List<EntityMapping>

getMappingByIgcAssetDisplayName

public EntityMapping getMappingByIgcAssetDisplayName(String assetDisplayName)

Retrieves the entity mapping that applies to the provided IGC asset type, by its display name.

Parameters:

assetDisplayName - IGC asset type's display name

Returns:

EntityMapping

getMappingByIgcAssetTypeAndPrefix

public EntityMapping getMappingByIgcAssetTypeAndPrefix(String assetType,
                                                       String prefix)

Retrieves the entity mapping that applies to the provided IGC asset type and prefix (if any).

Parameters:

assetType - IGC asset type

prefix - the prefix for the entity, or null if no prefix

Returns:

EntityMapping

getMappingByOmrsTypeName

public EntityMapping getMappingByOmrsTypeName(String name)

Retrieves the entity mapping that applies to the provided OMRS entity type name.

Parameters:

name - of the OMRS entity type

Returns:

EntityMapping

getAllMappings

public List<EntityMapping> getAllMappings()

Retrieves all entity mappings that are implemented for this repository.

Returns:

List<EntityMapping>

getDefaultEntityMapper

public EntityMapping getDefaultEntityMapper(IGCOMRSRepositoryConnector igcomrsRepositoryConnector,
                                            String userId)

Retrieves the entity mapping that can be applied by default to any entity.

Parameters:

igcomrsRepositoryConnector - connectivity through an IGC OMRS Repository Connector

userId - userId through which to retrieve the mapping

Returns:

EntityMapping