com.github.jferard.fastods

Class NamedOdsDocument

java.lang.Object

com.github.jferard.fastods.NamedOdsDocument

All Implemented Interfaces:

OdsDocument, StylesContainer, StylesModeSetter

public class NamedOdsDocument
extends Object
implements OdsDocument, StylesContainer

An ods document with a name. The named is not stored in the NamedOdsDocument object, but the NamedOdsDocument object is injected in a NamedOdsWriter.

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
void	addAutoFilter(AutoFilter autoFilter) Add a new auto filter
void	addAutoFilter(String rangeName, Table table, int r1, int c1, int r2, int c2) Deprecated.
void	addCellStyle(TableCellStyle style, CellType... types) Add a cell style for a given data type.
TableCellStyle	addChildCellStyle(TableCellStyle style, DataStyle dataStyle) Add a child style that mixes the cell style with a data style to the container
boolean	addContentFontFaceContainerStyle(FontFaceContainerStyle objectStyle) Add a cell style to the content container and register the font face
boolean	addContentStyle(ObjectStyle objectStyle) Add an object style (style:style) to content.xml/automatic-styles
boolean	addDataStyle(DataStyle dataStyle) Add a data style to this document.
void	addEvents(ScriptEventListener... events) Add some events to the document
void	addExtraDir(String fullPath) Add an extra directory to the manifest.
void	addExtraFile(String fullPath, String mediaType, byte[] bytes) Add an extra file to the document
void	addExtraObject(String fullPath, String mediaType, String version) Add an extra object (eg. a spreadsheet) to the manifest.
boolean	addMasterPageStyle(MasterPageStyle masterPageStyle) Create a new master page style into styles container.
boolean	addNewDataStyleFromCellStyle(TableCellStyle style) Add the data style taken from a cell style
boolean	addPageLayoutStyle(PageLayoutStyle pageLayoutStyle) Add a page layout style
boolean	addPageStyle(PageStyle ps) Add a page style
void	addPilotTable(PilotTable pilot) Add a new pilot table
boolean	addStylesFontFaceContainerStyle(FontFaceContainerStyle ffcStyle) Add a cell style to the content container and register the font face
boolean	addStylesStyle(ObjectStyle objectStyle) Add an object style to styles.xml/automatic-styles
Table	addTable(String name) Add a new table to the document, the new table is set to the active table.
Table	addTable(String name, int rowCapacity, int columnCapacity) Add a new table to the document, the new table is set to the active table.
boolean	addTable(Table table) Add a new table to the document, the new table is set to the active table.
Table	createTable(String name) *You probably need addTable* Create a new table, **but do not add it to the document**.
Table	createTable(String name, int rowCapacity, int columnCapacity) *You probably need addTable* Create a new table, **but do not add it to the document**.
void	debugStyles() Enable styles debugging
void	freezeCells(Table table, int rowCount, int colCount)
void	freezeStyles() Enable styles freeze
Table	getOrAddTable(String name)
Table	getTable(int n) Get a table by index
Table	getTable(String name) Get a table by name
String	getTableName(int n) Returns the name of the table.
int	getTableNumber(String name) Search a table by name and return its number.
List<Table>	getTables()
void	prepare() Prepare the document for flush (ie write empty elements, manifest, mime type, ...)
void	save() Save the document.
boolean	setActiveTable(int tableIndex) Set the active table, this is the table that is shown if you open the file.
void	setDataStylesMode(Container.Mode mode) Set the new mode to use for data styles
void	setMasterPageStyleMode(Container.Mode mode) Set the new mode to use for master page style
void	setObjectStyleMode(Container.Mode mode) Set the new mode to use for styles in content.xml/automatic-styles, styles.xml/styles and styles.xml/automatic-styles
void	setPageLayoutStyleMode(Container.Mode mode) Set the new mode to use for page layout style
void	setPageStyleMode(Container.Mode mode) Set the new mode to use for page style
void	setViewSetting(String viewId, String item, String value) Set a view setting
int	tableCount() Gets the number of the last table.

Methods inherited from class java.lang.Object

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

Method Detail

addTable

public Table addTable(String name)
               throws IOException

Description copied from interface: OdsDocument

Add a new table to the document, the new table is set to the active table.
Use setActiveTable to override the current active table, this has no influence to the program, the active table is the first table that is shown in OpenOffice.

Specified by:

addTable in interface OdsDocument

Parameters:

name - - The name of the table to add

Returns:

the table

Throws:

IOException - if the table can't be added to document

addTable

public Table addTable(String name,
                      int rowCapacity,
                      int columnCapacity)
               throws IOException

Description copied from interface: OdsDocument

Add a new table to the document, the new table is set to the active table.
Use setActiveTable to override the current active table, this has no influence to the program, the active table is the first table that is shown in OpenOffice.

Specified by:

addTable in interface OdsDocument

Parameters:

name - the name of the table to add

rowCapacity - the initial row capacity

columnCapacity - the initial column capacity

Returns:

the table or nll if the name already exists

Throws:

IOException - if the table can't be added to document

addTable

public boolean addTable(Table table)
                 throws IOException

