Package org.odpi.openmetadata.commonservices.repositoryhandler

Class RepositorySelectedEntitiesIterator

  • public class RepositorySelectedEntitiesIterator
extends RepositoryIteratorForEntities
    RepositorySelectedEntitiesIterator 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 Detail

      • RepositorySelectedEntitiesIterator

        public RepositorySelectedEntitiesIterator​(RepositoryHandler repositoryHandler,
                                          InvalidParameterHandler invalidParameterHandler,
                                          String userId,
                                          String entityTypeGUID,
                                          InstanceProperties properties,
                                          MatchCriteria matchCriteria,
                                          String sequencingPropertyName,
                                          boolean forLineage,
                                          boolean forDuplicateProcessing,
                                          int startingFrom,
                                          int pageSize,
                                          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 - error handler set up with max page size
        userId - user making the request
        entityTypeGUID - identifier for the relationship to follow
        properties - properties used in the search
        matchCriteria - all or any
        sequencingPropertyName - name of property used to sequence the results - null means no sequencing
        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
        startingFrom - initial position in the stored list.
        pageSize - 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 - bad parameter - probably page size

      • RepositorySelectedEntitiesIterator

        public RepositorySelectedEntitiesIterator​(RepositoryHandler repositoryHandler,
                                          InvalidParameterHandler invalidParameterHandler,
                                          String userId,
                                          String entityTypeGUID,
                                          String searchCriteria,
                                          String sequencingPropertyName,
                                          boolean forLineage,
                                          boolean forDuplicateProcessing,
                                          int startingFrom,
                                          int pageSize,
                                          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 - error handler set up with max page size
        userId - user making the request
        entityTypeGUID - identifier for the relationship to follow
        searchCriteria - value used in the search
        sequencingPropertyName - name of property used to sequence the results - null means no sequencing
        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
        startingFrom - initial position in the stored list.
        pageSize - maximum number of definitions to return on this call.
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        methodName - name of calling method
        Throws:
        InvalidParameterException - bad parameter - probably page size