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

Class AbstractRelationshipSearchOperation

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

Direct Known Subclasses:

FindRelationships, FindRelationshipsByPropertyValue, GetRelationshipsForEntity

public abstract class AbstractRelationshipSearchOperation
extends AbstractSearchOperation

Base class that all search operations that retrieve entities should implement.

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

Modifier	Constructor	Description
protected	AbstractRelationshipSearchOperation(XTDBOMRSRepositoryConnector xtdb, String typeGUID, int fromElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize, String userId)
protected	AbstractRelationshipSearchOperation(XTDBOMRSRepositoryConnector xtdb, String typeGUID, int fromElement, List<InstanceStatus> limitResultsByStatus, xtdb.api.IXtdbDatasource existingDB, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize, String userId)	Create a new search operation.

Method Summary

Modifier and Type	Method	Description
List<Relationship>	getResults()	Public interface through which to execute the search operation, which should populate the 'xtdbResults' protected member of this class.

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

deduplicateAndPage, runQuery, 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

AbstractRelationshipSearchOperation

protected AbstractRelationshipSearchOperation(XTDBOMRSRepositoryConnector xtdb,
 String typeGUID,
 int fromElement,
 List<InstanceStatus> limitResultsByStatus,
 Date asOfTime,
 String sequencingProperty,
 SequencingOrder sequencingOrder,
 int pageSize,
 String userId)

AbstractRelationshipSearchOperation

protected AbstractRelationshipSearchOperation(XTDBOMRSRepositoryConnector xtdb,
 String typeGUID,
 int fromElement,
 List<InstanceStatus> limitResultsByStatus,
 xtdb.api.IXtdbDatasource existingDB,
 String sequencingProperty,
 SequencingOrder sequencingOrder,
 int pageSize,
 String userId)

Create a new search operation.

Parameters:

xtdb - connectivity to XTDB

typeGUID - unique identifier of a type definition by which to limit results

fromElement - starting element for paged results

limitResultsByStatus - list of statuses by which to limit results

existingDB - the already-opened point-in-time from which to retrieve results

sequencingProperty - the name of the property by which to sort results (only applicable when sorting by property)

sequencingOrder - the mechanism to use for sorting results

pageSize - the number of results to include per page

userId - executing the search

Method Details

getResults

public List<Relationship> getResults()
                              throws TypeErrorException,
RepositoryErrorException

Public interface through which to execute the search operation, which should populate the 'xtdbResults' protected member of this class.

Returns:

List<Relationship> list of results in Egeria form

Throws:

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

RepositoryErrorException - on any error with the read operation, either closing the datasource or timing out