|
IBM Rational Functional Tester Version 8.1.1000 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDatapool
This class defines the primary interface to datapools. A datapool is an ordered collection of data. The structure of data is in the form of uniformly sized records that are collected into logical groups.
datapool --> (0..n) EquivalenceClasses --> (0..n) Records
Each record contains a uniform set of variables
(logically columns) with appropriate name and id properties associated
with each.
IDatapoolEquivalenceClass
,
IDatapoolRecord
,
IDatapoolVariable
,
DatapoolException
Method Summary | |
---|---|
int |
getDefaultEquivalenceClassIndex()
Accessor for the default equivalence class
in the datapool. |
IDatapoolEquivalenceClass |
getEquivalenceClass(int index)
Accessor for the equivalence class at the specified
zero based index in the datapool. |
int |
getEquivalenceClassCount()
Returns the number of equivalence classes
associated with a datapool. |
int |
getEquivalenceClassIndex(java.lang.String equivalenceClassName)
Locate an equivalence class by name
within an instance of a datapool. |
int |
getEquivalenceClassIndexById(java.lang.String equivalenceClassId)
Locate an equivalence class by ID
within an instance of a datapool. |
IDatapoolVariable |
getVariable(int variableIndex)
The variable at a specified zero based column index. |
int |
getVariableCount()
The number of variables available in each record. |
int |
getVariableIndex(java.lang.String variableName)
Locates the appropriate index associated with a specific variable name. |
int |
getVariableIndexById(java.lang.String variableId)
Locates the appropriate index associated with a specific variable ID. |
Methods inherited from interface org.eclipse.hyades.execution.runtime.datapool.INamedElement |
---|
getDescription, getId, getName |
Method Detail |
---|
int getVariableCount()
IDatapoolVariable getVariable(int variableIndex)
DatapoolException
is thrown if the
specified index is not valid.
variableIndex
- A zero based variable index.
getVariableIndex(String)
int getVariableIndex(java.lang.String variableName)
variable
name. Users will depend
on this method to determine the appropriate cell to access
within a record given a current record and a variable name.
The current record is typically made available from
an iterator
that is performing an
ordered traversal of the records in a datapool.
variableName
- The name of the variable associated
with the desired cell.
getVariableIndexById(String)
int getVariableIndexById(java.lang.String variableId)
variable
ID. Users may use
this method to determine the appropriate cell to access
within a record given a current record and a variable ID.
variableId
- The ID of the variable associated
with the desired cell.
getVariableIndex(String)
int getEquivalenceClassCount()
equivalence classes
associated with a datapool.
IDatapoolEquivalenceClass getEquivalenceClass(int index)
equivalence class
at the specified
zero based index in the datapool. If an invalid index is supplied a
DatapoolException
with an appropriate message is thrown.
int getDefaultEquivalenceClassIndex()
equivalence class
in the datapool. If the default equivalence class has not been defined then
a value of -1 is returned.
int getEquivalenceClassIndex(java.lang.String equivalenceClassName)
equivalence class
by name
within an instance of a datapool.
getEquivalenceClassIndexById(String)
int getEquivalenceClassIndexById(java.lang.String equivalenceClassId)
equivalence class
by ID
within an instance of a datapool.
getEquivalenceClassIndex(String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |