org.eclipse.hyades.models.common.datapool.impl
Class DatapoolIteratorImpl_Shared_ExtSequential

java.lang.Object
  org.eclipse.hyades.models.common.datapool.impl.DatapoolIteratorImpl_Private_Base
      org.eclipse.hyades.models.common.datapool.impl.DatapoolIteratorImpl_Shared_ExtSequential

All Implemented Interfaces:

IDatapoolIterator

public class DatapoolIteratorImpl_Shared_ExtSequential
extends DatapoolIteratorImpl_Private_Base
implements IDatapoolIterator

Field Summary

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

RANDOM_SEED, WRAP

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.
static DatapoolIteratorImpl_Shared_ExtSequential	getInstance()
java.lang.Object	getProperty(java.lang.String propertyName) Returns the Object associated with the specified property name.
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Sets the property with the specified name with a value captued in the Object.

Methods inherited from class org.eclipse.hyades.models.common.datapool.impl.DatapoolIteratorImpl_Private_Base

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

Methods inherited from class java.lang.Object

equals, 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

Method Detail

getInstance

public static DatapoolIteratorImpl_Shared_ExtSequential getInstance()

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_Private_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_Private_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_Private_Base.dpCurrent(), dpDone(), dpNext()

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Returns the Object associated with the specified property name.

Specified by:

getProperty in interface IDatapoolIterator

Parameters:

propertyName -

Returns:

The Object assoicated with the specified property name.

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.Object propertyValue)

Sets the property with the specified name with a value captued in the Object.

Specified by:

setProperty in interface IDatapoolIterator

Parameters:

propertyName -

propertyValue -