org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector

Interface OMRSRepositoryHelper

public interface OMRSRepositoryHelper

OMRSRepositoryHelper provides methods to repository connectors and repository event mappers to help them build valid type definitions (TypeDefs), entities and relationships. It is a facade to the repository content manager which holds an in memory cache of all the active TypeDefs in the local server. OMRSRepositoryHelper's purpose is to create an object that the repository connectors and event mappers can create, use and discard without needing to know how to connect to the repository content manager.

Method Summary

Modifier and Type	Method and Description
InstanceProperties	addBooleanPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, boolean propertyValue, String methodName) Add the supplied property to an instance properties object.
EntityDetail	addClassificationToEntity(String sourceName, EntityDetail entity, Classification newClassification, String methodName) Add a classification to an existing entity.
InstanceProperties	addEnumPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, int ordinal, String symbolicName, String description, String methodName) Add the supplied property to an instance properties object.
InstanceProperties	addIntPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, int propertyValue, String methodName) Add the supplied property to an instance properties object.
InstanceProperties	addMapPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, Map<String,Object> mapValues, String methodName) Add the supplied property to an instance properties object.
InstanceProperties	addStringPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, String propertyValue, String methodName) Add the supplied property to an instance properties object.
TypeDef	applyPatch(String sourceName, TypeDef originalTypeDef, TypeDefPatch typeDefPatch) Returns an updated TypeDef that has had the supplied patch applied.
EntityDetail	deleteClassificationFromEntity(String sourceName, EntityDetail entity, String oldClassificationName, String methodName) Return a oldClassification with the header and type information filled out.
TypeDefGallery	getActiveTypeDefGallery() Return the list of typedefs active in the local repository.
TypeDefGallery	getActiveTypesByWildCardName(String sourceName, String typeDefName) Return the TypeDefs identified by the name supplied by the caller.
AttributeTypeDef	getAttributeTypeDef(String sourceName, String attributeTypeDefGUID, String methodName) Return the AttributeTypeDef identified by the guid and name supplied by the caller.
AttributeTypeDef	getAttributeTypeDef(String sourceName, String attributeTypeDefGUID, String attributeTypeDefName, String methodName) Return the AttributeTypeDef identified by the guid and name supplied by the caller.
AttributeTypeDef	getAttributeTypeDefByName(String sourceName, String attributeTypeDefName) Return the AttributeTypeDef identified by the name supplied by the caller.
boolean	getBooleanProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or false if property is not found.
Classification	getClassificationFromEntity(String sourceName, EntityDetail entity, String classificationName, String methodName) Return the names classification from an existing entity.
String	getEnd1EntityGUID(Relationship relationship) Return the guid of an entity linked to end 1 of the relationship.
String	getEnd2EntityGUID(Relationship relationship) Return the guid of an entity linked to end 2 of the relationship.
int	getIntProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or 0 if property is not found.
TypeDefGallery	getKnownTypeDefGallery() Return the list of typedefs known by the local repository.
Map<String,Object>	getMapFromProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
InstanceProperties	getMapProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
List<TypeDef>	getMatchingActiveTypes(String sourceName, String standard, String organization, String identifier, String methodName) Validate that the type's name is not null.
Classification	getNewClassification(String sourceName, String userName, String typeName, String entityTypeName, ClassificationOrigin classificationOrigin, String classificationOriginGUID, InstanceProperties properties) Return a classification with the header and type information filled out.
EntityDetail	getNewEntity(String sourceName, String metadataCollectionId, InstanceProvenanceType provenanceType, String userName, String typeName, InstanceProperties properties, List<Classification> classifications) Return a filled out entity.
EntityProxy	getNewEntityProxy(String sourceName, EntityDetail entity) Generate an entity proxy from an entity and its TypeDef.
EntityProxy	getNewEntityProxy(String sourceName, String metadataCollectionId, InstanceProvenanceType provenanceType, String userName, String typeName, InstanceProperties properties, List<Classification> classifications) Return a filled out entity.
InstanceType	getNewInstanceType(String sourceName, TypeDefSummary typeDefSummary) Return a relationship with the header and type information filled out.
Relationship	getNewRelationship(String sourceName, String metadataCollectionId, InstanceProvenanceType provenanceType, String userName, String typeName, InstanceProperties properties) Return a filled out relationship which just needs the entity proxies added.
Classification	getSkeletonClassification(String sourceName, String userName, String classificationTypeName, String entityTypeName) Return a classification with the header and type information filled out.
EntityDetail	getSkeletonEntity(String sourceName, String metadataCollectionId, InstanceProvenanceType provenanceType, String userName, String typeName) Return an entity with the header and type information filled out.
Relationship	getSkeletonRelationship(String sourceName, String metadataCollectionId, InstanceProvenanceType provenanceType, String userName, String typeName) Return a relationship with the header and type information filled out.
String	getStringProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
TypeDef	getTypeDef(String sourceName, String parameterName, String typeDefGUID, String methodName) Return the TypeDef identified by the guid supplied by the caller.
TypeDef	getTypeDef(String sourceName, String guidParameterName, String nameParameterName, String typeDefGUID, String typeDefName, String methodName) Return the TypeDef identified by the guid and name supplied by the caller.
TypeDef	getTypeDefByName(String sourceName, String typeDefName) Return the TypeDef identified by the name supplied by the caller.
String	getTypeName(InstanceAuditHeader instance) Returns the type name from an instance (entity, relationship or classification).
Classification	incrementVersion(String userId, InstanceAuditHeader originalInstance, Classification updatedInstance) Changes the control information to reflect an update in an instance.
EntityDetail	incrementVersion(String userId, InstanceAuditHeader originalInstance, EntityDetail updatedInstance) Changes the control information to reflect an update in an instance.
Relationship	incrementVersion(String userId, InstanceAuditHeader originalInstance, Relationship updatedInstance) Changes the control information to reflect an update in an instance.
InstanceProperties	mergeInstanceProperties(String sourceName, InstanceProperties existingProperties, InstanceProperties newProperties) Merge two sets of instance properties.
boolean	relatedEntity(String sourceName, String entityGUID, Relationship relationship) Return boolean true if entity is linked by this relationship.
EntityDetail	updateClassificationInEntity(String sourceName, String userName, EntityDetail entity, Classification newClassification, String methodName) Replace an existing classification with a new one

Method Detail

getActiveTypeDefGallery

TypeDefGallery getActiveTypeDefGallery()

Return the list of typedefs active in the local repository.

Returns:

TypeDef gallery

getKnownTypeDefGallery

TypeDefGallery getKnownTypeDefGallery()

Return the list of typedefs known by the local repository.

Returns:

TypeDef gallery

getTypeDefByName

TypeDef getTypeDefByName(String sourceName,
                         String typeDefName)

Return the TypeDef identified by the name supplied by the caller. This is used in the connectors when validating the actual types of the repository with the known open metadata types looking specifically for types of the same name but with different content.

Parameters:

sourceName - source of the request (used for logging)

typeDefName - unique name for the TypeDef

Returns:

TypeDef object or null if TypeDef is not known.

getAttributeTypeDefByName

AttributeTypeDef getAttributeTypeDefByName(String sourceName,
                                           String attributeTypeDefName)

Return the AttributeTypeDef identified by the name supplied by the caller. This is used in the connectors when validating the actual types of the repository with the known open metadata types looking specifically for types of the same name but with different content.

Parameters:

sourceName - source of the request (used for logging)

attributeTypeDefName - unique name for the TypeDef

Returns:

AttributeTypeDef object or null if AttributeTypeDef is not known.

getActiveTypesByWildCardName

TypeDefGallery getActiveTypesByWildCardName(String sourceName,
                                            String typeDefName)

Return the TypeDefs identified by the name supplied by the caller. The TypeDef name may have wild card characters in it which is why the results are returned in a list.

Parameters:

sourceName - source of the request (used for logging)

typeDefName - unique name for the TypeDef

Returns:

TypeDef object or null if TypeDef is not known.

getTypeDef

TypeDef getTypeDef(String sourceName,
                   String parameterName,
                   String typeDefGUID,
                   String methodName)
            throws TypeErrorException

Return the TypeDef identified by the guid supplied by the caller. This call is used when retrieving a type that only the guid is known.

Parameters:

sourceName - source of the request (used for logging)

parameterName - name of guid parameter

typeDefGUID - unique identifier for the TypeDef

methodName - calling method

Returns:

TypeDef object

Throws:

