com.github.jferard.fastods.odselement

Class OdsElements

java.lang.Object

com.github.jferard.fastods.odselement.OdsElements

All Implemented Interfaces:

StylesContainer, StylesModeSetter

public class OdsElements
extends Object
implements StylesContainer

The OdsElements class is simply a facade in front of various OdsElement classes (ContentElement, StylesElement, ...). See GOF Facade pattern.

Contains method for flush and async flush:

• all add...Style methods are used to declare the styles before flushing data

Author:

Julien Férard

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	BASE_NAMESPACE_BY_PREFIX
static String	SC_SPLIT_FIX LO only: freeze cells
static String	SC_SPLIT_NORMAL LO only: do not freeze cells

Method Summary

Modifier and Type	Method and Description
void	addAutoFilter(AutoFilter autoFilter) Add an AutoFilter to a table
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) Create a new data style into styles container.
void	addEvents(ScriptEventListener... events) Add some events to the document
void	addExtraDir(String fullDirectoryPath) Add an extra dir.
void	addExtraFile(String fullPath, String mediaType, byte[] data) Add an extra file
void	addExtraObject(String fullDirectoryPath, String mediaType, String version) Add an extra object (eg. a spreadsheet)
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
void	addObserver(NamedOdsFileWriter o) The OdsElements is observable by a writer.
boolean	addPageLayoutStyle(PageLayoutStyle pageLayoutStyle) Add a page layout style
boolean	addPageStyle(PageStyle ps) Add a page style
void	addPilotTable(PilotTable pilot)
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	addTableToContent(String name, int rowCapacity, int columnCapacity) Deprecated.
boolean	addTableToContent(Table table) Add a new table to content.
static OdsElements	create(PositionUtil positionUtil, XMLUtil xmlUtil, IntegerRepresentationCache cache, DataStyles format, boolean libreOfficeMode, MetaElement metaElement, Map<String,String> additionalNamespaceByPrefix)
void	createEmptyElements(XMLUtil util, ZipUTF8Writer writer) Create empty elements for package.
Table	createTable(String name, int rowCapacity, int columnCapacity)
void	debugStyles() Activate style debugging (for flushers)
void	freezeCells(Table table, int rowCount, int colCount) Freeze cells.
void	freezeStyles() Freeze the styles: adding a new style to the container will generate an IllegalStateException
Table	getTable(int tableIndex) Return a table from an index
Table	getTable(String name) Return a table from a name
int	getTableCount()
List<Table>	getTables()
void	prepareAsync() Prepare the elements for writing.
void	saveAsync() Save the elements, the file is already open.
void	setActiveTable(Table table) Set a new active table
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
void	writeContent(XMLUtil xmlUtil, ZipUTF8Writer writer) Write the content element to a writer.
void	writeExtras(XMLUtil xmlUtil, ZipUTF8Writer writer)
void	writeMeta(XMLUtil xmlUtil, ZipUTF8Writer writer) Write the meta element to a writer.
void	writeMimeType(XMLUtil xmlUtil, ZipUTF8Writer writer) Write the mimetype element to a writer.
void	writeSettings(XMLUtil xmlUtil, ZipUTF8Writer writer) Write the settings element to a writer.
void	writeStyles(XMLUtil xmlUtil, ZipUTF8Writer writer) Write the styles element to a writer.

Methods inherited from class java.lang.Object

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

Field Detail

SC_SPLIT_NORMAL

public static final String SC_SPLIT_NORMAL

LO only: do not freeze cells

See Also:

Constant Field Values

SC_SPLIT_FIX

public static final String SC_SPLIT_FIX

LO only: freeze cells

See Also:

Constant Field Values

BASE_NAMESPACE_BY_PREFIX

public static final Map<String,String> BASE_NAMESPACE_BY_PREFIX

Method Detail

create

public static OdsElements create(PositionUtil positionUtil,
                                 XMLUtil xmlUtil,
                                 IntegerRepresentationCache cache,
                                 DataStyles format,
                                 boolean libreOfficeMode,
                                 MetaElement metaElement,
                                 Map<String,String> additionalNamespaceByPrefix)

Parameters:

positionUtil - an util for cell addresses (e.g. "A1")

xmlUtil - an XML util

cache - an util for write

format - the data styles

libreOfficeMode - try to get full compatibility with LO if true

metaElement - meta.xml representation

additionalNamespaceByPrefix - a map: prefix to NS

Returns:

a new OdsElements, with newly build elements.

addObserver

public void addObserver(NamedOdsFileWriter o)

The OdsElements is observable by a writer.

Parameters:

o - the file writer

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)

Description copied from interface: StylesContainer

Create a new data style into styles container. No duplicate style name is allowed. Must be used if the table-cell style already exists.

Specified by:

addDataStyle in interface StylesContainer

Parameters:

dataStyle - the data style to add

Returns:

true if the style was added

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)

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

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)

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

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)

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

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)

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

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)

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

createEmptyElements

