org.odpi.openmetadata.frameworks.connectors.properties

Class RelatedAssets

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyIteratorBase

org.odpi.openmetadata.frameworks.connectors.properties.RelatedAssets

All Implemented Interfaces:

Serializable, Iterator<RelatedAsset>

public abstract class RelatedAssets
extends AssetPropertyIteratorBase
implements Iterator<RelatedAsset>

RelatedAssets supports an iterator over a list of related assets. 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.AssetPropertyIteratorBase

pagingIterator

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

parentAsset

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected AssetPropertyBase	cloneElement(AssetDescriptor parentAsset, AssetPropertyBase template) Provides a concrete implementation of cloneElement for the specific iterator type.
protected abstract RelatedAssets	cloneIterator(AssetDescriptor parentAsset) Clones this iterator.
boolean	hasNext() The iterator can only be used once to step through the elements.
RelatedAsset	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.AssetPropertyIteratorBase

getCachedList, getElementCount

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

equals, getParentAsset, getParentAssetName, getParentAssetTypeName

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

hashCode

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

RelatedAssets

public RelatedAssets(AssetDescriptor parentAsset,
                     int totalElementCount,
                     int maxCacheSize)

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

Parameters:

parentAsset - descriptor of parent asset

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.

RelatedAssets

public RelatedAssets(AssetDescriptor parentAsset,
                     RelatedAssets template)

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

Parameters:

parentAsset - descriptor of parent asset

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

Method Detail

cloneElement

protected AssetPropertyBase cloneElement(AssetDescriptor parentAsset,
                                         AssetPropertyBase template)

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

Specified by:

cloneElement in class AssetPropertyIteratorBase

Parameters:

parentAsset - descriptor of parent asset

template - object to clone

Returns:

new cloned object.

cloneIterator

protected abstract RelatedAssets cloneIterator(AssetDescriptor parentAsset)

Clones this iterator.

Parameters:

parentAsset - descriptor of parent asset

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<RelatedAsset>

Returns:

boolean indicating whether there are more elements.

next

public RelatedAsset next()

Return the next element in the iteration.

Specified by:

next in interface Iterator<RelatedAsset>

Returns:

RelatedAsset 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<RelatedAsset>

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetPropertyElementBase

Returns:

print out of variables in a JSON-style