org.odpi.openmetadata.accessservices.dataplatform.contentmanager

Class OMEntityDao

java.lang.Object

org.odpi.openmetadata.accessservices.dataplatform.contentmanager.OMEntityDao

public class OMEntityDao
extends Object

Constructor Summary

Constructors

Constructor and Description
OMEntityDao(OMRSRepositoryConnector enterpriseConnector, List<String> supportedZones, OMRSAuditLog auditLog)

Method Summary

Modifier and Type	Method and Description
EntityDetail	addEntity(String typeName, String qualifiedName, InstanceProperties properties, boolean zoneRestricted) 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, boolean zoneRestricted) 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, InstanceProperties instanceProperties) 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)
InstanceProperties	buildMatchingInstanceProperties(Map<String,String> properties, boolean zoneRestricted) Returns the properties object for the given pair of key - value that can be used for retrieving
OMEntityWrapper	createOrUpdateEntity(String typeName, String qualifiedName, InstanceProperties properties, List<Classification> classifications, boolean update, boolean zoneRestricted)
List<EntityDetail>	findEntities(InstanceProperties matchProperties, String typeName, int fromElement, int pageSize)
EntityDetail	getEntity(String typeName, String qualifiedName, boolean zoneRestricted) Returns the entity of the specified type retrieved based on qualified name
EntityDetail	getEntityByGuid(String guid)
List<Relationship>	getRelationships(String relationshipType, String guid2)
void	purgeEntity(EntitySummary entitySummary)
void	purgeRelationship(Relationship relationship)

Methods inherited from class java.lang.Object

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

Constructor Detail

OMEntityDao

public OMEntityDao(OMRSRepositoryConnector enterpriseConnector,
                   List<String> supportedZones,
                   OMRSAuditLog auditLog)

Method Detail

getEntity

public EntityDetail getEntity(String typeName,
                              String qualifiedName,
                              boolean zoneRestricted)
                       throws PagingErrorException,
                              UserNotAuthorizedException,
                              FunctionNotSupportedException,
                              InvalidParameterException,
                              RepositoryErrorException,
                              PropertyErrorException,
                              TypeErrorException

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

zoneRestricted -

Returns:

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

Throws:

PagingErrorException

UserNotAuthorizedException

FunctionNotSupportedException

InvalidParameterException

RepositoryErrorException

PropertyErrorException

TypeErrorException

findEntities

public List<EntityDetail> findEntities(InstanceProperties matchProperties,
                                       String typeName,
                                       int fromElement,
                                       int pageSize)
                                throws PagingErrorException,
                                       UserNotAuthorizedException,
                                       FunctionNotSupportedException,
                                       InvalidParameterException,
                                       RepositoryErrorException,
                                       PropertyErrorException,
                                       TypeErrorException

Throws:

PagingErrorException

UserNotAuthorizedException

FunctionNotSupportedException

InvalidParameterException

RepositoryErrorException

PropertyErrorException

TypeErrorException

getEntityByGuid

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

Throws:

RepositoryErrorException

UserNotAuthorizedException

EntityProxyOnlyException

InvalidParameterException

EntityNotKnownException

getRelationships

public List<Relationship> getRelationships(String relationshipType,
                                           String guid2)

addEntity

public EntityDetail addEntity(String typeName,
                              String qualifiedName,
                              InstanceProperties properties,
                              boolean zoneRestricted)
                       throws InvalidParameterException,
                              PropertyErrorException,
                              RepositoryErrorException,
                              EntityNotKnownException,
                              FunctionNotSupportedException,
                              PagingErrorException,
                              ClassificationErrorException,
                              UserNotAuthorizedException,
                              TypeErrorException,
                              StatusNotSupportedException

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:

InvalidParameterException

PropertyErrorException

RepositoryErrorException

EntityNotKnownException

FunctionNotSupportedException

PagingErrorException

ClassificationErrorException

UserNotAuthorizedException

TypeErrorException

StatusNotSupportedException

addEntity

public EntityDetail addEntity(String typeName,
                              String qualifiedName,
                              InstanceProperties properties,
                              List<Classification> classifications,
                              boolean zoneRestricted)
                       throws InvalidParameterException,
                              StatusNotSupportedException,
                              PropertyErrorException,
                              EntityNotKnownException,
                              TypeErrorException,
                              FunctionNotSupportedException,
                              PagingErrorException,
                              ClassificationErrorException,
                              UserNotAuthorizedException,
                              RepositoryErrorException

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

zoneRestricted -

Returns:

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

Throws:

InvalidParameterException

StatusNotSupportedException

PropertyErrorException

EntityNotKnownException

TypeErrorException

FunctionNotSupportedException

PagingErrorException

ClassificationErrorException

UserNotAuthorizedException

RepositoryErrorException

createOrUpdateEntity

public OMEntityWrapper createOrUpdateEntity(String typeName,
                                            String qualifiedName,
                                            InstanceProperties properties,
                                            List<Classification> classifications,
                                            boolean update,
                                            boolean zoneRestricted)
                                     throws UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            InvalidParameterException,
                                            RepositoryErrorException,
                                            PropertyErrorException,
                                            TypeErrorException,
                                            PagingErrorException,
                                            ClassificationErrorException,
                                            StatusNotSupportedException,
                                            EntityNotKnownException

Throws:

UserNotAuthorizedException

FunctionNotSupportedException

InvalidParameterException

RepositoryErrorException

PropertyErrorException

TypeErrorException

PagingErrorException

ClassificationErrorException

StatusNotSupportedException

EntityNotKnownException

addRelationship

public Relationship addRelationship(String relationshipType,
                                    String guid1,
                                    String guid2,
                                    InstanceProperties instanceProperties)
                             throws InvalidParameterException,
                                    TypeErrorException,
                                    PropertyErrorException,
                                    EntityNotKnownException,
                                    FunctionNotSupportedException,
                                    PagingErrorException,
                                    UserNotAuthorizedException,
                                    RepositoryErrorException,
                                    StatusNotSupportedException

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

instanceProperties - 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:

InvalidParameterException

TypeErrorException

PropertyErrorException

EntityNotKnownException

FunctionNotSupportedException

PagingErrorException

UserNotAuthorizedException

RepositoryErrorException

StatusNotSupportedException

buildMatchingInstanceProperties

public InstanceProperties buildMatchingInstanceProperties(Map<String,String> properties,
                                                          boolean zoneRestricted)

Returns the properties object for the given pair of key - value that can be used for retrieving

Parameters:

properties - - all properties to use for matching

zoneRestricted -

Returns:

properties with the given key - value pair

buildClassification

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

Throws:

TypeErrorException

purgeRelationship

public void purgeRelationship(Relationship relationship)
                       throws RepositoryErrorException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              RelationshipNotDeletedException,
                              RelationshipNotKnownException,
                              FunctionNotSupportedException

Throws:

RepositoryErrorException

UserNotAuthorizedException

InvalidParameterException

RelationshipNotDeletedException

RelationshipNotKnownException

FunctionNotSupportedException

purgeEntity

public void purgeEntity(EntitySummary entitySummary)
                 throws RepositoryErrorException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        EntityNotKnownException,
                        EntityNotDeletedException,
                        FunctionNotSupportedException

Throws:

RepositoryErrorException

UserNotAuthorizedException

InvalidParameterException

EntityNotKnownException

EntityNotDeletedException

FunctionNotSupportedException