|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object writer2latex.xmerge.OfficeDocument
public class OfficeDocument
An implementation of Document
for
StarOffice documents.
Field Summary |
---|
Constructor Summary | |
---|---|
OfficeDocument(java.lang.String name)
Default constructor. |
|
OfficeDocument(java.lang.String name,
boolean namespaceAware,
boolean validating)
Constructor with arguments to set namespaceAware
and validating flags. |
Method Summary | |
---|---|
void |
addEmbeddedObject(EmbeddedObject embObj)
Adds a new embedded object to the document. |
org.w3c.dom.Document |
getContentDOM()
Return a DOM Document object of the content.xml
file. |
protected java.lang.String |
getDocumentMimeType()
Method to return the MIME type of the document. |
EmbeddedObject |
getEmbeddedObject(java.lang.String name)
Returns the embedded object corresponding to the name provided. |
java.util.Iterator |
getEmbeddedObjects()
Returns all the embedded objects (graphics, formulae, etc.) present in this document. |
protected java.lang.String |
getFileExtension()
Returns the file extension for this type of Document . |
java.lang.String |
getFileName()
Return the file name of the Document , possibly
with the standard extension. |
org.w3c.dom.Document |
getMetaDOM()
Return a DOM Document object of the meta.xml
file. |
java.lang.String |
getName()
Return the name of the Document . |
protected java.lang.String |
getOfficeClassAttribute()
Return the office:class attribute value. |
org.w3c.dom.Document |
getSettingsDOM()
Return a DOM Document object of the settings.xml
file. |
org.w3c.dom.Document |
getStyleDOM()
Return a DOM Document object of the style.xml file. |
void |
initContentDOM()
Initializes a new DOM Document with the content
containing minimum OpenOffice XML tags. |
void |
initSettingsDOM()
Initializes a new DOM Document with the content
containing minimum OpenOffice XML tags. |
void |
initStyleDOM()
Initializes a new DOM Document with styles containing minimum OpenOffice XML tags. |
boolean |
isPackageFormat()
Package or flat format? |
void |
read(java.io.InputStream is)
Read the Office Document from the given
InputStream . |
void |
read(java.io.InputStream is,
boolean isZip)
Read the Office Document from the given
InputStream . |
void |
setContentDOM(org.w3c.dom.Node newDom)
Sets the content tree of the document. |
void |
setMetaDOM(org.w3c.dom.Node newDom)
Sets the meta tree of the document. |
void |
setSettingsDOM(org.w3c.dom.Node newDom)
Sets the settings tree of the document. |
void |
setStyleDOM(org.w3c.dom.Node newDom)
Sets the style tree of the document. |
void |
write(java.io.OutputStream os)
Write out Office ZIP file format. |
void |
write(java.io.OutputStream os,
boolean isZip)
Write out Office ZIP file format. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OfficeDocument(java.lang.String name)
name
- Document
name.public OfficeDocument(java.lang.String name, boolean namespaceAware, boolean validating)
namespaceAware
and validating
flags.
name
- Document
name (may or may not
contain extension).namespaceAware
- Value for namespaceAware
flag.validating
- Value for validating
flag.Method Detail |
---|
public boolean isPackageFormat()
public org.w3c.dom.Document getContentDOM()
Document
object of the content.xml
file. Note that a content DOM is not created when the constructor
is called. So, either the read
method or the
initContentDOM
method will need to be called ahead
on this object before calling this method.
Document
object.public org.w3c.dom.Document getMetaDOM()
Document
object of the meta.xml
file. Note that a content DOM is not created when the constructor
is called. So, either the read
method or the
initContentDOM
method will need to be called ahead
on this object before calling this method.
Document
object.public org.w3c.dom.Document getSettingsDOM()
Document
object of the settings.xml
file. Note that a content DOM is not created when the constructor
is called. So, either the read
method or the
initContentDOM
method will need to be called ahead
on this object before calling this method.
Document
object.public void setContentDOM(org.w3c.dom.Node newDom)
newDom
- Node
containing the new content tree.public void setMetaDOM(org.w3c.dom.Node newDom)
newDom
- Node
containing the new meta tree.public void setSettingsDOM(org.w3c.dom.Node newDom)
newDom
- Node
containing the new settings tree.public void setStyleDOM(org.w3c.dom.Node newDom)
newDom
- Node
containing the new style tree.public org.w3c.dom.Document getStyleDOM()
Document
object of the style.xml file.
Note that this may return null if there is no style DOM.
Note that a style DOM is not created when the constructor
is called. Depending on the InputStream
, a
read
method may or may not build a style DOM. When
creating a new style DOM, call the initStyleDOM
method
first.
Document
object.public java.lang.String getName()
Document
.
getName
in interface Document
Document
.public java.lang.String getFileName()
Document
, possibly
with the standard extension.
getFileName
in interface OutputFile
Document
.protected java.lang.String getFileExtension()
Document
.
Document
.public java.util.Iterator getEmbeddedObjects()
Iterator
of EmbeddedObject
objects.public EmbeddedObject getEmbeddedObject(java.lang.String name)
name
- The name of the embedded object to retrieve.
EmbeddedObject
instance representing the named
object.public void addEmbeddedObject(EmbeddedObject embObj)
embObj
- An instance of EmbeddedObject
.public void read(java.io.InputStream is) throws java.io.IOException
Document
from the given
InputStream
.
FIX3 (HJ): Perform simple type detection to determine package or flat format
read
in interface Document
is
- Office document InputStream
.
java.io.IOException
- If any I/O error occurs.public void read(java.io.InputStream is, boolean isZip) throws java.io.IOException
Document
from the given
InputStream
.
is
- Office document InputStream
.isZip
- boolean
Identifies whether
a file is zipped or not
java.io.IOException
- If any I/O error occurs.protected java.lang.String getDocumentMimeType()
public void write(java.io.OutputStream os) throws java.io.IOException
write
in interface OutputFile
os
- XML OutputStream
.
java.io.IOException
- If any I/O error occurs.public void write(java.io.OutputStream os, boolean isZip) throws java.io.IOException
os
- XML OutputStream
.isZip
- boolean
java.io.IOException
- If any I/O error occurs.public final void initContentDOM() throws java.io.IOException
Document
with the content
containing minimum OpenOffice XML tags.
java.io.IOException
- If any I/O error occurs.public final void initSettingsDOM() throws java.io.IOException
Document
with the content
containing minimum OpenOffice XML tags.
java.io.IOException
- If any I/O error occurs.public final void initStyleDOM() throws java.io.IOException
java.io.IOException
- If any I/O error occurs.protected java.lang.String getOfficeClassAttribute()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |