Package org.odpi.openmetadata.frameworks.integration.iterator

Class RelatedElementsIterator

java.lang.Object

org.odpi.openmetadata.frameworks.integration.iterator.IntegrationIterator

org.odpi.openmetadata.frameworks.integration.iterator.RelatedElementsIterator

public class RelatedElementsIterator
extends IntegrationIterator

RelatedElementsIterator is used to iterate through the related elements of a particular type within a metadata collection.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.iterator.IntegrationIterator

auditLog, catalogTargetName, connectorName, elementCache, integrationContext, maxPageSize, metadataCollectionGUID, metadataTypeName, propertyHelper, startFrom, targetPermittedSynchronization

Constructor Summary

Constructors

Constructor	Description
RelatedElementsIterator(String metadataCollectionGUID, String catalogTargetName, String connectorName, String parentGUID, String parentRelationshipTypeName, int parentAtEnd, String attachmentEntityTypeName, IntegrationContext integrationContext, PermittedSynchronization targetPermittedSynchronization, int maxPageSize, AuditLog auditLog)	Create the iterator.

Method Summary

Modifier and Type	Method	Description
protected boolean	fillCache()	Retrieve information from the open metadata repositories.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.iterator.IntegrationIterator

getMemberByQualifiedName, getNextMember, moreToReceive

Methods inherited from class java.lang.Object

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

Constructor Details

RelatedElementsIterator

public RelatedElementsIterator(String metadataCollectionGUID,
 String catalogTargetName,
 String connectorName,
 String parentGUID,
 String parentRelationshipTypeName,
 int parentAtEnd,
 String attachmentEntityTypeName,
 IntegrationContext integrationContext,
 PermittedSynchronization targetPermittedSynchronization,
 int maxPageSize,
 AuditLog auditLog)
                        throws UserNotAuthorizedException

Create the iterator.

Parameters:

metadataCollectionGUID - unique identifier of the metadata collection

catalogTargetName - name of target

connectorName - name of the calling connector

parentGUID - unique identifier of element that the desired results are linked to

parentRelationshipTypeName - type of relationship - may be null

parentAtEnd - which end of the relationship to start from: 0 (either); 1 or 2

attachmentEntityTypeName - type of element to receive

integrationContext - clients to access metadata

targetPermittedSynchronization - the synchronization policy for this target

maxPageSize - max page size for the server

auditLog - logging destination

Throws:

UserNotAuthorizedException - connector has disconnected

Method Details

fillCache

protected boolean fillCache()
                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve information from the open metadata repositories.

Specified by:

fillCache in class IntegrationIterator

Returns:

boolean where true means there are elements to process.

Throws:

InvalidParameterException - problem with a parameter value

PropertyServerException - repository not working properly

UserNotAuthorizedException - permissions problem