Package org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops

Class GetEntityNeighborhood

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractReadOperation

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractGraphOperation

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.GetEntityNeighborhood

public class GetEntityNeighborhood
extends AbstractGraphOperation

Implements the 'getEntityNeighborhood' operation of the OMRS metadata collection interface.

Constructor Summary

Constructors

Constructor	Description
GetEntityNeighborhood(XTDBOMRSRepositoryConnector xtdb, String entityGUID, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, int level)	Create a new getEntityNeighborhood operation.

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceGraph	execute()	Execute the getEntityNeighborhood operation.

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractReadOperation

getXtdbObjectByReference

Methods inherited from class java.lang.Object

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

Constructor Details

GetEntityNeighborhood

public GetEntityNeighborhood(XTDBOMRSRepositoryConnector xtdb,
 String entityGUID,
 List<String> entityTypeGUIDs,
 List<String> relationshipTypeGUIDs,
 List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus,
 List<String> limitResultsByClassification,
 Date asOfTime,
 int level)

Create a new getEntityNeighborhood operation.

Parameters:

xtdb - connectivity to XTDB

entityGUID - the starting point of the query

entityTypeGUIDs - list of entity types to include in the query results (null means include all entities found, irrespective of their type)

relationshipTypeGUIDs - list of relationship types to include in the query results (null means include all relationships found, irrespective of their type)

limitResultsByStatus - list of statuses by which to limit results

limitResultsByClassification - list of classifications that must be present on all returned entities

asOfTime - the point-in-time for which to retrieve results

level - the number of the relationships out from the starting entity the query will traverse to gather results

Method Details

execute

public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceGraph execute()
                                                                                                                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException,
org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException

Execute the getEntityNeighborhood operation.

Returns:

InstanceGraph of results

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException - if the starting entity for the traversal cannot be found

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - on any other connectivity or resource usage error