org.odpi.openmetadata.accessservices.informationview.contentmanager

Class OMEntityDao

java.lang.Object

org.odpi.openmetadata.accessservices.informationview.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
EntityDetail	addExternalEntity(String userId, String typeName, String qualifiedName, String externalSourceGuid, String externalSourceName, InstanceProperties properties, List<Classification> classifications, boolean zoneRestricted)
Relationship	addExternalRelationship(String userId, String relationshipType, String externalSourceGuid, String externalSourceName, String guid1, String guid2, InstanceProperties instanceProperties)
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
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)
OMEntityWrapper	createOrUpdateExternalEntity(String userId, String typeName, String qualifiedName, String externalSourceGuid, String externalSourceName, 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<EntityDetail>	getEntityDetails(List<Relationship> relationships, Function<Relationship,String> relationshipEndFunction)
List<EntityDetail>	getRelatedEntities(List<String> allEntitiesGuids, String relationshipType, Function<Relationship,String> relationshipEndFunction) Return list of guids of entities linked through the mentioned relationship
List<Relationship>	getRelationships(String relationshipType, String guid)
void	purgeEntity(EntitySummary entitySummary)
void	purgeRelationship(Relationship relationship)
void	purgeRelationships(List<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)

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

findEntities

public List<EntityDetail> findEntities(InstanceProperties matchProperties,
                                       String typeName,
                                       int fromElement,
                                       int pageSize)

getEntityByGuid

public EntityDetail getEntityByGuid(String guid)

getRelationships

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

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

createOrUpdateExternalEntity

public OMEntityWrapper createOrUpdateExternalEntity(String userId,
                                                    String typeName,
                                                    String qualifiedName,
                                                    String externalSourceGuid,
                                                    String externalSourceName,
                                                    InstanceProperties properties,
                                                    List<Classification> classifications,
                                                    boolean update,
                                                    boolean zoneRestricted)

addExternalEntity

public EntityDetail addExternalEntity(String userId,
                                      String typeName,
                                      String qualifiedName,
                                      String externalSourceGuid,
                                      String externalSourceName,
                                      InstanceProperties properties,
                                      List<Classification> classifications,
                                      boolean zoneRestricted)

addRelationship

public 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

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

addExternalRelationship

public Relationship addExternalRelationship(String userId,
                                            String relationshipType,
                                            String externalSourceGuid,
                                            String externalSourceName,
                                            String guid1,
                                            String guid2,
                                            InstanceProperties instanceProperties)

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

purgeRelationships

public void purgeRelationships(List<Relationship> relationship)

purgeRelationship

public void purgeRelationship(Relationship relationship)

purgeEntity

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

Throws:

RepositoryErrorException

UserNotAuthorizedException

InvalidParameterException

EntityNotKnownException

EntityNotDeletedException

FunctionNotSupportedException

getRelatedEntities

public List<EntityDetail> getRelatedEntities(List<String> allEntitiesGuids,
                                             String relationshipType,
                                             Function<Relationship,String> relationshipEndFunction)

Return list of guids of entities linked through the mentioned relationship

Parameters:

allEntitiesGuids -

relationshipType -

relationshipEndFunction -

Returns:

list of related entities

getEntityDetails

public List<EntityDetail> getEntityDetails(List<Relationship> relationships,
                                           Function<Relationship,String> relationshipEndFunction)