com.rational.test.ft.vp

Class VpUtil

java.lang.Object

com.rational.test.ft.vp.VpUtil

public class VpUtil
extends java.lang.Object

Provides a default set of utility methods that can be used to create interesting data objects. The primary usage for this class is in conjunction with vpManual verification points.

Since:

RFT1.0

Constructor Summary

Constructors

Constructor and Description
VpUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static ITestDataProperties	getTestData(java.util.Hashtable properties) Provides a default properties TestData object.
static ITestDataTree	getTestData(ITestDataTreeNode[] rootNodes) Provides a default tree TestData object.
static ITestDataList	getTestData(java.lang.Object[] list) Provides a default list TestData object.
static ITestDataTable	getTestData(java.lang.Object[][] table) Provides a default table TestData object.
static ITestDataText	getTestData(java.lang.String text) Provides a default TestDataText object.
static ITestDataList	getTestData(java.util.Vector list) Provides a default list TestData object.
static ITestDataMenu	getTestDataMenu(java.lang.String text, java.lang.String mnemonic, java.lang.String accelerator) Provides a default menu item that can be used as the node type in a tree test data object to get the destinctive menu item presentation in the tree.
static ITestDataMenu	getTestDataMenu(java.lang.String text, java.lang.String mnemonic, java.lang.String accelerator, boolean isCheckbox, boolean isRadiobutton, boolean isSelected) Provides a default menu item that can be used as the node type in a tree test data object to get the destinctive menu item presentation in the tree.
static ITestDataTableRegion	getTestDataTableRegion() Provides a comparison region that specifies all cells in the table are to be included in the comparison region.
static ITestDataTableRegion	getTestDataTableRegion(Cell cell) Provides a comparison region that specifies a single cell in the table that is to be included in the comparison region.
static ITestDataTableRegion	getTestDataTableRegion(Cell topLeft, Cell bottomRight) Provides a comparison region that specifies the block of cells in a table that are to be included in the comparison region.
static ITestDataTableRegion	getTestDataTableRegion(Column column) Provides a comparison region that specifies a single column in a table that is to be included in the comparison region.
static ITestDataTableRegion	getTestDataTableRegion(Row row) Provides a comparison region that specifies a single row in a table that is to be included in the comparison region.
static ITestDataTreeNode	getTestDataTreeNode(java.lang.Object node) Provides a default tree node object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VpUtil

public VpUtil()

Method Detail

getTestData

public static ITestDataText getTestData(java.lang.String text)

Provides a default TestDataText object. The meta properties for how the data will be compared are defaulted.

Parameters:

text - the text that the TestData object wraps.

Returns:

A TestData object that contains the supplied text.

Since:

RFT1.0

getTestData

public static ITestDataProperties getTestData(java.util.Hashtable properties)

Provides a default properties TestData object. The masking bit associated with each property is defaulted to false so that all properties are compared.

Parameters:

properties - the properties that TestData object wraps

Returns:

A properties data object that contains the supplied values.

Since:

RFT1.0

getTestData

public static ITestDataList getTestData(java.util.Vector list)

Provides a default list TestData object. The meta properties for how the data will be compared are defaulted. No elements will be considered masked from comparison in the returned list object.

Parameters:

list - the set of objects that TestData object encapsulates

Returns:

A list data object that contains the supplied set of objects.

Since:

RFT1.0

getTestData

public static ITestDataList getTestData(java.lang.Object[] list)

Provides a default list TestData object. The meta properties for how the data will be compared are defaulted. No elements will be considered masked from comparison in the returned list object.

Parameters:

list - the set of objects that TestData object encapsulates

Returns:

A list data object that contains the supplied set of objects.

Since:

RFT1.0

getTestData

public static ITestDataTable getTestData(java.lang.Object[][] table)

Provides a default table TestData object. The meta properties for how the data will be compared are defaulted. The comparison region will default to all data being compared. No row or column headers exist by default.

Parameters:

table - the objects that TestData object encapsulates

Returns:

A table data object that contains the supplied objects.

Since:

RFT1.0

getTestDataTableRegion

