com.github.jferard.fastods

Class Table

java.lang.Object

com.github.jferard.fastods.Table

All Implemented Interfaces:

FrameContent, Tag, NamedObject, XMLConvertible

public class Table
extends Object
implements NamedObject, FrameContent

OpenDocument 9.1.2 table:table

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
void	addAutoFilter(String rangeName, int r1, int c1, int r2, int c2) Add a new auto filter
void	addObserver(NamedOdsFileWriter observer) Add an observer to this table
void	addPrintRange(int r1, int c1, int r2, int c2)
void	addShape(Shape shape) Add a shape
void	appendXMLContent(XMLUtil util, Appendable appendable) Add XML to content.xml
void	asyncFlush() Deprecated. use asyncFlushBeginTable, asyncFlushAvailableRows or asyncFlushEndTable
void	asyncFlushBeginTable() Async flush the XML
void	asyncFlushEndTable() Async flush the XML
static Table	create(ContentElement contentElement, PositionUtil positionUtil, IntegerRepresentationCache cache, XMLUtil xmlUtil, String name, int rowCapacity, int columnCapacity, StylesContainer stylesContainer, DataStyles format, boolean libreOfficeMode, ValidationsContainer validationsContainer) Create a new Table with a name and a row/column capacity
TableCellStyle	findDefaultCellStyle(int columnIndex) Find the default cell style for a column
void	flushAllAvailableRows(XMLUtil util, Appendable appendable) Open the table, flush all rows from start, but do not freeze the table
void	flushRemainingRowsFrom(XMLUtil util, Appendable appendable, int rowIndex) Flush all rows from a given position, and do freeze the table
void	flushSomeAvailableRowsFrom(XMLUtil util, Appendable appendable, int rowIndex) Flush all rows from a given position, but do not freeze the table
ConfigItemMapEntry	getConfigEntry()
String	getName() Get the name of this table.
TableRowImpl	getRow(int rowIndex) Return a row from an index
int	getRowCount()
String	getStyleName() Get the current Table Style
TableCellWalker	getWalker()
TableRowImpl	nextRow() Deprecated.
void	protect(Protection protection)
void	setAttribute(String attribute, CharSequence value) Set a custom attribute
void	setCellMerge(int rowIndex, int colIndex, int rowMerge, int columnMerge) Set a span over cells
void	setCellMerge(String address, int rowMerge, int columnMerge) Deprecated.
void	setColumnAttribute(int col, String attribute, CharSequence value) Set a custom attribute for a column
void	setColumnDefaultCellStyle(int col, TableCellStyle cellStyle)
void	setColumnStyle(int col, TableColumnStyle ts) Set the style of a column.
void	setConfigItem(String name, String type, String value) Set a config item
void	setHeaderColumnsCount(int headerColumnsCount)
void	setHeaderRowsCount(int headerRowsCount)
void	setRowsSpanned(int rowIndex, int colIndex, int n) Set a span over rows
void	setStyle(TableStyle style) Set a new TableFamilyStyle
void	updateConfigItem(ConfigElement element, String value) Set one of the settings

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Table create(ContentElement contentElement,
                           PositionUtil positionUtil,
                           IntegerRepresentationCache cache,
                           XMLUtil xmlUtil,
                           String name,
                           int rowCapacity,
                           int columnCapacity,
                           StylesContainer stylesContainer,
                           DataStyles format,
                           boolean libreOfficeMode,
                           ValidationsContainer validationsContainer)

Create a new Table with a name and a row/column capacity

Parameters:

contentElement - the content.xml representation

positionUtil - an util

cache - an util

xmlUtil - an util

name - the name of the tables

rowCapacity - the row capacity

columnCapacity - the column capacity

stylesContainer - the container for styles

format - the data styles

libreOfficeMode - try to get full compatibility with LO if true

validationsContainer - the validations container

Returns:

the table

addObserver

public void addObserver(NamedOdsFileWriter observer)

Add an observer to this table

Parameters:

observer - the observer

appendXMLContent

public void appendXMLContent(XMLUtil util,
                             Appendable appendable)
                      throws IOException

Add XML to content.xml

Specified by:

appendXMLContent in interface XMLConvertible

Parameters:

util - an util

appendable - the output

Throws:

IOException - if the XML could not be written

asyncFlush

@Deprecated
public void asyncFlush()
                            throws IOException

Deprecated. use asyncFlushBeginTable, asyncFlushAvailableRows or asyncFlushEndTable

Async flush the XML

Throws:

IOException - if an error occurs

asyncFlushBeginTable

public void asyncFlushBeginTable()
                          throws IOException

Async flush the XML

Throws:

IOException - if an error occurs

asyncFlushEndTable

public void asyncFlushEndTable()
                        throws IOException

Async flush the XML

Throws:

IOException - if an error occurs

flushAllAvailableRows

public void flushAllAvailableRows(XMLUtil util,
                                  Appendable appendable)
                           throws IOException

Open the table, flush all rows from start, but do not freeze the table

Parameters:

util - a XMLUtil instance for writing XML

appendable - where to write

