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

Class FindEntities

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.AbstractEntitySearchOperation

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

public class FindEntities
extends AbstractEntitySearchOperation

Implements the 'findEntities' 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
FindEntities(XTDBOMRSRepositoryConnector xtdb, String entityTypeGUID, List<String> entitySubtypeGUIDs, SearchProperties matchProperties, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, SearchClassifications matchClassifications, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize, String userId)	Create a new 'findEntities' 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.AbstractEntitySearchOperation

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

FindEntities

public FindEntities(XTDBOMRSRepositoryConnector xtdb,
 String entityTypeGUID,
 List<String> entitySubtypeGUIDs,
 SearchProperties matchProperties,
 int fromEntityElement,
 List<InstanceStatus> limitResultsByStatus,
 SearchClassifications matchClassifications,
 Date asOfTime,
 String sequencingProperty,
 SequencingOrder sequencingOrder,
 int pageSize,
 String userId)

Create a new 'findEntities' executable.

Parameters:

xtdb - connectivity to XTDB

entityTypeGUID - see XTDBOMRSMetadataCollection#findEntities

entitySubtypeGUIDs - see XTDBOMRSMetadataCollection#findEntities

matchProperties - see XTDBOMRSMetadataCollection#findEntities

fromEntityElement - see XTDBOMRSMetadataCollection#findEntities

limitResultsByStatus - see XTDBOMRSMetadataCollection#findEntities

matchClassifications - see XTDBOMRSMetadataCollection#findEntities

asOfTime - see XTDBOMRSMetadataCollection#findEntities

sequencingProperty - see XTDBOMRSMetadataCollection#findEntities

sequencingOrder - see XTDBOMRSMetadataCollection#findEntities

pageSize - see XTDBOMRSMetadataCollection#findEntities

userId - of the user running the query

See Also:

• XTDBOMRSMetadataCollection.findEntities(String, String, List, SearchProperties, int, List, SearchClassifications, Date, String, SequencingOrder, int)

Method Details

runQuery

protected Collection<List<?>> runQuery(xtdb.api.IXtdbDatasource db)
                                throws TypeErrorException,
TimeoutException,
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

TimeoutException - if the query times out

RepositoryErrorException - if there is any issue iterating through the results