TypeErrorException - unknown or invalid type

getAttributeTypeDef

AttributeTypeDef getAttributeTypeDef(String sourceName,
                                     String attributeTypeDefGUID,
                                     String methodName)
                              throws TypeErrorException

Return the AttributeTypeDef identified by the guid and name supplied by the caller. This call is used when retrieving a type that only the guid is known.

Parameters:

sourceName - source of the request (used for logging)

attributeTypeDefGUID - unique identifier for the AttributeTypeDef

methodName - calling method

Returns:

TypeDef object

Throws:

TypeErrorException - unknown or invalid type

getTypeDef

TypeDef getTypeDef(String sourceName,
                   String guidParameterName,
                   String nameParameterName,
                   String typeDefGUID,
                   String typeDefName,
                   String methodName)
            throws TypeErrorException

Return the TypeDef identified by the guid and name supplied by the caller. This call is used when retrieving a type that should exist. For example, retrieving the type of a metadata instance.

Parameters:

sourceName - source of the request (used for logging)

guidParameterName - name of guid parameter

nameParameterName - name of type name parameter

typeDefGUID - unique identifier for the TypeDef

typeDefName - unique name for the TypeDef

methodName - calling method

Returns:

TypeDef object

Throws:

TypeErrorException - unknown or invalid type

getAttributeTypeDef

AttributeTypeDef getAttributeTypeDef(String sourceName,
                                     String attributeTypeDefGUID,
                                     String attributeTypeDefName,
                                     String methodName)
                              throws TypeErrorException

Return the AttributeTypeDef identified by the guid and name supplied by the caller. This call is used when retrieving a type that should exist. For example, retrieving the type definition of a metadata instance's property.

Parameters:

sourceName - source of the request (used for logging)

attributeTypeDefGUID - unique identifier for the AttributeTypeDef

attributeTypeDefName - unique name for the AttributeTypeDef

methodName - calling method

Returns:

TypeDef object

Throws:

TypeErrorException - unknown or invalid type

applyPatch

TypeDef applyPatch(String sourceName,
                   TypeDef originalTypeDef,
                   TypeDefPatch typeDefPatch)
            throws PatchErrorException,
                   InvalidParameterException

Returns an updated TypeDef that has had the supplied patch applied. It throws an exception if any part of the patch is incompatible with the original TypeDef. For example, if there is a mismatch between the type or version that either represents.

Parameters:

sourceName - source of the TypeDef (used for logging)

typeDefPatch - patch to apply

originalTypeDef - typeDef to patch

Returns:

updated TypeDef

Throws:

PatchErrorException - the patch is either badly formatted, or does not apply to the supplied TypeDef

InvalidParameterException - the TypeDefPatch is null.

getMatchingActiveTypes

List<TypeDef> getMatchingActiveTypes(String sourceName,
                                     String standard,
                                     String organization,
                                     String identifier,
                                     String methodName)

Validate that the type's name is not null.

Parameters:

sourceName - source of the request (used for logging)

standard - name of the standard, null means any.

organization - name of the organization, null means any.

identifier - identifier of the element in the standard, null means any.

methodName - method receiving the call

Returns:

list of typeDefs

getSkeletonEntity

EntityDetail getSkeletonEntity(String sourceName,
                               String metadataCollectionId,
                               InstanceProvenanceType provenanceType,
                               String userName,
                               String typeName)
                        throws TypeErrorException

Return an entity with the header and type information filled out. The caller only needs to add properties and classifications to complete the set up of the entity.

Parameters:

sourceName - source of the request (used for logging)

metadataCollectionId - unique identifier for the home metadata collection

provenanceType - origin of the entity

userName - name of the creator

typeName - name of the type

Returns:

partially filled out entity needs classifications and properties

Throws:

TypeErrorException - the type name is not recognized.

getSkeletonClassification

Classification getSkeletonClassification(String sourceName,
                                         String userName,
                                         String classificationTypeName,
                                         String entityTypeName)
                                  throws TypeErrorException

Return a classification with the header and type information filled out. The caller only needs to add properties and possibility origin information if it is propagated to complete the set up of the classification.

Parameters:

sourceName - source of the request (used for logging)

userName - name of the creator

classificationTypeName - name of the classification type

entityTypeName - name of the type for the entity that this classification is to be attached to.

Returns:

