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

Class PropertyIteratorBase

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

APIOperations, Certifications, CommentReplies, Comments, Connections, ExternalIdentifiers, ExternalReferences, InformalTags, Licenses, Likes, Locations, NoteLogs, Notes, Ratings, RelatedAssets, RelatedMediaReferences, SchemaAttributes

public abstract class PropertyIteratorBase
extends PropertyBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PagingIterator	pagingIterator

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

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract ElementBase	cloneElement(ElementBase template)	Method implemented by a subclass that ensures the cloning process is a deep clone.
protected abstract List<ElementBase>	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.beans.PropertyBase

equals, getHeaderVersion, hashCode, setHeaderVersion

Methods inherited from class java.lang.Object

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

Field Detail

pagingIterator

protected PagingIterator pagingIterator

Constructor Detail

PropertyIteratorBase

protected PropertyIteratorBase(int totalElementCount,
                               int maxCacheSize)

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

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.

PropertyIteratorBase

protected PropertyIteratorBase(PropertyIteratorBase template)

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

Parameters:

template - PropertyIteratorBase to copy

Method Detail

getElementCount

public int getElementCount()

Return the number of elements in the list.

Returns:

elementCount

cloneElement

protected abstract ElementBase cloneElement(ElementBase template)

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

Parameters:

template - object to clone

Returns:

new cloned object.

getCachedList

protected abstract List<ElementBase> 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.