public static ITestDataTableRegion getTestDataTableRegion()

Provides a comparison region that specifies all cells in the table are to be included in the comparison region.

Returns:

A comprison region for all cells in the table.

Since:

RFT1.1

getTestDataTableRegion

public static ITestDataTableRegion getTestDataTableRegion(Column column)

Provides a comparison region that specifies a single column in a table that is to be included in the comparison region.

Parameters:

column - the column to be included in the comparison region

Returns:

A comprison region for a column in a table

Since:

RFT1.1

getTestDataTableRegion

public static ITestDataTableRegion getTestDataTableRegion(Row row)

Provides a comparison region that specifies a single row in a table that is to be included in the comparison region.

Parameters:

row - the row to be included in the comparison region

Returns:

A comprison region for a row in a table

Since:

RFT1.1

getTestDataTableRegion

public static ITestDataTableRegion getTestDataTableRegion(Cell cell)

Provides a comparison region that specifies a single cell in the table that is to be included in the comparison region.

Parameters:

cell - the cell to be included in the comparison region

Returns:

A comprison region for a signle cell in a table

Since:

RFT1.1

getTestDataTableRegion

public static ITestDataTableRegion getTestDataTableRegion(Cell topLeft,
                                          Cell bottomRight)

Provides a comparison region that specifies the block of cells in a table that are to be included in the comparison region.

Parameters:

topLeft - the top left cell in the block of cells in the comparison region

bottomRight - the botton right cell in the block of cells in the comparison region

Returns:

A comprison region for a block of cells in a table

Since:

RFT1.1

getTestData

public static ITestDataTree getTestData(ITestDataTreeNode[] rootNodes)

Provides a default tree TestData object. The meta properties for how the data will be compared are made defaults, with all nodes compared.

Parameters:

rootNodes - the objects that define the root nodes in the returned data tree

Returns:

A tree data object that contains the supplied objects

Since:

RFT1.0

See Also:

getTestDataTreeNode(Object)

getTestDataTreeNode

public static ITestDataTreeNode getTestDataTreeNode(java.lang.Object node)

Provides a default tree node object. The parent and children of the returned node default to null and need to be explicitly defined by the caller. Note that by defining the parent directly in the resultant object, the result is not automatically made a child of the parent node. Managing of the data hierarchy is left to the user when using this method.

Parameters:

node - the object that is encapsulated by the returned node

Returns:

A tree node that can be added to a TestDataTree object

Since:

RFT1.0

See Also:

getTestData(ITestDataTreeNode[])

getTestDataMenu

public static ITestDataMenu getTestDataMenu(java.lang.String text,
                            java.lang.String mnemonic,
                            java.lang.String accelerator,
                            boolean isCheckbox,
                            boolean isRadiobutton,
                            boolean isSelected)

Provides a default menu item that can be used as the node type in a tree test data object to get the destinctive menu item presentation in the tree. By default only menu specific properties are available on this node, however additional properties can be added to the returned node as desired. Note that ITestDataMenu extends ITestData, which supports generic properties.

Parameters:

text - the visible text on the menu item

mnemonic - the character used for keyboard access to the menu item

accelerator - the key code used to trigger the associated action

isCheckbox - true if the menu item is a checkbox menu item

isRadiobutton - true if the menu item is a RadioButton menu item

isSelected - true if the menu item state is selected or checked

Returns:

A tree node that can be added to an ITestDataTree object

Since:

RFT1.1

See Also:

getTestDataTreeNode(Object)

getTestDataMenu

public static ITestDataMenu getTestDataMenu(java.lang.String text,
                            java.lang.String mnemonic,
                            java.lang.String accelerator)

Provides a default menu item that can be used as the node type in a tree test data object to get the destinctive menu item presentation in the tree. This method is similar to getTestDataMenu. In this version of the method the state attributes all default to false.

Parameters:

text - the visible text on the menu item

mnemonic - the character used for keyboard access to the menu item

accelerator - the key code used to trigger the associated action

Returns:

A tree node that can be added to an ITestDataTree object

Since:

RFT1.1

See Also:

getTestDataTreeNode(Object)