Package org.odpi.openmetadata.commonservices.repositoryhandler

Class RepositoryIterator

java.lang.Object
org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryIterator
Direct Known Subclasses:
RepositoryIteratorForEntities, RepositoryRelationshipsIterator
public class RepositoryIterator extends Object
RepositoryIterator is the shared interface of all repository helper iterators that retrieve entity or relationship details from the repository.

  • Field Details

    • MAX_PAGE_SIZE

      public static final int MAX_PAGE_SIZE
      Page size used when retrieving metadata.
      See Also:

    • startingFrom

      protected int startingFrom

    • pageSize

      protected int pageSize

    • repositoryHandler

      protected final RepositoryHandler repositoryHandler

    • invalidParameterHandler

      protected final InvalidParameterHandler invalidParameterHandler

    • userId

      protected final String userId

    • methodName

      protected final String methodName

    • limitResultsByStatus

      protected final List<InstanceStatus> limitResultsByStatus

    • asOfTime

      protected final Date asOfTime

    • sequencingOrder

      protected final SequencingOrder sequencingOrder

    • sequencingPropertyName

      protected final String sequencingPropertyName

    • forLineage

      protected final boolean forLineage

    • forDuplicateProcessing

      protected final boolean forDuplicateProcessing

    • effectiveTime

      protected final Date effectiveTime

  • Constructor Details

    • RepositoryIterator

      public RepositoryIterator(RepositoryHandler repositoryHandler, InvalidParameterHandler invalidParameterHandler, String userId, int startingFrom, int pageSize, List<InstanceStatus> limitResultsByStatus, Date asOfTime, SequencingOrder sequencingOrder, String sequencingPropertyName, boolean forLineage, boolean forDuplicateProcessing, 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
      startingFrom - initial position in the stored list.
      pageSize - maximum number of definitions to return on this call.
      limitResultsByStatus - By default, relationships in all statuses (other than DELETE) are returned. However, it is possible to specify a list of statuses (for example ACTIVE) to restrict the results to. Null means all status values.
      asOfTime - Requests a historical query of the entity. Null means return the present values.
      sequencingPropertyName - String name of the 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 request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      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