|
IBM Rational Functional Tester Version 6.1 IBM Rational Functional Tester API Reference Project Version 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a table of test data.
Method Summary | |
void |
addComparisonRegion(ITestDataTableRegion comparisonRegion)
Adds the supplied comparison region to the set. |
java.lang.Object |
getCell(int row,
int column)
Returns the contents of the cell at the specified column and row index. |
int |
getColumnCount()
Returns the number of columns in the table. |
java.lang.Object |
getColumnHeader(int column)
Returns the table-column header corresponding to the specified column index. |
int |
getColumnIndex(Column column)
Converts a column specification to a zero-based column index. |
ITestDataTableRegion[] |
getComparisonRegions()
Returns the set of comparison regions to be used in a comparison of table data. |
int[] |
getKeyColumns()
Returns the indices of the columns that contain key fields. |
int[] |
getKeyRows()
Returns the indices of the rows that contain key fields. |
int |
getRowCount()
Returns the number of rows in the table. |
java.lang.Object |
getRowHeader(int row)
Returns the table row header corresponding to the specified row index. |
int |
getRowIndex(Row row)
Converts a row specification to a zero-based row index. |
boolean |
hasColumnHeaders()
Returns true if the corresponding table has column headers. |
boolean |
hasKeyColumns()
Returns true if the table has columns that contain key data fields. |
boolean |
hasKeyRows()
Returns true if the table has rows that contain key data fields. |
boolean |
hasRowHeaders()
Returns true if the corresponding table has row headers. |
boolean |
isCompareBothByLeftRegions()
Specifies whether the comparison should be performed by using the comparison regions of both left and right values or just the left. |
boolean |
isCompareColumnHeaders()
Returns true if the column headers should be compared. |
boolean |
isCompareRowHeaders()
Returns true if the row headers should be compared. |
void |
removeComparisonRegion(ITestDataTableRegion comparisonRegion)
Removes the supplied comparison region from the region set associated with this table data object. |
void |
setCell(int row,
int column,
java.lang.Object value)
Updates the contents of the cell at the specified column and row index. |
void |
setColumnHeader(int column,
java.lang.Object columnHeader)
Updates a column header associated with the table. |
void |
setColumnHeaders(java.lang.Object[] columnHeaders)
Defines the column headers associated with the table. |
void |
setCompareBothByLeftRegions(boolean compareBothByLeftRegions)
Specifies whether the comparison should be performed by using the comparison regions of both left and right values or just the left. |
void |
setCompareColumnHeaders(boolean compareColumnHeaders)
Specifies whether the column headers should be compared. |
void |
setCompareRowHeaders(boolean compareRowHeaders)
Specifies if the row headers should be compared. |
void |
setComparisonRegions(ITestDataTableRegion[] comparisonRegions)
Replaces the existing selected regions with the supplied comparison regions. |
void |
setKeyColumns(int[] keyColumns)
Specifies the indices of the columns that contain key fields. |
void |
setKeyRows(int[] keyRows)
Specifies the indices of the rows that are used for key row specifications. |
void |
setRowHeader(int row,
java.lang.Object rowHeader)
Updates a row header associated with the table. |
void |
setRowHeaders(java.lang.Object[] rowHeaders)
Defines the row headers associated with the table. |
Methods inherited from interface com.rational.test.ft.vp.ITestData |
getData, getDataType, getDescription, getName, getProperty, getPropertyKeys, getType, setData, setDataType, setDescription, setName, setProperty, setType |
Method Detail |
public int getColumnCount()
public int getRowCount()
public boolean hasColumnHeaders()
true
if the corresponding table has column headers.
public java.lang.Object getColumnHeader(int column)
public void setColumnHeader(int column, java.lang.Object columnHeader)
column
- the column in which to use this headercolumnHeader
- the column header to associate with the specified columnpublic void setColumnHeaders(java.lang.Object[] columnHeaders)
public boolean hasRowHeaders()
true
if the corresponding table has row headers.
public java.lang.Object getRowHeader(int row)
public void setRowHeader(int row, java.lang.Object rowHeader)
row
- the row in which to use this headerrowHeader
- the row header to associate with the specified columnpublic void setRowHeaders(java.lang.Object[] rowHeaders)
public java.lang.Object getCell(int row, int column)
row
- the index for the desired rowcolumn
- the index for the desired column
public void setCell(int row, int column, java.lang.Object value)
row
- the index for the desired rowcolumn
- the index for the desired columnvalue
- the new value to be associated with the cellpublic boolean hasKeyColumns()
true
if the table has columns that contain key data fields.
public int[] getKeyColumns()
hasKeyColumns
returns true
.
public void setKeyColumns(int[] keyColumns)
hasKeyColumns
returns true
.
keyColumns
- the zero-based column indices of the key columnspublic boolean isCompareColumnHeaders()
true
if the column headers should be compared.
public void setCompareColumnHeaders(boolean compareColumnHeaders)
compareColumnHeaders
- true
if the column headers should be compared.public boolean hasKeyRows()
true
if the table has rows that contain key data fields.
public int[] getKeyRows()
hasKeyRows
returns true
.
public void setKeyRows(int[] keyRows)
hasKeyRows
returns true
.
public boolean isCompareRowHeaders()
true
if the row headers should be compared.
public void setCompareRowHeaders(boolean compareRowHeaders)
compareRowHeaders
- true
if the row headers should be compared.public int getColumnIndex(Column column)
column
- a column specification for this tablepublic int getRowIndex(Row row)
row
- a row specification for this tablepublic boolean isCompareBothByLeftRegions()
true
if data specific comparison regions should be used.setCompareBothByLeftRegions(boolean)
public void setCompareBothByLeftRegions(boolean compareBothByLeftRegions)
true
if data specific comparison regions should be used.isCompareBothByLeftRegions()
public ITestDataTableRegion[] getComparisonRegions()
null
can be returned.
Typically all cells
are compared when the table
contents are requested from a TestObject
getTestData
method call. Only when the selected data is requested will the regions default to something
other then all cells.
public void setComparisonRegions(ITestDataTableRegion[] comparisonRegions)
null
value results in no selected
regions being associated with the table.
comparisonRegions
- the new set of comparison regions to use with this table.public void addComparisonRegion(ITestDataTableRegion comparisonRegion)
comparisonRegion
- a new region to associate with the tablepublic void removeComparisonRegion(ITestDataTableRegion comparisonRegion)
comparisonRegion
- the region to remove from the comparison region set
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |