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

Class GetRelationshipsForEntity

java.lang.Object

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

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

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

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

public class GetRelationshipsForEntity
extends AbstractRelationshipSearchOperation

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

Field Summary

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

fromElement, limitResultsByStatus, matchClassifications, pageSize, sequencingOrder, sequencingProperty, typeGUID, userId

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

asOfTime, existingDB, xtdb

Constructor Summary

Constructors

Constructor	Description
GetRelationshipsForEntity(XTDBOMRSRepositoryConnector xtdb, String entityGUID, String relationshipTypeGUID, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, xtdb.api.IXtdbDatasource existingDB, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize, String userId)	Create a new 'getRelationshipsForEntity' executable.

Method Summary

Modifier and Type	Method	Description
protected Collection<List<?>>	runQuery(xtdb.api.IXtdbDatasource db)	Interface that must be implemented to actually execute the query logic.

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

getResults

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

deduplicateAndPage, searchXtdb, searchXtdbText, updateQuery

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

GetRelationshipsForEntity

public GetRelationshipsForEntity(XTDBOMRSRepositoryConnector xtdb,
 String entityGUID,
 String relationshipTypeGUID,
 int fromRelationshipElement,
 List<InstanceStatus> limitResultsByStatus,
 xtdb.api.IXtdbDatasource existingDB,
 String sequencingProperty,
 SequencingOrder sequencingOrder,
 int pageSize,
 String userId)

Create a new 'getRelationshipsForEntity' executable.

Parameters:

xtdb - connectivity to XTDB

entityGUID - of the entity for which to find relationships

relationshipTypeGUID - to limit the relationship types to retrieve (optional)

fromRelationshipElement - starting element for paging

limitResultsByStatus - by which to limit results (optional)

existingDB - already-opened datasource against which to do the retrievals

sequencingProperty - by which to order the results (required if sequencingOrder involves a property)

sequencingOrder - by which to order results (optional, will default to GUID)

pageSize - maximum number of results per page

userId - of the user running the query

Method Details

runQuery

protected Collection<List<?>> runQuery(xtdb.api.IXtdbDatasource db)
                                throws TypeErrorException,
RepositoryErrorException

Interface that must be implemented to actually execute the query logic.

Specified by:

runQuery in class AbstractSearchOperation

Parameters:

db - the datasource against which to run the query

Returns:

Collection<List<?>> of internal XT references (IDs) that match the query

Throws:

TypeErrorException - if a requested type for searching is not known to the repository

RepositoryErrorException - if there is any issue iterating through the results