public void createEmptyElements(XMLUtil util,
                                ZipUTF8Writer writer)
                         throws IOException

Create empty elements for package. Used on save or by the ImmutableElementsFlusher.

Parameters:

util - an xml util

writer - destination

Throws:

IOException - if the elements were not created.

debugStyles

public void debugStyles()

Activate style debugging (for flushers)

freezeStyles

public void freezeStyles()

Freeze the styles: adding a new style to the container will generate an IllegalStateException

addTableToContent

@Deprecated
public Table addTableToContent(String name,
                                           int rowCapacity,
                                           int columnCapacity)
                                    throws IOException

Deprecated.

Add a new table to content. The config for this table is added to the settings. If the OdsElements is observed the previous table is async flushed. If there is no previous table, meta and styles are async flushed. If there is no previous table, meta.xml, styles.xml and the preamble of content.xml are written to destination.

Parameters:

name - name of the table

rowCapacity - estimated rows

columnCapacity - estimated columns

Returns:

the table or null

Throws:

IOException - if the OdsElements is observed and there is a write exception

addTableToContent

public boolean addTableToContent(Table table)
                          throws IOException

Add a new table to content. The config for this table is added to the settings. If the OdsElements is observed the previous table is async flushed. If there is no previous table, meta and styles are async flushed. If there is no previous table, meta.xml, styles.xml and the preamble of content.xml are written to destination.

Parameters:

table - the table

Returns:

true if the table was added

Throws:

IOException - if the OdsElements is observed and there is a write exception

createTable

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

prepareAsync

public void prepareAsync()
                  throws IOException

Prepare the elements for writing. Performs an async flush.

Throws:

IOException - if the preparation fails

saveAsync

public void saveAsync()
               throws IOException

Save the elements, the file is already open. (launches async flushes)

Throws:

IOException - if the write fails

writeContent

public void writeContent(XMLUtil xmlUtil,
                         ZipUTF8Writer writer)
                  throws IOException

Write the content element to a writer.

Parameters:

xmlUtil - the xml util

writer - the writer

Throws:

IOException - if write fails

writeMeta

public void writeMeta(XMLUtil xmlUtil,
                      ZipUTF8Writer writer)
               throws IOException

Write the meta element to a writer.

Parameters:

xmlUtil - the xml util

writer - the writer

Throws:

IOException - if write fails

writeSettings

public void writeSettings(XMLUtil xmlUtil,
                          ZipUTF8Writer writer)
                   throws IOException

Write the settings element to a writer.

Parameters:

xmlUtil - the xml util

writer - the writer

Throws:

IOException - if write fails

writeStyles

public void writeStyles(XMLUtil xmlUtil,
                        ZipUTF8Writer writer)
                 throws IOException

Write the styles element to a writer.

Parameters:

xmlUtil - the xml util

writer - the writer

Throws:

IOException - if write fails

freezeCells

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

Freeze cells. See https://help.libreoffice.org/Calc/Freezing_Rows_or_Columns_as_Headers

Parameters:

table - the table to freeze

rowCount - the number of rows to freeze (e.g. 1 to freeze the first row)

colCount - the number of cols to freeze.

getTable

public Table getTable(int tableIndex)

Return a table from an index

Parameters:

tableIndex - the index

Returns:

the table

getTable

public Table getTable(String name)

Return a table from a name

Parameters:

name - the name

Returns:

the table

getTableCount

public int getTableCount()

Returns:

the table count

getTables

public List<Table> getTables()

Returns:

the list of tables

setActiveTable

public void setActiveTable(Table table)

Set a new active table

Parameters:

table - the table

setViewSetting

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

Set a view setting

Parameters:

viewId - the id of the view

item - the item name

value - the item value

addAutoFilter

public void addAutoFilter(AutoFilter autoFilter)

Add an AutoFilter to a table

Parameters:

autoFilter - the filter

addExtraFile

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

Add an extra file

Parameters:

fullPath - the name of the file in the sequence

mediaType - the MIME type

data - the content

addExtraDir

public void addExtraDir(String fullDirectoryPath)

Add an extra dir. If the directoy does not end with a slash, add it.

Parameters:

fullDirectoryPath - the path of the dir

addExtraObject

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

Add an extra object (eg. a spreadsheet)

Parameters:

fullDirectoryPath - the path of the dir

mediaType - the type of the object

version - the version

writeExtras

public void writeExtras(XMLUtil xmlUtil,
                        ZipUTF8Writer writer)
                 throws IOException

Parameters:

xmlUtil - the XML util instance.

writer - write the extra files to the archive

Throws:

IOException - if something can"t be written

writeMimeType

public void writeMimeType(XMLUtil xmlUtil,
                          ZipUTF8Writer writer)
                   throws IOException

Write the mimetype element to a writer.

Parameters:

xmlUtil - the xml util

writer - the writer

Throws:

IOException - if write fails

addEvents

public void addEvents(ScriptEventListener... events)

Add some events to the document

Parameters:

events - the events to add

addPilotTable

public void addPilotTable(PilotTable pilot)