org.odpi.openmetadata.commonservices.repositoryhandler

Class RepositoryRelatedEntitiesIterator

java.lang.Object

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryRelatedEntitiesIterator

public class RepositoryRelatedEntitiesIterator
extends Object

RepositoryRelationshipsIterator is an iterator class for iteratively retrieving relationships for an anchor 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.

Constructor Summary

Constructors

Constructor and Description
RepositoryRelatedEntitiesIterator(RepositoryHandler repositoryHandler, String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, int startingFrom, int pageSize, String methodName) Constructor takes the parameters used to call the repository handler.

Method Summary

Modifier and Type	Method and Description
EntityDetail	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

RepositoryRelatedEntitiesIterator

public RepositoryRelatedEntitiesIterator(RepositoryHandler repositoryHandler,
                                         String userId,
                                         String anchorEntityGUID,
                                         String anchorEntityTypeName,
                                         String relationshipTypeGUID,
                                         String relationshipTypeName,
                                         int startingFrom,
                                         int pageSize,
                                         String methodName)

Constructor takes the parameters used to call the repository handler.

Parameters:

repositoryHandler - interface to the open metadata repositories.

userId - user making the request

anchorEntityGUID - starting entity's GUID

anchorEntityTypeName - starting entity's type name

relationshipTypeGUID - identifier for the relationship to follow

relationshipTypeName - type name for the relationship to follow

startingFrom - initial position in the stored list.

pageSize - maximum number of definitions to return on this call.

methodName - name of calling method

Method Detail

moreToReceive

public boolean moreToReceive()
                      throws UserNotAuthorizedException,
                             PropertyServerException

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

Returns:

boolean flag

Throws:

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

PropertyServerException - there is a problem in the repository

getNext

public EntityDetail getNext()
                     throws UserNotAuthorizedException,
                            PropertyServerException

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

Returns:

relationship or null

Throws:

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

PropertyServerException - there is a problem in the repository