com.screenscraper.util.parsing.table

Class Table

java.lang.Object

com.screenscraper.util.parsing.table.HTMLTag

com.screenscraper.util.parsing.table.Table

public class Table
extends HTMLTag

Represents an HTML table

Version:

7.0.1a

Constructor Summary

Constructors

Constructor and Description
Table()

Method Summary

Modifier and Type	Method and Description
(package private) void	addRow(Row row)
Cell	getCell(int row, int column) Gets the cell at the specified row and column
Cell	getHeaderForCell(int row, int column) Gets the header cell for the specified row and column.
int	getNumColumns() Returns the number of columns in the table
int	getNumRows() Returns the number of rows in the table
Row	getRow(int row) Gets the row with the given row number (0 based)
java.util.List<Row>	getRows() Returns the rows of the table
static Table	parseTable(java.lang.String htmlTable) Parses the given html into a table

Methods inherited from class com.screenscraper.util.parsing.table.HTMLTag

addAttribute, getAttribute, getAttributeNames, getAttributes, hasAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

Table()

Method Detail

parseTable

@Nullable
 @RequiredVersion(value=1)
 @Contract(value="null -> null; !null -> !null")
public static Table parseTable(@Nullable
                                                                                                                        java.lang.String htmlTable)

Parses the given html into a table

Parameters:

htmlTable - The html of the table (needs the surrounding table tags to be present)

Returns:

The table as a Table object

Throws:

java.lang.IllegalArgumentException - If the html can't be parsed into a table

addRow

void addRow(@NotNull
            Row row)

getNumRows

public int getNumRows()

Returns the number of rows in the table

Returns:

The number of rows in the table

getNumColumns

public int getNumColumns()

Returns the number of columns in the table

Returns:

The number of columns in the table

getRows

@NotNull
public java.util.List<Row> getRows()

Returns the rows of the table

Returns:

The rows of the table

getRow

public Row getRow(int row)

Gets the row with the given row number (0 based)

Parameters:

row - The row offset (0 based)

Returns:

The Row

Since:

7.0.9.a

getCell

@Nullable
public Cell getCell(int row,
                               int column)

Gets the cell at the specified row and column

Parameters:

row - The index of the row to get (0 based)

column - The index of the column to get (0 based)

Returns:

The cell at the given row and column (null if no cell was defined to cover this location)

Throws:

java.lang.ArrayIndexOutOfBoundsException - If either the row or column index is outside the bounds of the table

getHeaderForCell

@Nullable
public Cell getHeaderForCell(int row,
                                        int column)

Gets the header cell for the specified row and column. This will return this cell if this cell is a header type. Also, if the header cell for this location spans from another header, this will return the span cell rather than the spanned cell

Parameters:

row - The index of the row for which to get a header cell (0 based)

column - The index of the column for which to get a header cell (0 based)

Returns:

The header cell for the given row and column (null if no header cell was defined to cover this location). This will be the cell at the given location if it is a header cell. Also, if the header cell for this location spans from another header, this will return the span cell rather than the spanned cell

Throws:

java.lang.ArrayIndexOutOfBoundsException - If either the row or column index is outside the bounds of the table