JavaTableFunctions

Last Updated:

Actions for working with JavaTable objects


[How To Read This Reference]
ActivateCellRational Robot ClassicRational RobotJ Attempts to perform a double click on a JavaTable cell.
ActivateColumnLabelRational RobotJ Double clicks on the label of the specified column.
AssignCellContainsTextRowRational Robot ClassicRational RobotJ Assigns a user-defined variable a row # based on partial matching cell values.
AssignCellTextRowRational Robot ClassicRational RobotJ Assigns a user-defined variable a row # based on matching cell values.
AssignVariableCellTextRational Robot ClassicRational RobotJ Attempts to extract a particular cell value and assign it to the provided variable name.
AssignVariableFuzzyCellTextRational Robot ClassicRational RobotJ Attempts to extract a particular cell value and assign it to the provided variable name.
CaptureFuzzyRangeToFileRational Robot ClassicRational RobotJ Saves a range of values to the specified file.
CaptureRangeToFileRational Robot ClassicRational RobotJ Saves a range of values to the specified file.
ClickCellRational Robot ClassicRational RobotJ Attempts to perform a Click on a cell in a JavaTable.
ClickColumnLabelRational RobotJ Clicks on the label of the specified column.
DoubleClickCellRational Robot ClassicRational RobotJ Attempts to perform a double click on a cell in a JavaTable.
DoubleClickColumnLabelRational RobotJ Double clicks on the label of the specified column.
RightClickCellRational Robot ClassicRational RobotJ Attempts to perform a right click on a cell in a JavaTable.
SelectCellRational Robot ClassicRational RobotJ Same as ClickCell.
SelectCellContainsTextFindRational Robot ClassicRational RobotJ Attempts to select a particular cell by finding the row based on cell values.
SelectCellTextRational Robot ClassicRational RobotJ Attempts to select a particular cell.
SelectCellTextFindRational Robot ClassicRational RobotJ Attempts to select a particular cell by finding the row based on cell values.
SelectCellTextSpecialRational RobotJ Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click.
SelectFuzzyCellTextRational Robot ClassicRational RobotJ Attempts to select a particular cell.
SelectFuzzyCellTextFindRational Robot ClassicRational RobotJ Attempts to select a particular cell by finding the row based on fuzzy cell values.
VerifyCellEditableRational RobotJ Verifies whether the specified cell is editable.
VerifyCellTextRational Robot ClassicRational RobotJ Attempts to verify a particular cell value.
VerifyCellTextContainsRational Robot ClassicRational RobotJ Attempts to verify a particular cell value.
VerifyCellTextFindRational RobotJ Attempts to verify a particular cell by finding the row based on cell values.
VerifyColumnLabelRational RobotJ Attempts to verify a particular column's label when given a column number.
VerifyFuzzyCellTextRational Robot ClassicRational RobotJ Attempts to verify a particular cell value.
VerifyFuzzyCellTextContainsRational Robot ClassicRational RobotJ Attempts to verify a particular cell value.
VerifyFuzzyCellTextFindRational RobotJ Attempts to verify a particular cell by finding the row based on fuzzy cell values.

JavaTableFunctions::ActivateCell Rational Robot ClassicRational RobotJ

Attempts to perform a double click on a JavaTable cell.

Clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

JavaTableFunctions::ActivateColumnLabel Rational RobotJ

Double clicks on the label of the specified column.

Performs a double click on the specified column number. A Y offset will be able to be set in the future.

JavaTableFunctions::AssignCellContainsTextRow Rational Robot ClassicRational RobotJ

Assigns a user-defined variable a row # based on partial matching cell values.

The cell value from the specified column in the found row is also assigned to a variable derived from the user-defined variable name.

The cell value comparisons are not case-senstive, and provided values can be substrings of the actual cell value in the table.



Fields: [ ]=Optional with Default Value
  1. Var
    The variable which gets assigned the row found.

    The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be the user-defined variable +".Value".

  2. Col
    The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

    The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.



  3. ColN
    A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

    The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.



  4. ValueN
    A Value to search for in the 'COLN' column.

    These values can be partial substrings and are not case-sensitive.

Examples:
  • T, JavaWin, JTable, AssignCellContainsTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
    Assigns the variable "Variable" the first row # satisfying the matching colN/valueN values.

    Also assigns variable "Variable.Value" the cell value found in the "Date" column at the matching row.

[How To Read This Reference]

