com.github.jferard.fastods

Class OdsFactory

java.lang.Object

com.github.jferard.fastods.OdsFactory

public class OdsFactory
extends Object

An OdsFactory is the entry point for creating ODS documents.

Author:

Julien Férard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdsFactory.FileState Deprecated. use ??

Method Summary

Modifier and Type	Method and Description
OdsFactory	addNamespaceByPrefix(Map<String,String> additionalNamespaceByPrefix) Deprecated.
static OdsFactoryBuilder	builder(Logger logger, Locale locale) Create an ods factory builder
static OdsFactory	create()
static OdsFactory	create(Logger logger, Locale locale) create an ods factory
AnonymousOdsFileWriter	createWriter()
NamedOdsFileWriter	createWriter(File file) Create a new ODS file writer from a document.
NamedOdsFileWriter	createWriter(String filename) Create a new ODS file writer from a document.
OdsFileWriterAdapter	createWriterAdapter(File file) Create an adapter for a writer.
OdsFactory	dataStyles(DataStyles ds) Deprecated. use OdsFactory.builder
OdsFactory	metaElement(MetaElement metaElement) Deprecated. use OdsFactory.builder
OdsFactory	noLibreOfficeMode() Deprecated. use OdsFactory.builder

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static OdsFactoryBuilder builder(Logger logger,
                                        Locale locale)

Create an ods factory builder

Parameters:

logger - the logger

locale - the locale

Returns:

the factory builder

create

public static OdsFactory create()

Returns:

a default ods factory

create

public static OdsFactory create(Logger logger,
                                Locale locale)

create an ods factory

Parameters:

logger - the logger

locale - the locale

Returns:

the factory

dataStyles

@Deprecated
public OdsFactory dataStyles(DataStyles ds)

Deprecated. use OdsFactory.builder

Set the data styles

Parameters:

ds - the data styles

Returns:

this for fluent style

noLibreOfficeMode

@Deprecated
public OdsFactory noLibreOfficeMode()

Deprecated. use OdsFactory.builder

Disable the LibreOffice mode. The LibreOffice mode adds a style to every cell, to force LibreOffice to render the cell styles correctly. This mode is set by default, and might slow down the generation of the file.

Returns:

this for fluent style

metaElement

@Deprecated
public OdsFactory metaElement(MetaElement metaElement)

Deprecated. use OdsFactory.builder

Use a custom meta element

Parameters:

metaElement - the meta element.

Returns:

this for fluent style

addNamespaceByPrefix

@Deprecated
public OdsFactory addNamespaceByPrefix(Map<String,String> additionalNamespaceByPrefix)

Deprecated.

Use custom namespace prefixes in content element.

Parameters:

additionalNamespaceByPrefix - a map prefix to namespace

Returns:

this for fluent style

createWriter

public AnonymousOdsFileWriter createWriter()

Returns:

a new writer, but with no actual name

createWriter

public NamedOdsFileWriter createWriter(String filename)
                                throws IOException

Create a new ODS file writer from a document. Be careful: this method opens immediately a stream.

Parameters:

filename - the name of the destination file

Returns:

the ods writer

Throws:

FileNotFoundException - if the file can't be found

IOException

createWriter

public NamedOdsFileWriter createWriter(File file)
                                throws IOException

Create a new ODS file writer from a document. Be careful: this method opens immediately a stream.

Parameters:

file - the destination file

Returns:

the ods writer

Throws:

IOException - if an I/O error occurs

createWriterAdapter

public OdsFileWriterAdapter createWriterAdapter(File file)
                                         throws IOException

Create an adapter for a writer.

Parameters:

file - the file

Returns:

the adapter

Throws:

IOException - if an I/O error occurs