Open topic with navigation

com.hp.lft.sdk.web

## Class ColumnToSearch

Note: Supported in LeanFT versions 14.51 and later.

- java.lang.Object
- - com.hp.lft.sdk.web.ColumnToSearch

-     public class ColumnToSearch
      extends Object

  Class defining the table column in which to search.
  Usage example:
  ColumnToSearch columnToSearch = ColumnToSearch.byIndex(5);
  ColumnToSearch columnToSearch = ColumnToSearch.byHeader("header2", 1);

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected String` | `columnHeader`
    `protected Integer` | `columnHeaderOccurrence`
    `protected Integer` | `columnIndex`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `ColumnToSearch()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static ColumnToSearch` | `byHeader(String columnHeader)` Returns the object that specifies the table column in which to search
    `static ColumnToSearch` | `byHeader(String columnHeader, int columnHeaderOccurrence)` Returns the object that specifies the table column in which to search
    `static ColumnToSearch` | `byIndex(int columnIndex)` Returns the object that specifies the table column in which to search.

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### columnHeader

          protected String columnHeader

    - #### columnIndex

          protected Integer columnIndex

    - #### columnHeaderOccurrence

          protected Integer columnHeaderOccurrence

  - ### Constructor Detail

    - #### ColumnToSearch

          protected ColumnToSearch()

  - ### Method Detail

    - #### byIndex

          public static ColumnToSearch byIndex(int columnIndex)

      Returns the object that specifies the table column in which to search.
      Parameters:
        `columnIndex` - 0-based column index.
      Returns:
        the object that specifies the table column in which to search

    - #### byHeader

          public static ColumnToSearch byHeader(String columnHeader)

      Returns the object that specifies the table column in which to search
      Parameters:
        `columnHeader` - the column's name.
      Returns:
        the object that specifies the table column in which to search

    - #### byHeader

          public static ColumnToSearch byHeader(String columnHeader,
                                int columnHeaderOccurrence)

      Returns the object that specifies the table column in which to search
      Parameters:
        `columnHeader` - the column's name.
        `columnHeaderOccurrence` - 0-based ordinal number of the column name's occurrence if the table has multiple columns with the same name.
      Returns:
        the object that specifies the table column in which to search.