Package org.goplanit.data

Interface MultiKeyPlanItDataIterator

All Superinterfaces:

Iterator<Object[]>

All Known Implementing Classes:

MultiKeyPlanItDataIteratorImpl

public interface MultiKeyPlanItDataIterator
extends Iterator<Object[]>

Iterator which returns the keys and values for each row in a MultiKeyPlanItData object.

Author:

gman6028

Method Summary

Modifier and Type	Method	Description
static MultiKeyPlanItDataIterator	getInstance(boolean isSingleKey, org.apache.commons.collections4.IterableMap<Object,Object[]> singleKeyMap, org.apache.commons.collections4.map.MultiKeyMap<Object,Object[]> multiKeyMap)	Returns an instance of a class which implements this interface
Object[]	getKeys()	Returns an array of keys for the current iteration
Object[]	getValues()	Returns an array of values for the current iteration
boolean	hasNext()	Returns whether the MultiKeyPlanItData has any more rows
Object[]	next()	Returns the next array of keys in the iteration

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Method Detail

hasNext

boolean hasNext()

Returns whether the MultiKeyPlanItData has any more rows

Specified by:

hasNext in interface Iterator<Object[]>

Returns:

true if the MultiKeyPlanItData has any rows, false otherwise

next

Object[] next()

Returns the next array of keys in the iteration

Specified by:

next in interface Iterator<Object[]>

Returns:

the next array of keys in the iteration

getKeys

Object[] getKeys()

Returns an array of keys for the current iteration

Returns:

array of keys for the current iteration

getValues

Object[] getValues()

Returns an array of values for the current iteration

Returns:

array of values for the current iteration

getInstance

static MultiKeyPlanItDataIterator getInstance(boolean isSingleKey,
                                              org.apache.commons.collections4.IterableMap<Object,Object[]> singleKeyMap,
                                              org.apache.commons.collections4.map.MultiKeyMap<Object,Object[]> multiKeyMap)

Returns an instance of a class which implements this interface

Parameters:

isSingleKey - flag to indicate whether the MultiKeyPlanItData object has one key or several

singleKeyMap - Map used if the MultiKeyPlanItData object has one key

multiKeyMap - Map used if the MultiKeyPlanItData object has several keys

Returns:

a class which implements this interface