partially filled out classification needs properties and possibly origin information

Throws:

TypeErrorException - the type name is not recognized as a classification type.

getSkeletonRelationship

Relationship getSkeletonRelationship(String sourceName,
                                     String metadataCollectionId,
                                     InstanceProvenanceType provenanceType,
                                     String userName,
                                     String typeName)
                              throws TypeErrorException

Return a relationship with the header and type information filled out. The caller only needs to add properties to complete the set up of the relationship.

Parameters:

sourceName - source of the request (used for logging)

metadataCollectionId - unique identifier for the home metadata collection

provenanceType - origin type of the relationship

userName - name of the creator

typeName - name of the relationship's type

Returns:

partially filled out relationship needs properties

Throws:

TypeErrorException - the type name is not recognized as a relationship type.

getNewInstanceType

InstanceType getNewInstanceType(String sourceName,
                                TypeDefSummary typeDefSummary)
                         throws TypeErrorException

Return a relationship with the header and type information filled out. The caller only needs to add properties to complete the set up of the relationship.

Parameters:

sourceName - source of the request (used for logging)

typeDefSummary - details of the new type

Returns:

instance type

Throws:

TypeErrorException - the type name is not recognized as a relationship type.

getNewEntity

EntityDetail getNewEntity(String sourceName,
                          String metadataCollectionId,
                          InstanceProvenanceType provenanceType,
                          String userName,
                          String typeName,
                          InstanceProperties properties,
                          List<Classification> classifications)
                   throws TypeErrorException

Return a filled out entity. It just needs to add the classifications.

Parameters:

sourceName - source of the request (used for logging)

metadataCollectionId - unique identifier for the home metadata collection

provenanceType - origin of the entity

userName - name of the creator

typeName - name of the type

properties - properties for the entity

classifications - list of classifications for the entity

Returns:

an entity that is filled out

Throws:

TypeErrorException - the type name is not recognized as an entity type

getNewRelationship

Relationship getNewRelationship(String sourceName,
                                String metadataCollectionId,
                                InstanceProvenanceType provenanceType,
                                String userName,
                                String typeName,
                                InstanceProperties properties)
                         throws TypeErrorException

Return a filled out relationship which just needs the entity proxies added.

Parameters:

sourceName - source of the request (used for logging)

metadataCollectionId - unique identifier for the home metadata collection

provenanceType - origin of the relationship

userName - name of the creator

typeName - name of the type

properties - properties for the relationship

Returns:

a relationship that is filled out

Throws:

TypeErrorException - the type name is not recognized as a relationship type

getNewClassification

Classification getNewClassification(String sourceName,
                                    String userName,
                                    String typeName,
                                    String entityTypeName,
                                    ClassificationOrigin classificationOrigin,
                                    String classificationOriginGUID,
                                    InstanceProperties properties)
                             throws TypeErrorException

Return a classification with the header and type information filled out. The caller only needs to add properties to complete the set up of the classification.

Parameters:

sourceName - source of the request (used for logging)

userName - name of the creator

typeName - name of the type

entityTypeName - name of the type for the entity that this classification is to be attached to.

classificationOrigin - is this explicitly assigned or propagated

classificationOriginGUID - if propagated this the GUID of the origin

properties - properties for the classification

Returns:

partially filled out classification needs properties and possibly origin information

Throws:

TypeErrorException - the type name is not recognized as a classification type.

addClassificationToEntity

EntityDetail addClassificationToEntity(String sourceName,
                                       EntityDetail entity,
                                       Classification newClassification,
                                       String methodName)

Add a classification to an existing entity.

Parameters:

sourceName - source of the request (used for logging)

entity - entity to update

newClassification - classification to update

methodName - calling method

Returns:

updated entity

getClassificationFromEntity

Classification getClassificationFromEntity(String sourceName,
                                           EntityDetail entity,
                                           String classificationName,
                                           String methodName)
                                    throws ClassificationErrorException

Return the names classification from an existing entity.

Parameters:

sourceName - source of the request (used for logging)

entity - entity to update

classificationName - classification to retrieve

methodName - calling method

Returns:

located classification

Throws:

ClassificationErrorException - the classification is not attached to the entity

updateClassificationInEntity

EntityDetail updateClassificationInEntity(String sourceName,
                                          String userName,
                                          EntityDetail entity,
                                          Classification newClassification,
                                          String methodName)

