com.rational.test.ft.script
Class Column

java.lang.Object   com.rational.test.ft.script.Subitem
      com.rational.test.ft.script.Column

public class Column
extends Subitem

Container class that enforces a semantic definition to a column in a table or grid-type control in the software under test. A column is defined as one of the following values:

• Column header value - The most resilient way to describe a column in a cell

• Row header + column value key pairs - The next-most resilient way to describe a column

• Column Index - The Index of a column in the table

Since:

RFT1.0

See Also:

Cell, Row

Constructor Summary

Column(Index index)

Column(int index)

Column(Name name)

Column(java.lang.Object[] keyValuePairs)

Column(java.lang.Object key, java.lang.Object value)

Column(java.lang.Object key1, java.lang.Object value1, java.lang.Object key2, java.lang.Object value2)

Column(java.lang.Object key1, java.lang.Object value1, java.lang.Object key2, java.lang.Object value2, java.lang.Object key3, java.lang.Object value3)

Column(java.lang.String columnHeader)

Column(Subitem columnSpecifier)

Method Summary

java.lang.String	getHeader() Returns the column header String.
Index	getIndex() Returns the column Index value.
java.lang.Object[]	getKeyValuePairs() Returns the column KeyValuePairs.
Name	getName() Returns the Name Subitem
Subitem	getSubitem() Returns the column header specification.
java.lang.Object	internal() For internal use only.
boolean	isHeader() Returns true if the column descriptor is a column header value.
boolean	isIndex() Returns true if the column descriptor is an Index value.
boolean	isKeyValuePairs() Returns true if the column descriptor is a KeyValuePairs value.
boolean	isName()
boolean	isSubitem() Returns true if the column descriptor is a column header value.
java.lang.String	toString() Returns a String representing this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column(java.lang.String columnHeader)

Column

public Column(Subitem columnSpecifier)

Column

public Column(java.lang.Object key,               java.lang.Object value)

Column

public Column(java.lang.Object key1,               java.lang.Object value1,               java.lang.Object key2,               java.lang.Object value2)

Column

public Column(java.lang.Object key1,               java.lang.Object value1,               java.lang.Object key2,               java.lang.Object value2,               java.lang.Object key3,               java.lang.Object value3)

Column

public Column(java.lang.Object[] keyValuePairs)

Column

public Column(Index index)

Column

public Column(int index)

Column

public Column(Name name)

Method Detail

isHeader

public boolean isHeader()

Returns true if the column descriptor is a column header value.

Since:

RFT1.0

getHeader

public java.lang.String getHeader()

Returns the column header String. A RationalTestException is thrown if isHeader is false.

Since:

RFT1.0

getName

public Name getName()

Returns the Name Subitem

Since:

8.0

isName

public boolean isName()

isSubitem

public boolean isSubitem()

Returns true if the column descriptor is a column header value.

Since:

RFT1.0

getSubitem

public Subitem getSubitem()

Returns the column header specification. A RationalTestException is thrown if isSubitem is false.

Since:

RFT1.0

isKeyValuePairs

public boolean isKeyValuePairs()

Returns true if the column descriptor is a KeyValuePairs value.

Since:

RFT1.0

getKeyValuePairs

public java.lang.Object[] getKeyValuePairs()

Returns the column KeyValuePairs. A RationalTestException is thrown if isHeader is false.

Since:

RFT1.0

isIndex

public boolean isIndex()

Returns true if the column descriptor is an Index value.

Since:

RFT1.0

getIndex

public Index getIndex()

Returns the column Index value. A RationalTestException is thrown if isHeader is false.

Since:

RFT1.0

internal

public java.lang.Object internal()

For internal use only.

Since:

RFT1.0

toString

public java.lang.String toString()

Returns a String representing this object.

Overrides:

toString in class java.lang.Object

Since:

RFT1.0