IBM Rational Functional Tester
Version 6.1
IBM Rational Functional Tester API Reference

Project Version 2.0

com.rational.test.ft.script
Class DatapoolScriptSupport

java.lang.Object
  extended bycom.rational.test.ft.script.DatapoolScriptSupport
Direct Known Subclasses:
SubitemFactory

public class DatapoolScriptSupport
extends java.lang.Object

Provides methods for accessing rows in an associated datapool.

Since:
RFT2.0

Field Summary
static int DP_ALL
          Flag to iterate over all remaining records in the datapool iterator.
static int DP_DEFAULT_EQUIVALENCE_CLASS
          Flag to use the default equivalence class.
static int DP_SHARE_CURRENT_RECORD
          Flag to share the current record in the datapool iterator.
 
Constructor Summary
DatapoolScriptSupport()
           
 
Method Summary
 boolean dpBoolean(int columnIndex)
           
 boolean dpBoolean(java.lang.String column)
           
 byte dpByte(int columnIndex)
           
 byte dpByte(java.lang.String column)
           
 char dpChar(int columnIndex)
           
 char dpChar(java.lang.String column)
           
 IDatapoolRecord dpCurrent()
           
 boolean dpDone()
           
 double dpDouble(int columnIndex)
           
 double dpDouble(java.lang.String column)
           
 IDatapoolFactory dpFactory()
          Exposes the underlying the factory object so that IDatapool instances can be opened without direct support from the script editor.
 float dpFloat(int columnIndex)
           
 float dpFloat(java.lang.String column)
           
 void dpInitialization(java.io.File datapoolFile, int equivalenceClassIndex, java.lang.String iteratorClassName)
           
 void dpInitialize(IDatapool datapool, int equivalenceClassIndex, int iterationCount)
           
 int dpInt(int columnIndex)
           
 int dpInt(java.lang.String column)
           
 long dpLong(int columnIndex)
           
 long dpLong(java.lang.String column)
           
 void dpNext()
           
 void dpReset()
           
 short dpShort(int columnIndex)
           
 short dpShort(java.lang.String column)
           
 java.lang.String dpString(int columnIndex)
           
 java.lang.String dpString(java.lang.String column)
           
 void dpTermination(boolean terminatedByException)
           
 java.lang.Object dpValue(int columnIndex)
           
 java.lang.Object dpValue(java.lang.String column)
           
 IDatapool getDatapool()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DP_ALL

public static final int DP_ALL
Flag to iterate over all remaining records in the datapool iterator.

See Also:
Constant Field Values

DP_SHARE_CURRENT_RECORD

public static final int DP_SHARE_CURRENT_RECORD
Flag to share the current record in the datapool iterator.

See Also:
Constant Field Values

DP_DEFAULT_EQUIVALENCE_CLASS

public static final int DP_DEFAULT_EQUIVALENCE_CLASS
Flag to use the default equivalence class.

See Also:
Constant Field Values
Constructor Detail

DatapoolScriptSupport

public DatapoolScriptSupport()
Method Detail

dpFactory

public IDatapoolFactory dpFactory()
Exposes the underlying the factory object so that IDatapool instances can be opened without direct support from the script editor.

Returns:
The underlying the factory object
Since:
RFT2.0
See Also:
IDatapoolFactory

dpInitialization

public void dpInitialization(java.io.File datapoolFile,
                             int equivalenceClassIndex,
                             java.lang.String iteratorClassName)

dpTermination

public void dpTermination(boolean terminatedByException)

dpInitialize

public void dpInitialize(IDatapool datapool,
                         int equivalenceClassIndex,
                         int iterationCount)

getDatapool

public IDatapool getDatapool()

dpCurrent

public IDatapoolRecord dpCurrent()

dpDone

public boolean dpDone()

dpNext

public void dpNext()

dpReset

public void dpReset()

dpValue

public java.lang.Object dpValue(int columnIndex)

dpValue

public java.lang.Object dpValue(java.lang.String column)

dpString

public java.lang.String dpString(int columnIndex)

dpString

public java.lang.String dpString(java.lang.String column)

dpLong

public long dpLong(int columnIndex)

dpLong

public long dpLong(java.lang.String column)

dpInt

public int dpInt(int columnIndex)

dpInt

public int dpInt(java.lang.String column)

dpShort

public short dpShort(int columnIndex)

dpShort

public short dpShort(java.lang.String column)

dpByte

public byte dpByte(int columnIndex)

dpByte

public byte dpByte(java.lang.String column)

dpDouble

public double dpDouble(int columnIndex)

dpDouble

public double dpDouble(java.lang.String column)

dpFloat

public float dpFloat(int columnIndex)

dpFloat

public float dpFloat(java.lang.String column)

dpBoolean

public boolean dpBoolean(int columnIndex)

dpBoolean

public boolean dpBoolean(java.lang.String column)

dpChar

public char dpChar(int columnIndex)

dpChar

public char dpChar(java.lang.String column)