org.jopendocument.dom
Class OOSingleXMLDocument

java.lang.Object
  org.jopendocument.dom.OOXMLDocument
      org.jopendocument.dom.OOSingleXMLDocument

public class OOSingleXMLDocument
extends OOXMLDocument

An XML document containing all of an office document, see section 2.1 of OpenDocument 1.1.

Author:

Sylvain CUAZ 24 nov. 2004

Nested Class Summary

Nested classes/interfaces inherited from class org.jopendocument.dom.OOXMLDocument

OOXMLDocument.ElementTransformer

Field Summary

Fields inherited from class org.jopendocument.dom.OOXMLDocument

NOP_ElementTransformer, TOP_ELEMENTS

Constructor Summary

OOSingleXMLDocument(org.jdom.Document content)

OOSingleXMLDocument(OOSingleXMLDocument doc)

Method Summary

boolean	add(org.jdom.Element where, int index, OOSingleXMLDocument doc)
void	add(OOSingleXMLDocument doc) Append a document.
void	add(OOSingleXMLDocument doc, boolean pageBreak) Append a document.
static OOSingleXMLDocument	createFromDocument(org.jdom.Document content, org.jdom.Document style) Create a document from a collection of subdocuments.
static OOSingleXMLDocument	createFromDocument(org.jdom.Document content, org.jdom.Document style, org.jdom.Document settings)
static OOSingleXMLDocument	createFromDocument(org.jdom.Document content, org.jdom.Document style, org.jdom.Document settings, java.util.Map<java.lang.String,?> files)
static OOSingleXMLDocument	createFromFile(java.io.File f) Create a document from a file.
protected void	detachDuplicate(org.jdom.Element elem) Detach the children of elem whose names already exist in the body.
org.jdom.Element	getBody()
void	replace(org.jdom.Element elem, OOSingleXMLDocument doc)
java.io.File	saveAs(java.io.File f) Saves this OO document to a file.

Methods inherited from class org.jopendocument.dom.OOXMLDocument

add, add, addIfNotPresent, addIfNotPresent, asString, getChild, getChild, getDescendant, getDescendant, getDocument, getNS, getVersion, getXPath, mergeAll, mergeAll, setChild

Methods inherited from class java.lang.Object

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

Constructor Detail

OOSingleXMLDocument

public OOSingleXMLDocument(org.jdom.Document content)

OOSingleXMLDocument

public OOSingleXMLDocument(OOSingleXMLDocument doc)

Method Detail

createFromDocument

public static OOSingleXMLDocument createFromDocument(org.jdom.Document content,
                                                     org.jdom.Document style)

Create a document from a collection of subdocuments.

Parameters:

content - the content.

style - the styles, can be null.

Returns:

the merged document.

createFromDocument

public static OOSingleXMLDocument createFromDocument(org.jdom.Document content,
                                                     org.jdom.Document style,
                                                     org.jdom.Document settings)

createFromDocument

public static OOSingleXMLDocument createFromDocument(org.jdom.Document content,
                                                     org.jdom.Document style,
                                                     org.jdom.Document settings,
                                                     java.util.Map<java.lang.String,?> files)

createFromFile

public static OOSingleXMLDocument createFromFile(java.io.File f)
                                          throws org.jdom.JDOMException,
                                                 java.io.IOException

Create a document from a file.

Parameters:

f - an OpenDocument package file.

Returns:

the merged file.

Throws:

org.jdom.JDOMException - if the file is not a valid OpenDocument file.

java.io.IOException - if the file can't be read.

See Also:

createFromDocument(Document, Document)

add

public void add(OOSingleXMLDocument doc)

Append a document.

Parameters:

doc - the document to add.

add

public void add(OOSingleXMLDocument doc,
                boolean pageBreak)

Append a document.

Parameters:

doc - the document to add, null means no-op.

pageBreak - whether a page break should be inserted after doc.

replace

public void replace(org.jdom.Element elem,
                    OOSingleXMLDocument doc)

add

public boolean add(org.jdom.Element where,
                   int index,
                   OOSingleXMLDocument doc)

detachDuplicate

protected final void detachDuplicate(org.jdom.Element elem)
                              throws org.jdom.JDOMException

Detach the children of elem whose names already exist in the body.

Parameters:

elem - the elem to be trimmed.

Throws:

org.jdom.JDOMException - if an error occurs.

getBody

public final org.jdom.Element getBody()

saveAs

public java.io.File saveAs(java.io.File f)
                    throws java.io.IOException

Saves this OO document to a file.

Parameters:

f - the file where this document will be saved, without extension, eg "dir/myfile".

Returns:

the actual file where it has been saved (with extension), eg "dir/myfile.odt".

Throws:

java.io.IOException - if an error occurs.