Description copied from interface: OdsDocument

Add a new table to the document, the new table is set to the active table.
Use setActiveTable to override the current active table, this has no influence to the program, the active table is the first table that is shown in OpenOffice.

Specified by:

addTable in interface OdsDocument

Parameters:

table - the table to add

Returns:

true if the table was added

Throws:

IOException - if the table can't be added to document

createTable

public Table createTable(String name)
                  throws IOException

Description copied from interface: OdsDocument

*You probably need addTable*

Create a new table, **but do not add it to the document**.

Specified by:

createTable in interface OdsDocument

Parameters:

name - - The name of the table to add

Returns:

the table

Throws:

IOException - if the table can't be added to document

createTable

public Table createTable(String name,
                         int rowCapacity,
                         int columnCapacity)
                  throws IOException

Description copied from interface: OdsDocument

*You probably need addTable*

Create a new table, **but do not add it to the document**.

Specified by:

createTable in interface OdsDocument

Parameters:

name - - The name of the table to add

rowCapacity - the initial row capacity

columnCapacity - the initial column capacity

Returns:

the table

Throws:

IOException - if the table can't be added to document

getTable

public Table getTable(int n)
               throws FastOdsException

Description copied from interface: OdsDocument

Get a table by index

Specified by:

getTable in interface OdsDocument

Parameters:

n - the index

Returns:

the table

Throws:

FastOdsException - if the table index is negative or ≥ number of tables

getTable

public Table getTable(String name)
               throws FastOdsException

Description copied from interface: OdsDocument

Get a table by name

Specified by:

getTable in interface OdsDocument

Parameters:

name - the name of the table

Returns:

the table

Throws:

FastOdsException - if the table does not exist.

getOrAddTable

public Table getOrAddTable(String name)
                    throws IOException

Specified by:

getOrAddTable in interface OdsDocument

Parameters:

name - the name of the table

Returns:

the table

Throws:

IOException - if the table does not exist.

getTableName

public String getTableName(int n)
                    throws FastOdsException

Description copied from interface: OdsDocument

Returns the name of the table.

Specified by:

getTableName in interface OdsDocument

Parameters:

n - The number of the table

Returns:

The name of the table

Throws:

FastOdsException - if n is negative

getTableNumber

public int getTableNumber(String name)

Description copied from interface: OdsDocument

Search a table by name and return its number.

Specified by:

getTableNumber in interface OdsDocument

Parameters:

name - The name of the table

Returns:

The number of the table or -1 if name was not found

getTables

public List<Table> getTables()

Specified by:

getTables in interface OdsDocument

Returns:

the list of tables

setActiveTable

public boolean setActiveTable(int tableIndex)

Description copied from interface: OdsDocument

Set the active table, this is the table that is shown if you open the file.

Specified by:

setActiveTable in interface OdsDocument

Parameters:

tableIndex - The table number, this table should already exist, otherwise the first table is shown

Returns:

true - The active table was set, false - tab has an illegal value

setViewSetting

public void setViewSetting(String viewId,
                           String item,
                           String value)

Description copied from interface: OdsDocument

Set a view setting

Specified by:

setViewSetting in interface OdsDocument

Parameters:

viewId - the view id

item - the item name

value - the value

tableCount

public int tableCount()

Description copied from interface: OdsDocument

Gets the number of the last table.

Specified by:

tableCount in interface OdsDocument

Returns:

The number of the last table

addAutoFilter

@Deprecated
public void addAutoFilter(String rangeName,
                                      Table table,
                                      int r1,
                                      int c1,
                                      int r2,
                                      int c2)

Deprecated.

Description copied from interface: OdsDocument

Add an autoFilter to a range address

Specified by:

addAutoFilter in interface OdsDocument

Parameters:

rangeName - the name of the range

table - the table

r1 - the top row

c1 - the left column

r2 - the bottom row

c2 - the right column

freezeCells

public void freezeCells(Table table,
                        int rowCount,
                        int colCount)

Specified by:

freezeCells in interface OdsDocument

Parameters:

table - the table

rowCount - the number of rows to freeze

colCount - the number of cols to freeze

addCellStyle

public void addCellStyle(TableCellStyle style,
                         CellType... types)

Add a cell style for a given data type. Use only if you want to flush data before the end of the document construction. Do not produce any effect if the type is Type.STRING or Type.VOID

Parameters:

style - the style

types - the types

addDataStyle

public boolean addDataStyle(DataStyle dataStyle)

Add a data style to this document. Use only if you want to flush data before the end of the document construction.

Specified by:

addDataStyle in interface StylesContainer

Parameters:

dataStyle - the data style to add to this document

Returns:

true if the style was added

addMasterPageStyle

public boolean addMasterPageStyle(MasterPageStyle masterPageStyle)

Description copied from interface: StylesContainer

Create a new master page style into styles container. No duplicate style name is allowed.

Specified by:

addMasterPageStyle in interface StylesContainer

Parameters:

masterPageStyle - the data style to add

Returns:

true if the style was created

addNewDataStyleFromCellStyle

public boolean addNewDataStyleFromCellStyle(TableCellStyle style)

Description copied from interface: StylesContainer

