org.eclipse.hyades.execution.runtime.datapool
Interface IDatapoolIteratorExt

public interface IDatapoolIteratorExt

Method Summary

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.

Method Detail

dpInitialize

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.

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

void dpInitialize(IDatapool datapool)

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

Parameters:

datapool - The datapool to iterate over.

dpDone

boolean dpDone()

Returns true if the current iterator value is null.

See Also:

#dpCurrent(), dpNext(), dpReset()

dpNext

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.

See Also:

#dpCurrent(), dpDone(), dpReset()

dpReset

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.

See Also:

#dpCurrent(), dpDone(), dpNext()