org.odpi.openmetadata.frameworks.connectors.properties

Class AssetPropertyIteratorBase

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetAPIOperations, AssetCertifications, AssetCommentReplies, AssetComments, AssetConnections, AssetExternalIdentifiers, AssetExternalReferences, AssetInformalTags, AssetLicenses, AssetLikes, AssetLocations, AssetNoteLogs, AssetNotes, AssetRatings, AssetRelatedAssets, AssetRelatedMediaReferences, AssetSchemaAttributes, AssetSchemaImplementationQueries

public abstract class AssetPropertyIteratorBase
extends AssetPropertyBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AssetPagingIterator	pagingIterator

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

parentAsset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetPropertyIteratorBase(AssetDescriptor parentAsset, AssetPropertyIteratorBase template) Copy/clone constructor sets up details of the parent asset from the template
protected	AssetPropertyIteratorBase(AssetDescriptor parentAsset, int totalElementCount, int maxCacheSize) Typical Constructor creates an iterator with the supplied list of comments.

Method Summary

Modifier and Type	Method and Description
protected abstract AssetPropertyBase	cloneElement(AssetDescriptor parentAsset, AssetPropertyBase template) Method implemented by a subclass that ensures the cloning process is a deep clone.
protected abstract List<AssetPropertyBase>	getCachedList(int cacheStartPointer, int maximumSize) Method implemented by subclass to retrieve the next cached list of elements.
int	getElementCount() Return the number of elements in the list.

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, toString

Methods inherited from class java.lang.Object

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

Field Detail

pagingIterator

protected AssetPagingIterator pagingIterator

Constructor Detail

AssetPropertyIteratorBase

protected AssetPropertyIteratorBase(AssetDescriptor parentAsset,
                                    int totalElementCount,
                                    int maxCacheSize)

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

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.

AssetPropertyIteratorBase

protected AssetPropertyIteratorBase(AssetDescriptor parentAsset,
                                    AssetPropertyIteratorBase template)

Copy/clone constructor sets up details of the parent asset from the template

Parameters:

parentAsset - descriptor of asset that his property relates to.

template - AssetPropertyBaseImpl to copy

Method Detail

getElementCount

public int getElementCount()

Return the number of elements in the list.

Returns:

elementCount

cloneElement

protected abstract AssetPropertyBase cloneElement(AssetDescriptor parentAsset,
                                                  AssetPropertyBase template)

Method implemented by a subclass that ensures the cloning process is a deep clone.

Parameters:

parentAsset - descriptor of parent asset

template - object to clone

Returns:

new cloned object.

getCachedList

protected abstract List<AssetPropertyBase> getCachedList(int cacheStartPointer,
                                                         int maximumSize)
                                                  throws PropertyServerException

Method implemented by subclass to retrieve the next cached list of elements.

Parameters:

cacheStartPointer - where to start the cache.

maximumSize - maximum number of elements in the cache.

Returns:

list of elements corresponding to the supplied cache pointers.

Throws:

PropertyServerException - there is a problem retrieving elements from the property (metadata) server.