Package org.odpi.openmetadata.commonservices.repositoryhandler

Class RepositoryRelationshipsIterator

java.lang.Object

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryIterator

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryRelationshipsIterator

public class RepositoryRelationshipsIterator
extends RepositoryIterator

RepositoryRelationshipsIterator is an iterator class for iteratively retrieving relationships for a starting entity (possibly restricting the type of relationships returned). 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.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryIterator

effectiveTime, forDuplicateProcessing, forLineage, invalidParameterHandler, MAX_PAGE_SIZE, methodName, pageSize, repositoryHandler, startingFrom, userId

Constructor Summary

Constructors

Constructor	Description
RepositoryRelationshipsIterator(RepositoryHandler repositoryHandler, InvalidParameterHandler invalidParameterHandler, String userId, String startingEntityGUID, String startingEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, int selectionEnd, boolean forLineage, boolean forDuplicateProcessing, int startingFrom, int pageSize, Date effectiveTime, String methodName)	Constructor takes the parameters used to call the repository handler.
RepositoryRelationshipsIterator(RepositoryHandler repositoryHandler, InvalidParameterHandler invalidParameterHandler, String userId, EntityDetail startingEntity, String startingEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, int selectionEnd, boolean forLineage, boolean forDuplicateProcessing, int startingFrom, int pageSize, Date effectiveTime, String methodName)	Constructor if entity not already retrieved.

Method Summary

Modifier and Type	Method	Description
Relationship	getNext()	Return the next relationship.
boolean	moreToReceive()	Determine if there is more to receive.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryRelationshipsIterator

public RepositoryRelationshipsIterator(RepositoryHandler repositoryHandler,
                                       InvalidParameterHandler invalidParameterHandler,
                                       String userId,
                                       EntityDetail startingEntity,
                                       String startingEntityTypeName,
                                       String relationshipTypeGUID,
                                       String relationshipTypeName,
                                       int selectionEnd,
                                       boolean forLineage,
                                       boolean forDuplicateProcessing,
                                       int startingFrom,
                                       int pageSize,
                                       Date effectiveTime,
                                       String methodName)
                                throws InvalidParameterException

Constructor if entity not already retrieved. It 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

startingEntity - starting entity

startingEntityTypeName - starting entity's type name

relationshipTypeGUID - identifier for the relationship to follow

relationshipTypeName - type name for the relationship to follow

selectionEnd - 0 means either end, 1 means only take from end 1, 2 means only take from end 2

forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned

forDuplicateProcessing - is this retrieve part of duplicate processing?

startingFrom - initial position in the stored list.

pageSize - maximum number of definitions to return by this iterator.

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

RepositoryRelationshipsIterator

public RepositoryRelationshipsIterator(RepositoryHandler repositoryHandler,
                                       InvalidParameterHandler invalidParameterHandler,
                                       String userId,
                                       String startingEntityGUID,
                                       String startingEntityTypeName,
                                       String relationshipTypeGUID,
                                       String relationshipTypeName,
                                       int selectionEnd,
                                       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 - invalid parameter handler

userId - user making the request

startingEntityGUID - starting entity's GUID

startingEntityTypeName - starting entity's type name

relationshipTypeGUID - identifier for the relationship to follow

relationshipTypeName - type name for the relationship to follow

selectionEnd - 0 means either end, 1 means only take from end 1, 2 means only take from end 2

forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned

forDuplicateProcessing - is this retrieve part of duplicate processing?

startingFrom - initial position in the stored list.

pageSize - maximum number of definitions to return by this iterator.

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 Detail

moreToReceive

public boolean moreToReceive()
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Determine if there is more to receive. It will populate the iterator's cache with more content.

Returns:

boolean flag

Throws:

InvalidParameterException - bad parameter

UserNotAuthorizedException - the repository is not allowing the user to access the metadata

PropertyServerException - there is a problem in the repository

getNext

public Relationship getNext()
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Return the next relationship. It returns null if nothing left to retrieve.

Returns:

relationship or null

Throws:

InvalidParameterException - bad parameter

UserNotAuthorizedException - the repository is not allowing the user to access the metadata

PropertyServerException - there is a problem in the repository