com.jauntium

Class Table

java.lang.Object

com.jauntium.Table

public class Table
extends Object

This class presents utility methods for accessing data within an HTML table. The data model of the Table object treats the HTML table as a simple grid of row and columns. Any merged cells in the HTML table (ie using colspan or rowspan) are automatically 'unmerged', and the single value previously occupying the merged cell is copied into each of the unmerged cells.

Author:

Tom Cervenka (tom.cervenka@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
Element	tableElement

Constructor Summary

Constructors

Constructor and Description
Table(Element tableElement) Constructs a table component from the specified table element.

Method Summary

Modifier and Type	Method and Description
Element	getCell(int colIndex, int rowIndex) Returns the td/th element that exists at the intersection point of the specified column index and the row index.
Element	getCell(String x_regex, String y_regex) Returns the td/th element that exists at the intersection point of the first column containing text that matches the specified x_regex and the first row containing text that matches the specified y_regex.
int[]	getCellCoord(String regex) Returns the x,y coordinate (colIndex, rowIndex) of the first cell who's visible text matches the specified regular expression.
Element	getTableElement() Returns the table element for this Table.
List<String>	getTextFromColumn(int colIndex) Returns a List containing the visible text of the cells in the specified column index; text values are obtained using Element.getText() and are trimmed of whitespace.
List<String>	getTextFromColumn(String regex) Returns a List containing the visible text of the cells from the target column, where the target column is the first one having a cell who's visible text matches the specified (case-insensitive) regex (using Matcher.matches); returned text values are obtained using Element.getText() and are trimmed of whitespace;
Map<String,String>	getTextFromColumns(int colIndexOfKeys, int colIndexOfValues) Extracts text data from two columns and returns a Map; the keys are the visible text obtained from the cells in the specified column Index and the values are the visible text obtained from cells in the specified column index; text values for both the keys and values are extracted using Element.getText() and are trimmed of whitespace; duplicate keys are overwritten.
List<String>	getTextFromRow(int rowIndex) Returns a List containing the visible text of the cells from the row specified by the rowInex, where indexing begins at 0; text values are obtained using Element.getText() and are trimmed of whitespace;
List<String>	getTextFromRow(String regex) Returns a List containing the visible text of the cells from the target row, where the target row is the first one having a cell who's visible text matches the specified (case-insensitive) regex (using Matcher.matches); returned text values are obtained using Element.getText() and are trimmed of whitespace;
String	toString() Returns the outerHTML of the table Element.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

tableElement

public Element tableElement

Constructor Detail

Table

public Table(Element tableElement)

Constructs a table component from the specified table element.

Method Detail

getTableElement

public Element getTableElement()

Returns the table element for this Table.

getCellCoord

public int[] getCellCoord(String regex)

Returns the x,y coordinate (colIndex, rowIndex) of the first cell who's visible text matches the specified regular expression.

Parameters:

regex - the regular expression which is used to match against text extracted from cells using Element.getText(), and evaluated in a case-insensitive manner (using Matcher.matches()).

getTextFromColumn

public List<String> getTextFromColumn(int colIndex)

Returns a List containing the visible text of the cells in the specified column index; text values are obtained using Element.getText() and are trimmed of whitespace.

Parameters:

colIndex - the colum index, where the first column has index 0.

getTextFromColumn

public List<String> getTextFromColumn(String regex)
                               throws NotFound

Returns a List containing the visible text of the cells from the target column, where the target column is the first one having a cell who's visible text matches the specified (case-insensitive) regex (using Matcher.matches); returned text values are obtained using Element.getText() and are trimmed of whitespace;

Parameters:

regex - a regular expression matching the visible text of a td/th element denoting the target row.

Throws:

NotFound

getTextFromColumns

public Map<String,String> getTextFromColumns(int colIndexOfKeys,
                                             int colIndexOfValues)

Extracts text data from two columns and returns a Map; the keys are the visible text obtained from the cells in the specified column Index and the values are the visible text obtained from cells in the specified column index; text values for both the keys and values are extracted using Element.getText() and are trimmed of whitespace; duplicate keys are overwritten.

Parameters:

colIndexOfKeys - the index of the column to use as keys in the Map, where the first column has index 0.

colIndexOfValues - the index of the column to use as values in the Map, where the first column has index 0.

getTextFromRow

public List<String> getTextFromRow(int rowIndex)

Returns a List containing the visible text of the cells from the row specified by the rowInex, where indexing begins at 0; text values are obtained using Element.getText() and are trimmed of whitespace;

Parameters:

rowIndex - the row index, where the first column has index 0.

getTextFromRow

public List<String> getTextFromRow(String regex)
                            throws NotFound

Returns a List containing the visible text of the cells from the target row, where the target row is the first one having a cell who's visible text matches the specified (case-insensitive) regex (using Matcher.matches); returned text values are obtained using Element.getText() and are trimmed of whitespace;

Parameters:

regex - a regular expression matching the visible text of a td/th element denoting the target row.

Throws:

NotFound

getCell

public Element getCell(int colIndex,
                       int rowIndex)
                throws NotFound

Returns the td/th element that exists at the intersection point of the specified column index and the row index.

Parameters:

colIndex - the column index, where the first column has index 0.

rowIndex - the row index, where the first row has index 0.

Throws:

NotFound

getCell

public Element getCell(String x_regex,
                       String y_regex)
                throws NotFound

Returns the td/th element that exists at the intersection point of the first column containing text that matches the specified x_regex and the first row containing text that matches the specified y_regex.

Parameters:

x_regex - a regular expression matching text in the target column, evaluated in a case-insensitive manner.

y_regex - a regular expression matching text in the target row, evaluated in a case-insensitive manner

Throws:

NotFound

toString

public String toString()

Returns the outerHTML of the table Element.

Overrides:

toString in class Object