Package org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors

Class FindEntitiesByPropertyExecutor

java.lang.Object

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.PageableEntityRepositoryExecutorBase

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.FindEntitiesByPropertyExecutor

All Implemented Interfaces:

CloneableRepositoryExecutor, RepositoryExecutor

public class FindEntitiesByPropertyExecutor
extends PageableEntityRepositoryExecutorBase

FindEntitiesByPropertyExecutor is the executor for the findEntitiesByProperty request. This request can be issued in parallel - the call to each request potentially running in a different thread.

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

methodName, userId

Constructor Summary

Constructors

Constructor

Description

FindEntitiesByPropertyExecutor(String userId, String entityTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize, String localMetadataCollectionId, AuditLog auditLog, OMRSRepositoryValidator repositoryValidator, String methodName)

Create the executor.

Method Summary

Modifier and Type	Method	Description
CloneableRepositoryExecutor	getClone()	Return a clone of this executor with the same command parameters and accumulator instance.
boolean	issueRequestToRepository(String metadataCollectionId, OMRSMetadataCollection metadataCollection)	Perform the required action for the supplied repository.

Methods inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.PageableEntityRepositoryExecutorBase

augmentResultFromRepository, getResults, getResultsForAugmentation

Methods inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

getMethodName

Methods inherited from class java.lang.Object

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

Constructor Details

FindEntitiesByPropertyExecutor

public FindEntitiesByPropertyExecutor(String userId,
 String entityTypeGUID,
 InstanceProperties matchProperties,
 MatchCriteria matchCriteria,
 int fromEntityElement,
 List<InstanceStatus> limitResultsByStatus,
 List<String> limitResultsByClassification,
 Date asOfTime,
 String sequencingProperty,
 SequencingOrder sequencingOrder,
 int pageSize,
 String localMetadataCollectionId,
 AuditLog auditLog,
 OMRSRepositoryValidator repositoryValidator,
 String methodName)

Create the executor. The parameters provide the parameters for issuing the requests and combining the results.

Parameters:

userId - unique identifier for requesting user.

entityTypeGUID - String unique identifier for the entity type of interest (null means any entity type).

matchProperties - Optional list of entity properties to match (contains wildcards).

matchCriteria - Enum defining how the match properties should be matched to the entities in the repository.

fromEntityElement - the starting element number of the entities to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

limitResultsByStatus - By default, entities in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

limitResultsByClassification - List of classifications that must be present on all returned entities.

asOfTime - Requests a historical query of the entity. Null means return the present values.

sequencingProperty - String name of the entity property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result entities that can be returned on this request. Zero means unrestricted return results size.

localMetadataCollectionId - unique identifier for the local repository - may be null if no local repository

auditLog - logging destination

repositoryValidator - validator for resulting relationships

methodName - calling method

Method Details

getClone

public CloneableRepositoryExecutor getClone()

Return a clone of this executor with the same command parameters and accumulator instance. This is used when setting up the parallel execution of the work. Each clone executes the calls to a single open metadata repository.

Returns:

clone of this executor

issueRequestToRepository

public boolean issueRequestToRepository(String metadataCollectionId,
 OMRSMetadataCollection metadataCollection)

Perform the required action for the supplied repository.

Specified by:

issueRequestToRepository in interface RepositoryExecutor

Specified by:

issueRequestToRepository in class RepositoryExecutorBase

Parameters:

metadataCollectionId - unique identifier for the metadata collection for the repository

metadataCollection - metadata collection object for the repository

Returns:

boolean true means that the required results have been achieved