Add the data style taken from a cell style

Specified by:

addNewDataStyleFromCellStyle in interface StylesContainer

Parameters:

style - the cell style

Returns:

true if the style was created

addPageLayoutStyle

public boolean addPageLayoutStyle(PageLayoutStyle pageLayoutStyle)

Description copied from interface: StylesContainer

Add a page layout style

Specified by:

addPageLayoutStyle in interface StylesContainer

Parameters:

pageLayoutStyle - the style

Returns:

true if the style was created or updated

addPageStyle

public boolean addPageStyle(PageStyle ps)

Description copied from interface: StylesContainer

Add a page style

Specified by:

addPageStyle in interface StylesContainer

Parameters:

ps - the style

Returns:

true if the master page style and the style layout where added

addContentStyle

public boolean addContentStyle(ObjectStyle objectStyle)

Description copied from interface: StylesContainer

Add an object style (style:style) to content.xml/automatic-styles

Specified by:

addContentStyle in interface StylesContainer

Parameters:

objectStyle - the style

Returns:

true if the style was created or updated

addStylesStyle

public boolean addStylesStyle(ObjectStyle objectStyle)

Description copied from interface: StylesContainer

Add an object style to styles.xml/automatic-styles

Specified by:

addStylesStyle in interface StylesContainer

Parameters:

objectStyle - the style

Returns:

true if the style was created or updated

addChildCellStyle

public TableCellStyle addChildCellStyle(TableCellStyle style,
                                        DataStyle dataStyle)

Description copied from interface: StylesContainer

Add a child style that mixes the cell style with a data style to the container

Specified by:

addChildCellStyle in interface StylesContainer

Parameters:

style - the cell style

dataStyle - the data style

Returns:

the mixed cell style

addContentFontFaceContainerStyle

public boolean addContentFontFaceContainerStyle(FontFaceContainerStyle objectStyle)

Description copied from interface: StylesContainer

Add a cell style to the content container and register the font face

Specified by:

addContentFontFaceContainerStyle in interface StylesContainer

Parameters:

objectStyle - the cell style or the text style

Returns:

true if the style was created or updated

addStylesFontFaceContainerStyle

public boolean addStylesFontFaceContainerStyle(FontFaceContainerStyle ffcStyle)

Description copied from interface: StylesContainer

Add a cell style to the content container and register the font face

Specified by:

addStylesFontFaceContainerStyle in interface StylesContainer

Parameters:

ffcStyle - the cell style or the text style

Returns:

true if the style was created or updated

setDataStylesMode

public void setDataStylesMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for data styles

Specified by:

setDataStylesMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

setMasterPageStyleMode

public void setMasterPageStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for master page style

Specified by:

setMasterPageStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

setPageLayoutStyleMode

public void setPageLayoutStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for page layout style

Specified by:

setPageLayoutStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

setPageStyleMode

public void setPageStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for page style

Specified by:

setPageStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

setObjectStyleMode

public void setObjectStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for styles in content.xml/automatic-styles, styles.xml/styles and styles.xml/automatic-styles

Specified by:

setObjectStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

debugStyles

public void debugStyles()

Enable styles debugging

freezeStyles

public void freezeStyles()

Enable styles freeze

prepare

public void prepare()
             throws IOException

Prepare the document for flush (ie write empty elements, manifest, mime type, ...)

Throws:

IOException - if an element can't be written

addExtraFile

public void addExtraFile(String fullPath,
                         String mediaType,
                         byte[] bytes)

Description copied from interface: OdsDocument

Add an extra file to the document

Specified by:

addExtraFile in interface OdsDocument

Parameters:

fullPath - the path of the file in the sequence

mediaType - the MIME type of the file

bytes - the content

addExtraDir

public void addExtraDir(String fullPath)

Description copied from interface: OdsDocument

Add an extra directory to the manifest.

Specified by:

addExtraDir in interface OdsDocument

Parameters:

fullPath - the path of the dir

addExtraObject

public void addExtraObject(String fullPath,
                           String mediaType,
                           String version)

Description copied from interface: OdsDocument

Add an extra object (eg. a spreadsheet) to the manifest. Files have to be added with `AddExtraFile`.

Specified by:

addExtraObject in interface OdsDocument

Parameters:

fullPath - the path of the dir

mediaType - the type of the object

version - the version

addEvents

public void addEvents(ScriptEventListener... events)

Description copied from interface: OdsDocument

Add some events to the document

Specified by:

addEvents in interface OdsDocument

Parameters:

events - the events to add

addPilotTable

public void addPilotTable(PilotTable pilot)

Description copied from interface: OdsDocument

Add a new pilot table

Specified by:

addPilotTable in interface OdsDocument

Parameters:

pilot - the pilot table

addAutoFilter

public void addAutoFilter(AutoFilter autoFilter)

Description copied from interface: OdsDocument

Add a new auto filter

Specified by:

addAutoFilter in interface OdsDocument

Parameters:

autoFilter - the filter

save

public void save()
          throws IOException

Save the document. Note that the odsElements field has a reference to a writer.

Throws:

IOException - if the save fails