JavaTableFunctions::AssignCellTextRow Rational Robot ClassicRational RobotJ

Assigns a user-defined variable a row # based on matching cell values.

The cell value from the specified column in the found row is also assigned to a variable derived from the user-defined variable name.

Fields: [ ]=Optional with Default Value
  1. Var
    The variable which gets assigned the row found.

    The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be this user-defined variable +".Value".

  2. Col
    The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

  3. ColN
    A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

  4. ValueN
    A Value to search for in the 'COLN' column

    These values are case-sensitive and must consititute an exact match.

Examples:
  • T, JavaWin, JTable, AssignCellTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
    Assigns the variable "Variable" the first row # satisfying the matching colN/valueN values.

    Also assigns variable "Variable.Value" the cell value found in the "Date" column at the matching row.

[How To Read This Reference]

JavaTableFunctions::AssignVariableCellText Rational Robot ClassicRational RobotJ

Attempts to extract a particular cell value and assign it to the provided variable name.

Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Fields: [ ]=Optional with Default Value
  1. VariableName
    The name of the variable to receive the property value.

    The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

  2. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

  3. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Examples:
  • T, JavaWin, JTable, AssignVariableCellText, AVariableName
    Assign the value of cell 1,1 in JTable to DDVariable ^AVariableName.


  • T, JavaWin, JTable, AssignVariableCellText, "AVariableName", 1 , 1
    Assign the value of cell 1,1 in JTable to DDVariable ^AVariableName.


  • T, JavaWin, JTable, AssignVariableCellText, "^AVariableName", 4, "Field5"
    Assign the value of cell 4, Field5 in JTable to DDVariable ^AVariableName.

    The column is determined by matching the text "Field5" to the field headers in the JTable.

  • C, SetVariableValues, ^AVariableName="NextVariableName"
    T, JavaWin, JTable, AssignVariableCellText, ^AVariableName, "ADatum", 5

    Assign the value of cell ADatum,5 in JTable to DDVariable ^NextVariableName.

    The row is determined by matching the text "ADatum" to the first cell in column 1 in the JTable that contains "ADatum".

[How To Read This Reference]

JavaTableFunctions::AssignVariableFuzzyCellText Rational Robot ClassicRational RobotJ

Attempts to extract a particular cell value and assign it to the provided variable name.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.

Fields: [ ]=Optional with Default Value
  1. VariableName
    The name of the variable to receive the property value.

    The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

  2. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

  3. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Examples:
  • T, JavaWin, JTable, AssignVariableFuzzyCellText, AVariableName
    Assign the value of cell 1,1 in JTable to DDVariable ^AVariableName.


  • T, JavaWin, JTable, AssignVariableFuzzyCellText, "AVariableName", 1 , 1
    Assign the value of cell 1,1 in JTable to DDVariable ^AVariableName.


  • T, JavaWin, JTable, AssignVariableFuzzyCellText, "^AVariableName", 4, "field5"
    Assign the value of cell 4, "Field5" in JTable to DDVariable ^AVariableName.

    The column is determined by case-insensitive comparing the text "field5" to the field headers in the JTable.

  • C, SetVariableValues, ^AVariableName="NextVariableName"
    T, JavaWin, JTable, AssignVariableFuzzyCellText, ^AVariableName, "datum", 5

    Assign the value of cell ADatum,Field5 in JTable to DDVariable ^NextVariableName.

    The row is determined by seeking the first cell in column 1 in the JTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here.

[How To Read This Reference]

JavaTableFunctions::CaptureFuzzyRangeToFile Rational Robot ClassicRational RobotJ

Saves a range of values to the specified file.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.

Fields: [ ]=Optional with Default Value
  1. FileName
    The name of the file to receive the data.

    The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
    If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
    Any specified full or relative path must already exist.


  2. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

  3. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

  4. [ Rows = ]
    The number of rows to capture.

    If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
    If the parameter is not provided, all subsequent rows from the specified starting row are captured.


  5. [ Columns = ]
    The number of columns to capture.

    If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
    If the parameter is not provided, all subsequent columns from the specified starting column are captured.


  6. [ FilterMode = ]
    (FUTURE) A file filter to use when processing the text values.


  7. [ FilterOptions = ]
    (FUTURE) Filter options to use with the file filter.


