org.odpi.openmetadata.accessservices.informationview.contentmanager

Class EntitiesCreatorHelper

java.lang.Object

org.odpi.openmetadata.accessservices.informationview.contentmanager.EntitiesCreatorHelper

public class EntitiesCreatorHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
EntitiesCreatorHelper(OMRSRepositoryConnector enterpriseConnector, OMRSAuditLog auditLog)

Method Summary

Modifier and Type	Method and Description
EntityDetail	addEntity(String typeName, String qualifiedName, InstanceProperties properties) Returns the entity of the given type with the specified qualified name; if it doesn't already exists, it is created with the provided instance properties
EntityDetail	addEntity(String typeName, String qualifiedName, InstanceProperties properties, List<Classification> classifications) Returns the entity of the given type with the specified qualified name; if it doesn't already exists, it is created with the provided instance properties
Relationship	addRelationship(String relationshipType, String guid1, String guid2, String source, InstanceProperties properties) Returns the relationship of the given type with the specified qualified name; if it doesn't already exists, it is created with the provided instance properties
Classification	buildClassification(String classificationTypeName, String entityTypeName, InstanceProperties classificationProperties)
EntityDetail	getEntity(String guid)
EntityDetail	getEntity(String typeName, String qualifiedName) Returns the entity of the specified type retrieved based on qualified name
List<Relationship>	getRelationships(String relationshipType, String guid2)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntitiesCreatorHelper

public EntitiesCreatorHelper(OMRSRepositoryConnector enterpriseConnector,
                             OMRSAuditLog auditLog)

Method Detail

getEntity

public EntityDetail getEntity(String typeName,
                              String qualifiedName)
                       throws Exception

Returns the entity of the specified type retrieved based on qualified name

Parameters:

typeName - name of the type def for the entity to be retrieved

qualifiedName - qualified name property of the entity to be retrieved

Returns:

the existing entity with the given qualified name or null if it doesn't exist

Throws:

Exception

getRelationships

public List<Relationship> getRelationships(String relationshipType,
                                           String guid2)
                                    throws InvalidParameterException,
                                           RepositoryErrorException,
                                           TypeDefNotKnownException,
                                           UserNotAuthorizedException,
                                           TypeErrorException,
                                           EntityNotKnownException,
                                           PropertyErrorException,
                                           PagingErrorException,
                                           FunctionNotSupportedException

Throws:

InvalidParameterException

RepositoryErrorException

TypeDefNotKnownException

UserNotAuthorizedException

TypeErrorException

EntityNotKnownException

PropertyErrorException

PagingErrorException

FunctionNotSupportedException

addEntity

public EntityDetail addEntity(String typeName,
                              String qualifiedName,
                              InstanceProperties properties)
                       throws Exception

Returns the entity of the given type with the specified qualified name; if it doesn't already exists, it is created with the provided instance properties

Parameters:

typeName - is the entity type

qualifiedName - - qualified name property of the entity, unique for the same entity type

properties - specific to the entity type

Returns:

the existing entity with the given qualified name or the newly created entity with the given qualified name

Throws:

Exception

addEntity

public EntityDetail addEntity(String typeName,
                              String qualifiedName,
                              InstanceProperties properties,
                              List<Classification> classifications)
                       throws Exception

Returns the entity of the given type with the specified qualified name; if it doesn't already exists, it is created with the provided instance properties

Parameters:

typeName - is the entity type

qualifiedName - - qualified name property of the entity, unique for the same entity type

properties - specific to the entity type

classifications - classifications to be added to entity

Returns:

the existing entity with the given qualified name or the newly created entity with the given qualified name

Throws:

Exception

addRelationship

public Relationship addRelationship(String relationshipType,
                                    String guid1,
                                    String guid2,
                                    String source,
                                    InstanceProperties properties)
                             throws Exception

Returns the relationship of the given type with the specified qualified name; if it doesn't already exists, it is created with the provided instance properties

Parameters:

relationshipType - is the relationship type name

guid1 - first end of the relationship

guid2 - second end of the relationship

source - name of the relationship creator

properties - specific to the relationship type

Returns:

the existing relationship with the given qualified name or the newly created relationship with the given qualified name

Throws:

Exception

buildClassification

public Classification buildClassification(String classificationTypeName,
                                          String entityTypeName,
                                          InstanceProperties classificationProperties)
                                   throws Exception

Throws:

Exception

getEntity

public EntityDetail getEntity(String guid)
                       throws RepositoryErrorException,
                              UserNotAuthorizedException,
                              EntityProxyOnlyException,
                              InvalidParameterException,
                              EntityNotKnownException

Throws:

RepositoryErrorException

UserNotAuthorizedException

EntityProxyOnlyException

InvalidParameterException

EntityNotKnownException