Throws:

IOException - if an I/O error occurs during the flush

flushRemainingRowsFrom

public void flushRemainingRowsFrom(XMLUtil util,
                                   Appendable appendable,
                                   int rowIndex)
                            throws IOException

Flush all rows from a given position, and do freeze the table

Parameters:

util - a XMLUtil instance for writing XML

appendable - where to write

rowIndex - the first index to use.

Throws:

IOException - if an I/O error occurs during the flush

flushSomeAvailableRowsFrom

public void flushSomeAvailableRowsFrom(XMLUtil util,
                                       Appendable appendable,
                                       int rowIndex)
                                throws IOException

Flush all rows from a given position, but do not freeze the table

Parameters:

util - a XMLUtil instance for writing XML

appendable - where to write

rowIndex - the index of the row

Throws:

IOException - if an I/O error occurs during the flush

getConfigEntry

public ConfigItemMapEntry getConfigEntry()

Returns:

the config item map of this table

getRowCount

public int getRowCount()

Returns:

the number of the last row (0..)

getName

public String getName()

Get the name of this table.

Specified by:

getName in interface NamedObject

Returns:

The name of this table.

getRow

public TableRowImpl getRow(int rowIndex)
                    throws IOException

Return a row from an index

Parameters:

rowIndex - the index

Returns:

the row

Throws:

IllegalArgumentException - if the index is invalid

IOException - if the row was flushed

getStyleName

public String getStyleName()

Get the current Table Style

Returns:

The current TableStyle

nextRow

@Deprecated
public TableRowImpl nextRow()
                                 throws IOException

Deprecated.

Returns:

the next row

Throws:

IOException - if an error occurs

getWalker

public TableCellWalker getWalker()
                          throws IOException

Returns:

a CellWalker on the row

Throws:

IOException - if the first row was flushed

setCellMerge

public void setCellMerge(int rowIndex,
                         int colIndex,
                         int rowMerge,
                         int columnMerge)
                  throws IOException

Set a span over cells

Parameters:

rowIndex - the top row

colIndex - the leftmost col

rowMerge - the number of rows

columnMerge - the number of cols

Throws:

IOException - if an error occurs

setCellMerge

@Deprecated
public void setCellMerge(String address,
                                     int rowMerge,
                                     int columnMerge)
                              throws IOException,
                                     ParseException

Deprecated.

Set the merging of multiple cells to one cell.

Parameters:

address - The cell position e.g. 'A1'

rowMerge - the number of rows to merge

columnMerge - the number of cells to merge

Throws:

IOException - if the cells can't be merged

ParseException - if the address can't be parsed

setColumnStyle

public void setColumnStyle(int col,
                           TableColumnStyle ts)

Set the style of a column.

Parameters:

col - The column number

ts - The style to be used

Throws:

IllegalStateException - if the preamble was already written

IllegalArgumentException - if col has an invalid value.

setColumnAttribute

public void setColumnAttribute(int col,
                               String attribute,
                               CharSequence value)

Set a custom attribute for a column

Parameters:

col - the column

attribute - the attribute

value - the value

setColumnDefaultCellStyle

public void setColumnDefaultCellStyle(int col,
                                      TableCellStyle cellStyle)

setAttribute

public void setAttribute(String attribute,
                         CharSequence value)

Set a custom attribute

Parameters:

attribute - the attribute

value - the value

setConfigItem

public void setConfigItem(String name,
                          String type,
                          String value)

Set a config item

Parameters:

name - the item name

type - the item type

value - the item value

updateConfigItem

public void updateConfigItem(ConfigElement element,
                             String value)

Set one of the settings

Parameters:

element - the config element

value - the item value

setStyle

public void setStyle(TableStyle style)

Set a new TableFamilyStyle

Parameters:

style - The new TableStyle to be used

setRowsSpanned

public void setRowsSpanned(int rowIndex,
                           int colIndex,
                           int n)
                    throws IOException

Set a span over rows

Parameters:

rowIndex - the row index

colIndex - the col index

n - the number of rows

Throws:

IOException - if an error occurs

findDefaultCellStyle

public TableCellStyle findDefaultCellStyle(int columnIndex)

Find the default cell style for a column

Parameters:

columnIndex - the column index

Returns:

the style, never null

addAutoFilter

public void addAutoFilter(String rangeName,
                          int r1,
                          int c1,
                          int r2,
                          int c2)

Add a new auto filter

Parameters:

rangeName - the name of the range

r1 - first row of the range

c1 - first col of the range

r2 - last row

c2 - last col

addShape

public void addShape(Shape shape)

Add a shape

Parameters:

shape - the shape

protect

public void protect(Protection protection)
             throws NoSuchAlgorithmException

Parameters:

protection - the protection

Throws:

NoSuchAlgorithmException - should not happen

addPrintRange

public void addPrintRange(int r1,
                          int c1,
                          int r2,
                          int c2)

setHeaderRowsCount

public void setHeaderRowsCount(int headerRowsCount)

setHeaderColumnsCount

public void setHeaderColumnsCount(int headerColumnsCount)