com.tailf.dp

Interface DpDataFindNextIterator

All Superinterfaces:

Iterator<Object>

public interface DpDataFindNextIterator
extends Iterator<Object>

Extended Iterator interface used to get findNext functionality.

This class is expected to be the return value of the DP Data Provider method DpDataCallback.iterator(DpTrans, ConfObject[], ConfFindNextType, ConfKey) If this overlaid iterator method is implemented this implies that the data provider is capable of both getNext as the basic iterator as well as findNext which is the extended method in this interface. Iterators of this type are expected to be first called by a findNext to position at some element in a list. The iterator will then accept subsequent getNext calls from that initial position.

Method Summary

Modifier and Type	Method and Description
Object	findNext(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key) This method is called by Dp when a FIND_NEXT or a FIND_NEXT_OBJECT call is issued.

Methods inherited from interface Iterator

forEachRemaining, hasNext, next, remove

Method Detail

findNext

Object findNext(DpTrans trans,
                ConfObject[] kp,
                ConfFindNextType type,
                ConfKey key)

This method is called by Dp when a FIND_NEXT or a FIND_NEXT_OBJECT call is issued. This iterator method is called to retrieve the element and the object is then rendered with the normal DpDataCallback.getIteratorKey(DpTrans, ConfObject[], Object) or DpDataCallback.getIteratorObject(DpTrans, ConfObject[], Object) methods before the element returned.

Parameters:

trans - current DpTrans object

kp - keypath for the iterator

type - ConfFindNextType enum indicating this or next element

key - value for the searched element

Returns:

retrieved element