Package org.odpi.openmetadata.commonservices.repositoryhandler

Class RepositoryIterator

java.lang.Object

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryIterator

Direct Known Subclasses:

RepositoryFindRelationshipsIterator, 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 Summary

Fields

Modifier and Type	Field	Description
protected Date	effectiveTime
protected boolean	forDuplicateProcessing
protected boolean	forLineage
protected InvalidParameterHandler	invalidParameterHandler
static final int	MAX_PAGE_SIZE	Page size used when retrieving metadata.
protected String	methodName
protected int	pageSize
protected RepositoryHandler	repositoryHandler
protected int	startingFrom
protected String	userId

Constructor Summary

Constructors

Constructor	Description
RepositoryIterator(RepositoryHandler repositoryHandler, InvalidParameterHandler invalidParameterHandler, String userId, int startingFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Constructor takes the parameters used to call the repository handler.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

MAX_PAGE_SIZE

public static final int MAX_PAGE_SIZE

Page size used when retrieving metadata.

See Also:

• Constant Field Values

repositoryHandler

protected RepositoryHandler repositoryHandler

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

userId

protected String userId

startingFrom

protected int startingFrom

pageSize

protected int pageSize

methodName

protected String methodName

forLineage

protected boolean forLineage

forDuplicateProcessing

protected boolean forDuplicateProcessing

effectiveTime

protected Date effectiveTime

Constructor Details

RepositoryIterator

public RepositoryIterator(RepositoryHandler repositoryHandler,
 InvalidParameterHandler invalidParameterHandler,
 String userId,
 int startingFrom,
 int pageSize,
 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.

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