Package org.odpi.openmetadata.frameworks.connectors.properties

Class ExternalIdentifiers

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.PropertyIteratorBase

org.odpi.openmetadata.frameworks.connectors.properties.ExternalIdentifiers

All Implemented Interfaces:

Serializable, Iterator<ExternalIdentifier>

public abstract class ExternalIdentifiers
extends PropertyIteratorBase
implements Iterator<ExternalIdentifier>

ExternalIdentifiers supports an iterator over a list of external identifiers. Callers can use it to step through the list just once. If they want to parse the list again, they could use the copy/clone constructor to create a new iterator.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.PropertyIteratorBase

pagingIterator

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
ExternalIdentifiers(int totalElementCount, int maxCacheSize)	Typical Constructor creates an iterator with the supplied list of elements.
ExternalIdentifiers(ExternalIdentifiers template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
protected ElementBase	cloneElement(ElementBase template)	Provides a concrete implementation of cloneElement for the specific iterator type.
protected abstract ExternalIdentifiers	cloneIterator()	Clones this iterator.
boolean	hasNext()	The iterator can only be used once to step through the elements.
ExternalIdentifier	next()	Return the next element in the iteration.
void	remove()	Remove the current element in the iterator.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.PropertyIteratorBase

getCachedList, getElementCount

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

equals, getHeaderVersion, hashCode, setHeaderVersion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ExternalIdentifiers

public ExternalIdentifiers(int totalElementCount,
                           int maxCacheSize)

Typical Constructor creates an iterator with the supplied list of elements.

Parameters:

totalElementCount - the total number of elements to process. A negative value is converted to 0.

maxCacheSize - maximum number of elements that should be retrieved from the property server and cached in the element list at any one time. If a number less than one is supplied, 1 is used.

ExternalIdentifiers

public ExternalIdentifiers(ExternalIdentifiers template)

Copy/clone constructor. Used to reset iterator element pointer to 0;

Parameters:

template - type-specific iterator to copy; null to create an empty iterator

Method Detail

cloneElement

protected ElementBase cloneElement(ElementBase template)

Provides a concrete implementation of cloneElement for the specific iterator type.

Specified by:

cloneElement in class PropertyIteratorBase

Parameters:

template - object to clone

Returns:

new cloned object.

cloneIterator

protected abstract ExternalIdentifiers cloneIterator()

Clones this iterator.

Returns:

new cloned object.

hasNext

public boolean hasNext()

The iterator can only be used once to step through the elements. This method returns a boolean to indicate if it has got to the end of the list yet.

Specified by:

hasNext in interface Iterator<ExternalIdentifier>

Returns:

boolean indicating whether there are more elements.

next

public ExternalIdentifier next()

Return the next element in the iteration.

Specified by:

next in interface Iterator<ExternalIdentifier>

Returns:

ExternalIdentifier next element object that has been cloned.

remove

public void remove()

Remove the current element in the iterator. (Null implementation since this iterator works off of cached elements from the property (metadata) server.)

Specified by:

remove in interface Iterator<ExternalIdentifier>

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style