Package org.odpi.openmetadata.commonservices.repositoryhandler

Class RepositoryRelatedEntitiesIterator

java.lang.Object

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryIterator

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryIteratorForEntities

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryRelatedEntitiesIterator

public class RepositoryRelatedEntitiesIterator
extends RepositoryIteratorForEntities

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

MAX_PAGE_SIZE

Constructor Summary

Constructors

Constructor	Description
RepositoryRelatedEntitiesIterator(RepositoryHandler repositoryHandler, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, String userId, String startingEntityGUID, String startingEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder, String sequencingPropertyName, boolean forLineage, boolean forDuplicateProcessing, int startingFrom, int pageSize, int selectionEnd, Date effectiveTime, String methodName)	Constructor takes the parameters used to call the repository handler.
RepositoryRelatedEntitiesIterator(RepositoryHandler repositoryHandler, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, String userId, String startingEntityGUID, String startingEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder, String sequencingPropertyName, boolean forLineage, boolean forDuplicateProcessing, int startingFrom, int pageSize, Date effectiveTime, String methodName)	Constructor takes the parameters used to call the repository handler.

Method Summary

Modifier and Type	Method	Description
boolean	moreToReceive()	Determine if there is more to receive.

Methods inherited from class org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryIteratorForEntities

getNext

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryRelatedEntitiesIterator

public RepositoryRelatedEntitiesIterator(RepositoryHandler repositoryHandler,
 org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler,
 String userId,
 String startingEntityGUID,
 String startingEntityTypeName,
 String relationshipTypeGUID,
 String relationshipTypeName,
 List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus,
 Date asOfTime,
 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder,
 String sequencingPropertyName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 int startingFrom,
 int pageSize,
 Date effectiveTime,
 String methodName)
                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.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

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 query is to support lineage retrieval

forDuplicateProcessing - the query 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - when page size or start from parameters do not meet criteria

RepositoryRelatedEntitiesIterator

public RepositoryRelatedEntitiesIterator(RepositoryHandler repositoryHandler,
 org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler,
 String userId,
 String startingEntityGUID,
 String startingEntityTypeName,
 String relationshipTypeGUID,
 String relationshipTypeName,
 List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus,
 Date asOfTime,
 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder,
 String sequencingPropertyName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 int startingFrom,
 int pageSize,
 int selectionEnd,
 Date effectiveTime,
 String methodName)
                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.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

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 query is to support lineage retrieval

forDuplicateProcessing - the query 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.

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

effectiveTime - the time that the retrieved elements must be effective for

methodName - name of calling method

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid

Method Details

moreToReceive

public boolean moreToReceive()
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Specified by:

moreToReceive in class RepositoryIteratorForEntities

Returns:

boolean flag

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the repository is not allowing the user to access the metadata

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem in the repository