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.

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractGraphOperation

limitResultsByStatus, startEntityGUID

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

asOfTime, existingDB, xtdb

Constructor Summary

Constructors

Constructor	Description
GetEntityNeighborhood(XTDBOMRSRepositoryConnector xtdb, String entityGUID, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, int level)	Create a new getEntityNeighborhood operation.

Method Summary

Modifier and Type	Method	Description
InstanceGraph	execute()	Execute the getEntityNeighborhood operation.

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

findDirectNeighbors, findNeighborhood, getEntityRefFromGraphTuple, getNextLevelNeighbors, resultsToGraph

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

getXtdbObjectByReference

Methods inherited from class java.lang.Object

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

Constructor Details

GetEntityNeighborhood

public GetEntityNeighborhood(XTDBOMRSRepositoryConnector xtdb,
 String entityGUID,
 List<String> entityTypeGUIDs,
 List<String> relationshipTypeGUIDs,
 List<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 InstanceGraph execute()
                      throws EntityNotKnownException,
RepositoryErrorException

Execute the getEntityNeighborhood operation.

Returns:

InstanceGraph of results

Throws:

EntityNotKnownException - if the starting entity for the traversal cannot be found

RepositoryErrorException - on any other connectivity or resource usage error