IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.datapool
Class KeywordDatapoolIterator

java.lang.Object   extended by com.rational.test.ft.datapool.BaseDatapoolIterator
      extended by com.rational.test.ft.datapool.KeywordDatapoolIterator
All Implemented Interfaces:
IDatapoolIterator

public class KeywordDatapoolIterator
extends BaseDatapoolIterator


Field Summary
 
Fields inherited from class com.rational.test.ft.datapool.BaseDatapoolIterator
datapool, equivalenceClass, equivalenceClassIndex
 
Fields inherited from interface org.eclipse.hyades.execution.runtime.datapool.IDatapoolIterator
RANDOM_SEED, WRAP
 
Constructor Summary
KeywordDatapoolIterator()
           
 
Method Summary
 IDatapoolRecord dpCurrent()
          The record currently available from this iterator for the associated instance of the datapool.
 boolean dpDone()
          Returns true if the current iterator value is null.
 void dpNext()
          Increments the iterator associated with an instance of the datapool.
 void dpReset()
          Restart the iterator associated with an instance of the datapool.
 IDatapoolCell getCell(java.lang.String variablename)
           
 int getRecordCount()
           
 void setIterator(int[] a)
           
 void setKeywordColumnMap(java.util.Hashtable map)
           
 void setNumber(int number)
           
 
Methods inherited from class com.rational.test.ft.datapool.BaseDatapoolIterator
dpBoolean, dpBoolean, dpByte, dpByte, dpChar, dpChar, dpDouble, dpDouble, dpFloat, dpFloat, dpInitialize, dpInitialize, dpInt, dpInt, dpLong, dpLong, dpShort, dpShort, dpString, dpString, dpValue, dpValue, getCell, getDatapool, getEquivalenceClass, getProperty, setDatapool, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KeywordDatapoolIterator

public KeywordDatapoolIterator()
Method Detail

setIterator

public void setIterator(int[] a)

setNumber

public void setNumber(int number)

getRecordCount

public int getRecordCount()

dpCurrent

public IDatapoolRecord dpCurrent()
Description copied from interface: IDatapoolIterator
The record currently available from this iterator for the associated instance of the datapool. This method will return the same value repeated until the iterator is incremented by a call to the next method. A value of null is returned when the iterator is out of values.

Specified by:
dpCurrent in interface IDatapoolIterator
Specified by:
dpCurrent in class BaseDatapoolIterator
Returns:
The current record in the itertion sequence or null.
See Also:
IDatapoolIterator.dpNext(), IDatapoolIterator.dpDone(), IDatapoolIterator.dpReset()

dpDone

public boolean dpDone()
Description copied from interface: IDatapoolIterator
Returns true if the current iterator value is null.

Specified by:
dpDone in interface IDatapoolIterator
Specified by:
dpDone in class BaseDatapoolIterator
See Also:
IDatapoolIterator.dpCurrent(), IDatapoolIterator.dpNext(), IDatapoolIterator.dpReset()

dpNext

public void dpNext()
Description copied from interface: IDatapoolIterator
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
Specified by:
dpNext in class BaseDatapoolIterator
See Also:
IDatapoolIterator.dpCurrent(), IDatapoolIterator.dpDone(), IDatapoolIterator.dpReset()

dpReset

public void dpReset()
Description copied from interface: IDatapoolIterator
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
Specified by:
dpReset in class BaseDatapoolIterator
See Also:
IDatapoolIterator.dpCurrent(), IDatapoolIterator.dpDone(), IDatapoolIterator.dpNext()

setKeywordColumnMap

public void setKeywordColumnMap(java.util.Hashtable map)

getCell

public IDatapoolCell getCell(java.lang.String variablename)
Overrides:
getCell in class BaseDatapoolIterator