Package io.keikai.model.impl

Class TableImpl

java.lang.Object

io.keikai.model.impl.AbstractTableAdv

io.keikai.model.impl.TableImpl

All Implemented Interfaces:

LinkedModelObject, STable, Serializable, Table

public class TableImpl
extends AbstractTableAdv
implements LinkedModelObject

Since:

3.8.0

Author:

henri

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableImpl.DummyTable

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.Table

isStructuredReference

Constructor Summary

Constructors

Constructor	Description
TableImpl(AbstractBookAdv book, String name, String displayName, SheetRegion region, int headerRowCount, int totalsRowCount, STableStyleInfo info)
TableImpl(AbstractBookAdv book, String name, String displayName, SheetRegion region, int headerRowCount, int totalsRowCount, STableStyleInfo info, boolean totalsRowShown)

Method Summary

Modifier and Type	Method	Description
void	addColumn(STableColumn column)
void	checkOrphan()
boolean	contains(CellReference cell)	checks if the given cell is part of the table.
SAutoFilter	createAutoFilter()	Creates a new auto filter for this table the old one will be drop directly.
void	deleteAutoFilter()	Delete current autofilter if it has
void	deleteCols(int col1, int col2)
void	deleteRows(int row1, int row2)
void	destroy()	Destroy / release this model object, for example all the dependency, parent linking.
void	enableAutoFilter(boolean enable)
int	findColumnIndex(String columnHeader)	Returns the index of a given named column in the table (names are case insensitive in XSSF).
SheetRegion	getAllRegion()
SAutoFilter	getAutoFilter()	Gets the auto filter information if there is.
SBook	getBook()
SCellStyle	getCellStyle(int row, int col)
STableColumn	getColumnAt(int colIdx)
List<STableColumn>	getColumns()
SheetRegion	getColumnsRegion(String columnName1, String columnName2)
SheetRegion	getDataRegion()
String	getDisplayName()
int	getEndColIndex()	Get the bottom-right column index on the sheet
int	getEndRowIndex()	Get the bottom-right row index
int	getHeaderRowCount()
SheetRegion	getHeadersRegion()
SheetRegion	getItemRegion(TablePtg.Item item, int rowIdx)
String	getName()	Get the name of the table.
String	getSheetName()	Returns the sheet name that the table belongs to.
int	getStartColIndex()	Get the top-left column index relative to the sheet
int	getStartRowIndex()	Get the top-left row index on the sheet
TableStyleInfo	getStyle()
String	getStyleName()
STableStyleInfo	getTableStyleInfo()
SheetRegion	getThisRowRegion(int rowIdx)
SheetRegion	getTotalsRegion()
int	getTotalsRowCount()
void	insertCols(int col1, int col2, boolean insertLeft)
void	insertRows(int row1, int row2)
boolean	isHasTotalsRow()	Note: This is misleading.
void	refreshFilter()
void	refreshStyle()
void	setDisplayName(String name)
void	setHeaderRowCount(int count)
void	setName(String newname)
void	setTableStyle(STableStyleInfo style)
void	setTotalsRowCount(int count)
boolean	shiftCols(int diff)
boolean	shiftRows(int diff)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.ss.usermodel.Table

contains

Constructor Detail

TableImpl

public TableImpl(AbstractBookAdv book,
                 String name,
                 String displayName,
                 SheetRegion region,
                 int headerRowCount,
                 int totalsRowCount,
                 STableStyleInfo info)

TableImpl

public TableImpl(AbstractBookAdv book,
                 String name,
                 String displayName,
                 SheetRegion region,
                 int headerRowCount,
                 int totalsRowCount,
                 STableStyleInfo info,
                 boolean totalsRowShown)

Method Detail

getBook

public SBook getBook()

Specified by:

getBook in interface STable

getColumns

public List<STableColumn> getColumns()

Specified by:

getColumns in interface STable

addColumn

public void addColumn(STableColumn column)

Specified by:

addColumn in interface STable

getTableStyleInfo

public STableStyleInfo getTableStyleInfo()

Specified by:

getTableStyleInfo in interface STable

setTableStyle

public void setTableStyle(STableStyleInfo style)

getTotalsRowCount

public int getTotalsRowCount()

Specified by:

getTotalsRowCount in interface STable

Specified by:

getTotalsRowCount in interface Table

Returns:

0 for no totals rows, 1 for totals row shown. Values > 1 are not currently used by Excel up through 2016, and the OOXML spec doesn't define how they would be implemented.

getHeaderRowCount

public int getHeaderRowCount()

Specified by:

getHeaderRowCount in interface STable

Specified by:

getHeaderRowCount in interface Table

Returns:

0 for no header rows, 1 for table headers shown. Values > 1 might be used by Excel for pivot tables?

setTotalsRowCount

public void setTotalsRowCount(int count)

Specified by:

setTotalsRowCount in interface STable

setHeaderRowCount

public void setHeaderRowCount(int count)

Specified by:

setHeaderRowCount in interface STable

setName

public void setName(String newname)

Specified by:

setName in interface STable

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface STable

setDisplayName

public void setDisplayName(String name)

Specified by:

setDisplayName in interface STable

getDataRegion

public SheetRegion getDataRegion()

Specified by:

getDataRegion in interface STable

getColumnsRegion

public SheetRegion getColumnsRegion(String columnName1,
                                    String columnName2)

