ConnectedComments (OCF Metadata Management Client-side 3.14 API)

java.lang.Object
- org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
- - org.odpi.openmetadata.frameworks.connectors.properties.PropertyIteratorBase
  - - org.odpi.openmetadata.frameworks.connectors.properties.Comments
    - - org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedComments

All Implemented Interfaces:

Serializable, Iterator<Comment>
```
public class ConnectedComments
extends Comments
```
ConnectedComments provides the open metadata concrete implementation of the Open Connector Framework (OCF) Comments abstract class. Its role is to query the property servers (metadata repository cohort) to extract comments related to the connected asset.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected ElementBase`	`cloneElement(ElementBase template)`	Method implemented by a subclass that ensures the cloning process is a deep clone.
`protected Comments`	`cloneIterator()`	Clones this iterator.
`protected List<ElementBase>`	`getCachedList(int cacheStartPointer, int maximumSize)`	Method implemented by subclass to retrieve the next cached list of elements.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.Comments
hasNext, next, remove, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.PropertyIteratorBase
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

- Method Detail
  - cloneIterator
```
protected Comments cloneIterator()
```
    Clones this iterator.
    
    Specified by:
    
    cloneIterator in class Comments
    
    Returns:
    
    new cloned object.
  - cloneElement
```
protected ElementBase cloneElement(ElementBase template)
```
    Method implemented by a subclass that ensures the cloning process is a deep clone.
    
    Overrides:
    
    cloneElement in class Comments
    
    Parameters:
    
    template - object to clone
    
    Returns:
    
    new cloned object.
  - getCachedList
```
protected List<ElementBase> getCachedList(int cacheStartPointer,
                                          int maximumSize)
                                   throws PropertyServerException
```
    Method implemented by subclass to retrieve the next cached list of elements.
    
    Specified by:
    
    getCachedList in class PropertyIteratorBase
    
    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.