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

Class FindEntities

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

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

Constructor

Description

FindEntities(XtdbOMRSRepositoryConnector xtdb, String entityTypeGUID, List<String> entitySubtypeGUIDs, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties matchProperties, int fromEntityElement, List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchClassifications matchClassifications, Date asOfTime, String sequencingProperty, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.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.egeria.connectors.juxt.xtdb.readops.AbstractEntitySearchOperation

getResults

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

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

FindEntities

public FindEntities(XtdbOMRSRepositoryConnector xtdb,
                    String entityTypeGUID,
                    List<String> entitySubtypeGUIDs,
                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties matchProperties,
                    int fromEntityElement,
                    List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus,
                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchClassifications matchClassifications,
                    Date asOfTime,
                    String sequencingProperty,
                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.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 Detail

runQuery

protected Collection<List<?>> runQuery(xtdb.api.IXtdbDatasource db)
                                throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException,
                                       TimeoutException,
                                       org.odpi.openmetadata.repositoryservices.ffdc.exception.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:

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

TimeoutException - if the query times out

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - if there is any issue iterating through the results