Specified by:

getColumnsRegion in interface STable

getHeadersRegion

public SheetRegion getHeadersRegion()

Specified by:

getHeadersRegion in interface STable

getTotalsRegion

public SheetRegion getTotalsRegion()

Specified by:

getTotalsRegion in interface STable

getThisRowRegion

public SheetRegion getThisRowRegion(int rowIdx)

Specified by:

getThisRowRegion in interface STable

getItemRegion

public SheetRegion getItemRegion(TablePtg.Item item,
                                 int rowIdx)

Specified by:

getItemRegion in interface STable

destroy

public void destroy()

Description copied from interface: LinkedModelObject

Destroy / release this model object, for example all the dependency, parent linking. this method has to be called before remove this linking from parent object

Specified by:

destroy in interface LinkedModelObject

checkOrphan

public void checkOrphan()

Specified by:

checkOrphan in interface LinkedModelObject

getColumnAt

public STableColumn getColumnAt(int colIdx)

Specified by:

getColumnAt in interface STable

getCellStyle

public SCellStyle getCellStyle(int row,
                               int col)

Specified by:

getCellStyle in class AbstractTableAdv

deleteRows

public void deleteRows(int row1,
                       int row2)

Specified by:

deleteRows in class AbstractTableAdv

deleteCols

public void deleteCols(int col1,
                       int col2)

Specified by:

deleteCols in class AbstractTableAdv

shiftCols

public boolean shiftCols(int diff)

Specified by:

shiftCols in class AbstractTableAdv

shiftRows

public boolean shiftRows(int diff)

Specified by:

shiftRows in class AbstractTableAdv

insertRows

public void insertRows(int row1,
                       int row2)

Specified by:

insertRows in class AbstractTableAdv

insertCols

public void insertCols(int col1,
                       int col2,
                       boolean insertLeft)

Specified by:

insertCols in class AbstractTableAdv

enableAutoFilter

public void enableAutoFilter(boolean enable)

Specified by:

enableAutoFilter in interface STable

getAutoFilter

public SAutoFilter getAutoFilter()

Description copied from interface: STable

Gets the auto filter information if there is.

Specified by:

getAutoFilter in interface STable

Returns:

the auto filter, or null if not found

createAutoFilter

public SAutoFilter createAutoFilter()

Description copied from interface: STable

Creates a new auto filter for this table the old one will be drop directly.

Specified by:

createAutoFilter in interface STable

Returns:

the new auto filter.

deleteAutoFilter

public void deleteAutoFilter()

Description copied from interface: STable

Delete current autofilter if it has

Specified by:

deleteAutoFilter in interface STable

refreshFilter

public void refreshFilter()

Specified by:

refreshFilter in class AbstractTableAdv

refreshStyle

public void refreshStyle()

Specified by:

refreshStyle in class AbstractTableAdv

getStyle

public TableStyleInfo getStyle()

Specified by:

getStyle in interface Table

Returns:

TableStyleInfo for this instance

contains

public boolean contains(CellReference cell)

Description copied from interface: Table

checks if the given cell is part of the table. Includes checking that they are on the same sheet.

Specified by:

contains in interface Table

Parameters:

cell - reference to a possibly undefined cell location

Returns:

true if the table and cell are on the same sheet and the cell is within the table range.

getAllRegion

public SheetRegion getAllRegion()

Specified by:

getAllRegion in interface STable

getStartColIndex

public int getStartColIndex()

Description copied from interface: Table

Get the top-left column index relative to the sheet

Specified by:

getStartColIndex in interface Table

Returns:

table start column index on sheet

getStartRowIndex

public int getStartRowIndex()

Description copied from interface: Table

Get the top-left row index on the sheet

Specified by:

getStartRowIndex in interface Table

Returns:

table start row index on sheet

getEndColIndex

public int getEndColIndex()

Description copied from interface: Table

Get the bottom-right column index on the sheet

Specified by:

getEndColIndex in interface Table

Returns:

table end column index on sheet

getEndRowIndex

public int getEndRowIndex()

Description copied from interface: Table

Get the bottom-right row index

Specified by:

getEndRowIndex in interface Table

Returns:

table end row index on sheet

getName

public String getName()

Description copied from interface: Table

Get the name of the table.

Specified by:

getName in interface STable

Specified by:

getName in interface Table

Returns:

table name

getStyleName

public String getStyleName()

Specified by:

getStyleName in interface Table

Returns:

name of the table style, if there is one. May be a built-in name or user-defined.

findColumnIndex

public int findColumnIndex(String columnHeader)

Description copied from interface: Table

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.

Specified by:

findColumnIndex in interface Table

Parameters:

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

Returns:

column index corresponding to columnHeader

getSheetName

public String getSheetName()

Description copied from interface: Table

Returns the sheet name that the table belongs to.

Specified by:

getSheetName in interface Table

Returns:

sheet name

isHasTotalsRow

public boolean isHasTotalsRow()

Description copied from interface: Table

Note: This is misleading. The OOXML spec indicates this is true if the totals row has ever been shown, not whether or not it is currently displayed. Use Table.getTotalsRowCount() > 0 to decide whether or not the totals row is visible.

Specified by:

isHasTotalsRow in interface Table

Returns:

true if a totals row has ever been shown for this table

See Also:

Table.getTotalsRowCount()