Replace an existing classification with a new one

Parameters:

sourceName - source of the request (used for logging)

userName - name of the editor

entity - entity to update

newClassification - classification to update

methodName - calling method

Returns:

updated entity

deleteClassificationFromEntity

EntityDetail deleteClassificationFromEntity(String sourceName,
                                            EntityDetail entity,
                                            String oldClassificationName,
                                            String methodName)
                                     throws ClassificationErrorException

Return a oldClassification with the header and type information filled out. The caller only needs to add properties to complete the set up of the oldClassification.

Parameters:

sourceName - source of the request (used for logging)

entity - entity to update

oldClassificationName - classification to remove

methodName - calling method

Returns:

updated entity

Throws:

ClassificationErrorException - the entity was not classified with this classification

mergeInstanceProperties

InstanceProperties mergeInstanceProperties(String sourceName,
                                           InstanceProperties existingProperties,
                                           InstanceProperties newProperties)

Merge two sets of instance properties.

Parameters:

sourceName - source of the request (used for logging)

existingProperties - current set of properties

newProperties - properties to add/update

Returns:

merged properties

incrementVersion

Relationship incrementVersion(String userId,
                              InstanceAuditHeader originalInstance,
                              Relationship updatedInstance)

Changes the control information to reflect an update in an instance.

Parameters:

userId - user making the change.

originalInstance - original instance before the change

updatedInstance - new version of the instance that needs updating

Returns:

updated instance

incrementVersion

Classification incrementVersion(String userId,
                                InstanceAuditHeader originalInstance,
                                Classification updatedInstance)

Changes the control information to reflect an update in an instance.

Parameters:

userId - user making the change.

originalInstance - original instance before the change

updatedInstance - new version of the instance that needs updating

Returns:

updated instance

incrementVersion

EntityDetail incrementVersion(String userId,
                              InstanceAuditHeader originalInstance,
                              EntityDetail updatedInstance)

Changes the control information to reflect an update in an instance.

Parameters:

userId - user making the change.

originalInstance - original instance before the change

updatedInstance - new version of the instance that needs updating

Returns:

updated instance

getNewEntityProxy

EntityProxy getNewEntityProxy(String sourceName,
                              EntityDetail entity)
                       throws RepositoryErrorException

Generate an entity proxy from an entity and its TypeDef.

Parameters:

sourceName - source of the request (used for logging)

entity - entity instance

Returns:

new entity proxy

Throws:

RepositoryErrorException - logic error in the repository corrupted entity

getNewEntityProxy

EntityProxy getNewEntityProxy(String sourceName,
                              String metadataCollectionId,
                              InstanceProvenanceType provenanceType,
                              String userName,
                              String typeName,
                              InstanceProperties properties,
                              List<Classification> classifications)
                       throws TypeErrorException

Return a filled out entity.

Parameters:

sourceName - source of the request (used for logging)

metadataCollectionId - unique identifier for the home metadata collection

provenanceType - origin of the entity

userName - name of the creator

typeName - name of the type

properties - properties for the entity

classifications - list of classifications for the entity

Returns:

an entity that is filled out

Throws:

TypeErrorException - the type name is not recognized as an entity type

relatedEntity

boolean relatedEntity(String sourceName,
                      String entityGUID,
                      Relationship relationship)

Return boolean true if entity is linked by this relationship.

Parameters:

sourceName - name of source requesting help

entityGUID - unique identifier of entity

relationship - relationship to test

Returns:

boolean indicating whether the entity is mentioned in the relationship

getStringProperty

String getStringProperty(String sourceName,
                         String propertyName,
                         InstanceProperties properties,
                         String methodName)

Return the requested property or null if property is not found. If the property is not a string property then a logic exception is thrown

Parameters:

sourceName - source of call

propertyName - name of requested property

properties - properties from the instance.

methodName - method of caller

Returns:

string property value or null

getMapProperty

InstanceProperties getMapProperty(String sourceName,
                                  String propertyName,
                                  InstanceProperties properties,
                                  String methodName)

Return the requested property or null if property is not found. If the property is not a map property then a logic exception is thrown

Parameters:

sourceName - source of call

propertyName - name of requested property

properties - properties from the instance.

methodName - method of caller

Returns:

string property value or null

getMapFromProperty

Map<String,Object> getMapFromProperty(String sourceName,
                                      String propertyName,
                                      InstanceProperties properties,
                                      String methodName)

Return the requested property or null if property is not found. If the property is not a map property then a logic exception is thrown.

Parameters:

sourceName - source of call

propertyName - name of requested property

properties - properties from the instance.

methodName - method of caller

Returns:

string property value or null

getIntProperty

int getIntProperty(String sourceName,
                   String propertyName,
                   InstanceProperties properties,
                   String methodName)

Return the requested property or 0 if property is not found. If the property is not a int property then a logic exception is thrown

Parameters:

sourceName - source of call

propertyName - name of requested property

properties - properties from the instance.

methodName - method of caller

Returns:

string property value or null

getBooleanProperty

boolean getBooleanProperty(String sourceName,
                           String propertyName,
                           InstanceProperties properties,
                           String methodName)

Return the requested property or false if property is not found. If the property is not a boolean property then a logic exception is thrown

Parameters:

sourceName - source of call

propertyName - name of requested property

properties - properties from the instance.

methodName - method of caller

Returns:

string property value or null

addStringPropertyToInstance

InstanceProperties addStringPropertyToInstance(String sourceName,
                                               InstanceProperties properties,
                                               String propertyName,
                                               String propertyValue,
                                               String methodName)

Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.

Parameters:

sourceName - name of caller

properties - properties object to add property to may be null.

propertyName - name of property

propertyValue - value of property

methodName - calling method name

Returns:

instance properties object.

addIntPropertyToInstance

InstanceProperties addIntPropertyToInstance(String sourceName,
                                            InstanceProperties properties,
                                            String propertyName,
                                            int propertyValue,
                                            String methodName)

Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.

Parameters:

sourceName - name of caller

properties - properties object to add property to may be null.

propertyName - name of property

propertyValue - value of property

methodName - calling method name

Returns:

instance properties object.

addBooleanPropertyToInstance

InstanceProperties addBooleanPropertyToInstance(String sourceName,
                                                InstanceProperties properties,
                                                String propertyName,
                                                boolean propertyValue,
                                                String methodName)

Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.

Parameters:

sourceName - name of caller

properties - properties object to add property to may be null.

propertyName - name of property

propertyValue - value of property

methodName - calling method name

Returns:

instance properties object.

addEnumPropertyToInstance

InstanceProperties addEnumPropertyToInstance(String sourceName,
                                             InstanceProperties properties,
                                             String propertyName,
                                             int ordinal,
                                             String symbolicName,
                                             String description,
                                             String methodName)

Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.

Parameters:

sourceName - name of caller

properties - properties object to add property to may be null.

propertyName - name of property

ordinal - numeric value of property

symbolicName - String value of property

description - String description of property value

methodName - calling method name

Returns:

instance properties object.

addMapPropertyToInstance

InstanceProperties addMapPropertyToInstance(String sourceName,
                                            InstanceProperties properties,
                                            String propertyName,
                                            Map<String,Object> mapValues,
                                            String methodName)

Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.

Parameters:

sourceName - name of caller

properties - properties object to add property to, may be null.

propertyName - name of property

mapValues - contents of the map

methodName - calling method name

Returns:

instance properties object.

getTypeName

String getTypeName(InstanceAuditHeader instance)
            throws RepositoryErrorException,
                   InvalidParameterException

Returns the type name from an instance (entity, relationship or classification).

Parameters:

instance - instance to read

Returns:

String type name

Throws:

InvalidParameterException - if the parameters are null or invalid

RepositoryErrorException - if the instance does not have a type name

getEnd1EntityGUID

String getEnd1EntityGUID(Relationship relationship)
                  throws RepositoryErrorException,
                         InvalidParameterException

Return the guid of an entity linked to end 1 of the relationship.

Parameters:

relationship - relationship to parse

Returns:

String unique identifier

Throws:

RepositoryErrorException

InvalidParameterException

getEnd2EntityGUID

String getEnd2EntityGUID(Relationship relationship)
                  throws RepositoryErrorException,
                         InvalidParameterException

Return the guid of an entity linked to end 2 of the relationship.

Parameters:

relationship - relationship to parse

Returns:

String unique identifier

Throws:

RepositoryErrorException

InvalidParameterException