Class RepositoryFindEntitiesIterator


public class RepositoryFindEntitiesIterator extends RepositoryIteratorForEntities
RepositoryFindEntitiesIterator is an iterator class for iteratively retrieving entities based on a search criteria. It is used where the caller needs to filter the results coming from the repository and may need to make more than one call to the repository in order to accumulate the number of requested results. Note this class is intended for a single request's use - it is not thread-safe.
  • Constructor Details

    • RepositoryFindEntitiesIterator

      public RepositoryFindEntitiesIterator(RepositoryHandler repositoryHandler, InvalidParameterHandler invalidParameterHandler, String userId, String entityTypeGUID, List<String> entitySubtypeGUIDs, SearchProperties searchProperties, List<InstanceStatus> limitResultsByStatus, SearchClassifications searchClassifications, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, boolean forLineage, boolean forDuplicateProcessing, int startingFrom, int requesterPageSize, Date effectiveTime, String methodName) throws InvalidParameterException
      Constructor takes the parameters used to call the repository handler.
      Parameters:
      repositoryHandler - interface to the open metadata repositories.
      invalidParameterHandler - invalid parameter handler
      userId - user making the request
      entityTypeGUID - String unique identifier for the entity type of interest (null means any entity type).
      entitySubtypeGUIDs - optional list of the unique identifiers (guids) for subtypes of the entityTypeGUID to include in the search results. Null means all subtypes.
      searchProperties - Optional list of entity property conditions to match.
      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.
      searchClassifications - Optional list of entity classifications to match.
      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.
      forLineage - the query is to support lineage retrieval
      forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
      startingFrom - initial position in the stored list.
      requesterPageSize - maximum number of definitions to return on this call.
      effectiveTime - the time that the retrieved elements must be effective for
      methodName - name of calling method
      Throws:
      InvalidParameterException - when page size or start from parameters do not meet criteria
  • Method Details