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

Class MetadataCollectionIterator

java.lang.Object

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

org.odpi.openmetadata.frameworks.integration.iterator.MetadataCollectionIterator

public class MetadataCollectionIterator
extends IntegrationIterator

MetadataCollectionIterator is used to iterate through the 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, externalScopeGUID, externalScopeName, maxPageSize, metadataCollectionGUID, metadataCollectionQualifiedName, metadataTypeName, openMetadataStore, propertyHelper, startFrom, targetPermittedSynchronization

Constructor Summary

Constructors

Constructor	Description
MetadataCollectionIterator(String metadataCollectionGUID, String metadataCollectionQualifiedName, String externalScopeGUID, String externalScopeName, String catalogTargetName, String connectorName, String metadataTypeName, OpenMetadataStore openMetadataStore, 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

MetadataCollectionIterator

public MetadataCollectionIterator(String metadataCollectionGUID,
 String metadataCollectionQualifiedName,
 String externalScopeGUID,
 String externalScopeName,
 String catalogTargetName,
 String connectorName,
 String metadataTypeName,
 OpenMetadataStore openMetadataStore,
 PermittedSynchronization targetPermittedSynchronization,
 int maxPageSize,
 AuditLog auditLog)

Create the iterator.

Parameters:

metadataCollectionGUID - unique identifier of the metadata collection

metadataCollectionQualifiedName - unique name of the metadata collection

externalScopeGUID - unique identifier for the owning scope (typically a catalog)

externalScopeName - unique name for the owning scope (typically a catalog)

catalogTargetName - name of target

connectorName - name of the calling connector

metadataTypeName - type of element to receive

openMetadataStore - client to access metadata

targetPermittedSynchronization - the synchronization policy for this target

maxPageSize - max page size for the server

auditLog - logging destination

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