Package org.odpi.egeria.connectors.juxt.xtdb.readops

Class AbstractRelationshipSearchOperation

java.lang.Object

org.odpi.egeria.connectors.juxt.xtdb.readops.AbstractReadOperation

org.odpi.egeria.connectors.juxt.xtdb.readops.AbstractSearchOperation

org.odpi.egeria.connectors.juxt.xtdb.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.egeria.connectors.juxt.xtdb.readops.AbstractSearchOperation

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

Fields inherited from class org.odpi.egeria.connectors.juxt.xtdb.readops.AbstractReadOperation

asOfTime, existingDB, xtdb

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRelationshipSearchOperation(XtdbOMRSRepositoryConnector xtdb, String typeGUID, int fromElement, List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder, int pageSize, String userId)
protected	AbstractRelationshipSearchOperation(XtdbOMRSRepositoryConnector xtdb, String typeGUID, int fromElement, List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus, xtdb.api.IXtdbDatasource existingDB, String sequencingProperty, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder, int pageSize, String userId)	Create a new search operation.

Method Summary

Modifier and Type	Method	Description
List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.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.egeria.connectors.juxt.xtdb.readops.AbstractSearchOperation

deduplicateAndPage, runQuery, searchXtdb, searchXtdbText, updateQuery

Methods inherited from class org.odpi.egeria.connectors.juxt.xtdb.readops.AbstractReadOperation

getXtdbObjectByReference

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRelationshipSearchOperation

protected AbstractRelationshipSearchOperation(XtdbOMRSRepositoryConnector xtdb,
                                              String typeGUID,
                                              int fromElement,
                                              List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus,
                                              Date asOfTime,
                                              String sequencingProperty,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder,
                                              int pageSize,
                                              String userId)

AbstractRelationshipSearchOperation

protected AbstractRelationshipSearchOperation(XtdbOMRSRepositoryConnector xtdb,
                                              String typeGUID,
                                              int fromElement,
                                              List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus,
                                              xtdb.api.IXtdbDatasource existingDB,
                                              String sequencingProperty,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.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 Detail

getResults

public List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship> getResults()
                                                                                                                                      throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException,
                                                                                                                                             org.odpi.openmetadata.repositoryservices.ffdc.exception.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:

org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - if a requested type for searching is not known to the repository

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - on any error with the read operation, either closing the datasource or timing out