org.apache.poi.ss.usermodel
Interface Table

public interface Table

XSSF Only! High level abstraction of table in a workbook.

isStructuredReference

static final java.util.regex.Pattern isStructuredReference

Regular expression matching a Structured Reference (Table syntax) for XSSF table expressions. Public for unit tests

See Also:

Excel Structured Reference Syntax

getStartColIndex

int getStartColIndex()

Get the top-left column index relative to the sheet

Returns:

table start column index on sheet

getStartRowIndex

int getStartRowIndex()

Get the top-left row index on the sheet

Returns:

table start row index on sheet

getEndColIndex

int getEndColIndex()

Get the bottom-right column index on the sheet

Returns:

table end column index on sheet

getEndRowIndex

int getEndRowIndex()

Get the bottom-right row index

Returns:

table end row index on sheet

getName

java.lang.String getName()

Get the name of the table.

Returns:

table name

findColumnIndex

int findColumnIndex(java.lang.String columnHeader)

Returns the index of a given named column in the table (names are case insensitive in XSSF). Note this list is lazily loaded and cached for performance. Changes to the underlying table structure are not reflected in later calls unless XSSFTable.updateHeaders() is called to reset the cache.

Parameters:

columnHeader - the column header name to get the table column index of

Returns:

column index corresponding to columnHeader

getSheetName

java.lang.String getSheetName()

Returns the sheet name that the table belongs to.

isHasTotalsRow

boolean isHasTotalsRow()

Returns true iff the table has a 'Totals' row