Examples:
  • T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt
    Saves the entire table into <project>\Datapool\Test\AFileName.txt


  • T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt, 1 , 1
    Saves the entire table into <project>\Datapool\Test\AFileName.txt


  • T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt, 4, "field5", 2, 5
    Saves a 2 rows by 5 columns range of cells starting at cell 4, Field5.

    The starting column is determined by fuzzy matching the text "field5" to the field headers in the JTable. The captured table values are saved into <project>\Datapool\Test\AFileName.txt

  • T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt, "datum", 5, , 2
    Saves a range of all remaining rows by 2 columns wide starting at cell "ADatum", "Field5".

    The starting row is determined by seeking the first cell in column 1 in the JTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here. No ROWS parameter was provided. Thus, all subsequest rows from the 2 columns are captured. The values are saved into <project>\Datapool\Test\AFileName.txt

[How To Read This Reference]

JavaTableFunctions::CaptureRangeToFile Rational Robot ClassicRational RobotJ

Saves a range of values to the specified file.


Fields: [ ]=Optional with Default Value
  1. FileName
    The name of the file to receive the data.

    The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
    If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
    Any specified full or relative path must already exist.


  2. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

  3. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

  4. [ Rows = ]
    The number of rows to capture.

    If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
    If the parameter is not provided, all subsequent rows from the specified starting row are captured.


  5. [ Columns = ]
    The number of columns to capture.

    If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
    If the parameter is not provided, all subsequent columns from the specified starting column are captured.


  6. [ FilterMode = ]
    (FUTURE) A file filter to use when processing the text values.


  7. [ FilterOptions = ]
    (FUTURE) Filter options to use with the file filter.


Examples:
  • T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt
    Saves the entire table into >project>\Datapool\Test\AFileName.txt


  • T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, 1 , 1
    Saves the entire table into <project>\Datapool\Test\AFileName.txt


  • T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, 4, "Field5", 2, 5
    Saves a 2 rows by 5 columns range of cells starting at cell 4, Field5.

    The starting column is determined by matching the text "Field5" to the field headers in the JTable. The values are saved into <project>\Datapool\Test\AFileName.txt

  • T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, "ADatum", 5, , 2
    Saves a range of all remaining rows by 2 columns wide starting at cell "ADatum", 5.

    The starting row is determined by matching the text "ADatum" to the first cell in column 1 in the JTable that contains "ADatum". Since no ROWS parameter was provided, all subsequest rows from the 2 columns are captured. The values are saved into <project>\Datapool\Test\AFileName.txt

[How To Read This Reference]

JavaTableFunctions::ClickCell Rational Robot ClassicRational RobotJ

Attempts to perform a Click on a cell in a JavaTable.

Clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

JavaTableFunctions::ClickColumnLabel Rational RobotJ

Clicks on the label of the specified column.

Performs a single click on the specified column number. A Y offset will be able to be set in the future.

JavaTableFunctions::DoubleClickCell Rational Robot ClassicRational RobotJ

Attempts to perform a double click on a cell in a JavaTable.

Clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

JavaTableFunctions::DoubleClickColumnLabel Rational RobotJ

Double clicks on the label of the specified column.

Performs a double click on the specified column number. A Y offset will be able to be set in the future.

JavaTableFunctions::RightClickCell Rational Robot ClassicRational RobotJ

Attempts to perform a right click on a cell in a JavaTable.

Right clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

JavaTableFunctions::SelectCell Rational Robot ClassicRational RobotJ

Same as ClickCell.

Clicks on a particular row/column of the table. The default location is Row=1, Col=1 unless either parameter is specified otherwise.

JavaTableFunctions::SelectCellContainsTextFind Rational Robot ClassicRational RobotJ

Attempts to select a particular cell by finding the row based on cell values.

This is the same as SelectFuzzyCellTextFind.
The row # for the cell is also assigned to a user-defined variable. The parameter values are not case-sensitive, and can be substrings of the actual table values.


Fields: [ ]=Optional with Default Value
  1. Var
    The variable which gets assigned the row found.

    The variable which gets assigned the row found. If not found then it will get a zero length string

  2. Col
    The 1-based cell column # or header value, identifying the column for the select.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

    These comparisons are not case-sensitive and can be substrings of the actual table text.



  3. ColN
    A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

    These comparisons are not case-sensitive and can be substrings of the actual table text.



  4. ValueN
    A Value to search for in the 'COLN' column

    The values are not case-sensitive and can be substrings of the actual table text.

