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

Class IntegrationIterator

java.lang.Object

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

Direct Known Subclasses:

MetadataCollectionIterator, RelatedElementsIterator

public abstract class IntegrationIterator
extends Object

IntegrationIterator provides the common logic for an integration iterator.

Constructor Summary

Constructors

Constructor

Description

IntegrationIterator(String metadataCollectionGUID, String metadataCollectionQualifiedName, String externalScopeGUID, String externalScopeName, String catalogTargetName, String connectorName, String metadataTypeName, OpenMetadataAccess openMetadataAccess, org.odpi.openmetadata.frameworks.openmetadata.enums.PermittedSynchronization targetPermittedSynchronization, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)

Create the iterator.

Method Summary

Modifier and Type	Method	Description
MemberElement	getMemberByQualifiedName(String qualifiedName)	Retrieve the member element by qualified name.
MemberElement	getNextMember()	Return the next element.
boolean	moreToReceive()	Is there information from the open metadata repositories to process?

Methods inherited from class java.lang.Object

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

Constructor Details

IntegrationIterator

public IntegrationIterator(String metadataCollectionGUID,
 String metadataCollectionQualifiedName,
 String externalScopeGUID,
 String externalScopeName,
 String catalogTargetName,
 String connectorName,
 String metadataTypeName,
 OpenMetadataAccess openMetadataAccess,
 org.odpi.openmetadata.frameworks.openmetadata.enums.PermittedSynchronization targetPermittedSynchronization,
 int maxPageSize,
 org.odpi.openmetadata.frameworks.auditlog.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

openMetadataAccess - client to access metadata

targetPermittedSynchronization - the synchronization policy for this target

maxPageSize - max page size for the server

auditLog - logging destination

Method Details

moreToReceive

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

Is there information from the open metadata repositories to process?

Returns:

boolean where true means there are elements to process.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - problem with a parameter value

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - repository not working properly

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - permissions problem

getNextMember

public MemberElement getNextMember()
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return the next element.

Returns:

next member in the repository.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - problem with a parameter value

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - repository not working properly

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - permissions problem

getMemberByQualifiedName

public MemberElement getMemberByQualifiedName(String qualifiedName)
                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Retrieve the member element by qualified name. This is used in sweep 2 when elements from the third party system are being retrieved and mapped to open metadata elements. It is possible that there is no open metadata element, or it has been deleted.

Parameters:

qualifiedName - anticipated qualified name.

Returns:

member element - may be empty - but not null

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - problem with a parameter value

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - repository not working properly

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - permissions problem