org.eclipse.hyades.datapool.iterator
Class DatapoolIteratorSequentialPrivate

java.lang.Object
  org.eclipse.hyades.datapool.iterator.DatapoolIteratorImpl_Base
      org.eclipse.hyades.datapool.iterator.DatapoolIteratorSequentialPrivate

All Implemented Interfaces:

IDatapoolIterator

public class DatapoolIteratorSequentialPrivate

extends DatapoolIteratorImpl_Base

implements IDatapoolIterator

Field Summary

Fields inherited from class org.eclipse.hyades.datapool.iterator.DatapoolIteratorImpl_Base

allEquivClasses, currentEquivClassIndex, currentRecordIndex, done, myDatapool, myEquivClassIndex, properties

Fields inherited from interface org.eclipse.hyades.execution.runtime.datapool.IDatapoolIterator

RANDOM_SEED, WRAP

Constructor Summary

DatapoolIteratorSequentialPrivate()

Method Summary

static void	close()
boolean	dpDone() Returns true if the current iterator value is null.
void	dpInitialize(IDatapool datapool) This method acts the same way as dpInitialize with equivalence class specification except that default equivalence class is used.
void	dpInitialize(IDatapool datapool, int equivalenceClassIndex) Initialize the iterator sequence from the specified datapool object.
void	dpNext() Increments the iterator associated with an instance of the datapool.
void	dpReset() Restart the iterator associated with an instance of the datapool.
static DatapoolIteratorSequentialPrivate	getInstance()

Methods inherited from class org.eclipse.hyades.datapool.iterator.DatapoolIteratorImpl_Base

dpBoolean, dpBoolean, dpByte, dpByte, dpChar, dpChar, dpCurrent, dpDouble, dpDouble, dpFloat, dpFloat, dpInt, dpInt, dpLong, dpLong, dpShort, dpShort, dpString, dpString, dpValue, dpValue, getDatapool, getProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.hyades.execution.runtime.datapool.IDatapoolIterator

dpBoolean, dpBoolean, dpByte, dpByte, dpChar, dpChar, dpCurrent, dpDouble, dpDouble, dpFloat, dpFloat, dpInt, dpInt, dpLong, dpLong, dpShort, dpShort, dpString, dpString, dpValue, dpValue, getDatapool, getProperty, setProperty

Constructor Detail

DatapoolIteratorSequentialPrivate

public DatapoolIteratorSequentialPrivate()

Method Detail

getInstance

public static DatapoolIteratorSequentialPrivate getInstance()

close

public static void close()

dpInitialize

public void dpInitialize(IDatapool datapool,
                         int equivalenceClassIndex)

Initialize the iterator sequence from the specified datapool object. Depending on the implementation of this method the iterator may use sequential or random access order, share a cursor with other processes or use a repeating sequence to access the records. The order of access is left to the individual iterator implementations.

Specified by:

dpInitialize in interface IDatapoolIterator

Parameters:

datapool - The datapool to iterate over.

equivalenceClassIndex - The zero-based index of the equivalence class that should be iterated over. If this value is negative then all records in the datapool should be will be available to the iterator.

dpInitialize

public void dpInitialize(IDatapool datapool)

This method acts the same way as dpInitialize with equivalence class specification except that default equivalence class is used.

Specified by:

dpInitialize in interface IDatapoolIterator

Parameters:

datapool - The datapool to iterate over.

dpDone

public boolean dpDone()

Returns true if the current iterator value is null.

Specified by:

dpDone in interface IDatapoolIterator

See Also:

DatapoolIteratorImpl_Base.dpCurrent(), dpNext(), dpReset()

dpNext

public void dpNext()

Increments the iterator associated with an instance of the datapool. Calling this method after the iteration sequence has been exhausted has no effect.

Specified by:

dpNext in interface IDatapoolIterator

See Also:

DatapoolIteratorImpl_Base.dpCurrent(), dpDone(), dpReset()

dpReset

public void dpReset()

Restart the iterator associated with an instance of the datapool. It does not matter if the iterator has been exhausted of entries or not, the iterator simply resets to the initial start state.

Specified by:

dpReset in interface IDatapoolIterator

See Also:

DatapoolIteratorImpl_Base.dpCurrent(), dpDone(), dpNext()