Examples:
  • T, JavaWin, JTable, SelectCellContainsTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"
    Selects the cell in the first row matching the colN/valueN values.

    Selects the "Date" cell in the row matching the colN/valueN values: "Time"/"09:58 AM", "Change"/"Change #2", "Revision"/"2". The variable 'Variable' will be assigned the matching row number.

    These comparisons are not case-sensitive and can be substrings of the actual table text.



[How To Read This Reference]

JavaTableFunctions::SelectCellText Rational Robot ClassicRational RobotJ

Attempts to select a particular cell.


JavaTableFunctions::SelectCellTextFind Rational Robot ClassicRational RobotJ

Attempts to select a particular cell by finding the row based on cell values.

The row # for the cell is also assigned to a user-defined variable.

JavaTableFunctions::SelectCellTextSpecial Rational RobotJ

Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click.

Special cell selection which can be used to select multiple rows.

JavaTableFunctions::SelectFuzzyCellText Rational Robot ClassicRational RobotJ

Attempts to select a particular cell.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.

Fields: [ ]=Optional with Default Value
  1. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

  2. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Examples:
  • T, JavaWin, JTable, SelectFuzzyCellText
    Selects cell 1,1 in JTable.

    Default row and column indices substituted for missing parameters.

  • T, JavaWin, JTable, SelectFuzzyCellText, 1 , 1
    Selects cell 1,1 in JTable.


  • T, JavaWin, JTable, SelectFuzzyCellText, 4, "field5"
    Selects cell 4, "Field5" in JTable.

    The column is determined by case-insensitive comparing the text "field5" to the field headers in the JTable.

  • T, JavaWin, JTable, SelectFuzzyCellText, "datum", 5
    Selects cell ADatum,Field5 in JTable.

    The row is determined by seeking the first cell in column 1 in the JTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here.

[How To Read This Reference]

JavaTableFunctions::SelectFuzzyCellTextFind Rational Robot ClassicRational RobotJ

Attempts to select a particular cell by finding the row based on fuzzy cell values.

This is the same as SelectCellContainsTextFind.
"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified column/cell text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.


JavaTableFunctions::VerifyCellEditable Rational RobotJ

Verifies whether the specified cell is editable.

Invokes the "editCellAt" method on a specific cell. The method returns a boolean which is used for the verification.

JavaTableFunctions::VerifyCellText Rational Robot ClassicRational RobotJ

Attempts to verify a particular cell value.


JavaTableFunctions::VerifyCellTextContains Rational Robot ClassicRational RobotJ

Attempts to verify a particular cell value.

The value comparison is NOT case-sensitive and can be a substring.

Fields: [ ]=Optional with Default Value
  1. BenchValue
    The expected value for the specified cell.

    The value can be a substring of the full expected value and is NOT case-sensitive.

  2. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

  3. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Examples:
  • T, JavaWin, JTable, VerifyCellTextContains, FirstCellValue
    Matches the "FirstCellValue" value of cell 1,1 in JTable to bench text "FirstCellValue".

    In this case, they happen to be an exact match. Default row and column indices are used for missing parameters.

  • T, JavaWin, JTable, VerifyCellTextContains, "firstcell", 1 , 1
    Matches the "FirstCellValue" value of cell 1,1 in JTable to bench text "firstcell".

    "firstcell" is a valid substring match since it is not case-sensitive.

  • T, JavaWin, JTable, VerifyCellTextContains, "bench", 4, "Field5"
    Matches the "BenchValue" value of cell 4, Field5 in JTable to bench text "bench".

    "bench" is a valid substring match since it is not case-sensitive.
    The column is determined by matching the text "Field5" to the field headers in the JTable.


  • T, JavaWin, JTable, VerifyCellTextContains, "bench", "ADatum", 5
    Matches the "BenchValue" value of cell ADatum,5 in JTable to bench text "bench".

    "bench" is a valid substring match since it is not case-sensitive.
    The row is determined by matching the text "ADatum" to the first cell in column 1 in the JTable that contains "ADatum".


[How To Read This Reference]

JavaTableFunctions::VerifyCellTextFind Rational RobotJ

Attempts to verify a particular cell by finding the row based on cell values.


JavaTableFunctions::VerifyColumnLabel Rational RobotJ

Attempts to verify a particular column's label when given a column number.

Verifies a column label when given the column number. It currently does NOT work with columns with multi-line names.

JavaTableFunctions::VerifyFuzzyCellText Rational Robot ClassicRational RobotJ

Attempts to verify a particular cell value.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.
The Benchmark must be exact, however.


Fields: [ ]=Optional with Default Value
  1. BenchValue
    The case-sensitive expected value for the specified cell.


  2. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

  3. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Examples:
  • T, JavaWin, JTable, VerifyFuzzyCellText, FirstCellValue
    Compares the value of cell 1,1 in JTable to bench Text "FirstCellValue".

    Default row and column indices substituted for missing parameters.

  • T, JavaWin, JTable, VerifyFuzzyCellText, "FirstCellValue", 1 , 1
    Compares the value of cell 1,1 in JTable to bench text "FirstCellValue".


  • T, JavaWin, JTable, VerifyFuzzyCellText, ABenchValue, 4, "field5"
    Compares the value of cell 4, "Field5" in JTable to bench text "ABenchValue".

    The column is determined by case-insensitive comparing the text "field5" to the field headers in the JTable.

  • T, JavaWin, JTable, VerifyFuzzyCellText, ^ABenchValue, "datum", 5
    Compares the value of cell ADatum,Field5 in JTable to bench text in variable ^ABenchValue.

    The row is determined by seeking the first cell in column 1 in the JTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here.

[How To Read This Reference]

JavaTableFunctions::VerifyFuzzyCellTextContains Rational Robot ClassicRational RobotJ

Attempts to verify a particular cell value.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.
The Benchmark comparison is NOT case-sensitive and can be a substring.


Fields: [ ]=Optional with Default Value
  1. BenchValue
    The expected value for the specified cell.

    The value can be a substring of the full expected value and is NOT case-sensitive.

  2. [ Row = 1 ]
    The 1-based cell row # in the row/col specification or a unique row value in column 1.

    The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

  3. [ Col = 1 ]
    The 1-based cell column # in the row/col specification or column header text.

    The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Examples:
  • T, JavaWin, JTable, VerifyFuzzyCellTextContains, FirstCellValue
    Matches the "FirstCellValue" value of cell 1,1 in JTable to bench text "FirstCellValue".

    Default row and column indices substituted for missing parameters.
    This also happens to be an exact text match.


  • T, JavaWin, JTable, VerifyFuzzyCellTextContains, "firstcell", 1 , 1
    Matches the "FirstCellValue" value of cell 1,1 in JTable to bench text "firstcell".

    "firstcell" is a matching substring of the retrieved cell value.

  • T, JavaWin, JTable, VerifyFuzzyCellTextContains, bench, 4, "field5"
    Matches the "ABenchValue" value of cell 4, "Field5" in JTable to bench text "bench".

    The column is determined by case-insensitive comparing the text "field5" to the field headers in the JTable. "bench" is a matching substring of the retrieved cell value.

  • T, JavaWin, JTable, VerifyFuzzyCellText, bench, "datum", 5
    Matches the "ABenchValue" value of cell ADatum,Field5 in JTable to bench text "bench".

    The row is determined by seeking the first cell in column 1 in the JTable that contains substring "datum". The "5" also shows up as a substring match to the column header "Field5". So be cautious, here.
    "bench" is a matching substring of the retrieved cell value.


[How To Read This Reference]

JavaTableFunctions::VerifyFuzzyCellTextFind Rational RobotJ

Attempts to verify a particular cell by finding the row based on fuzzy cell values.

"Fuzzy" matches come into play when using header field text or column1 row text to specify row and column identities. The specified column/cell text does NOT have to be an exact match--it is NOT case-sensitive and can be just a substring of the desired value in the table.

Fields: [ ]=Optional with Default Value
  1. BenchValue
    The case-sensitive expected value for the specified cell.


  2. Var
    The variable which gets assigned the row found.

    The variable which gets assigned the row found. If not found then it will get a zero length string

  3. Col
    The 1-based cell column # in the row/col specification or fuzzy column header text.

    The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

  4. ColN
    A 1-based cell column # in the row/col specification or fuzzy column header text.

    The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

  5. ValueN
    A Value to search for in a cell under the 'ColN' column

    A Value to search for in a cell under the 'ColN' column

Examples:
  • T, JavaWin, JTable, VerifyFuzzyCellTextFind, "10/09/2003", Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"
    Verifies the cell in the row matching the colN/valueN values.

    Verifies the "Da" cell in the row fuzzy-matching the colN/valueN values: "Ti"/"09:58 AM", "Cha"/"Change #2", "Rev"/"2" is equal "10/09/2003". The variable 'Variable' will be assigned the matching row number.

[How To Read This Reference]