Package writer2latex.xmerge
Class OfficeDocument
java.lang.Object
writer2latex.xmerge.OfficeDocument
- All Implemented Interfaces:
OutputFile
,Document
,OfficeConstants
An implementation of
Document
for
StarOffice documents.-
Field Summary
Fields inherited from interface writer2latex.xmerge.OfficeConstants
ATTRIBUTE_CONFIG_NAME, ATTRIBUTE_CONFIG_TYPE, ATTRIBUTE_DEFAULT_CELL_STYLE, ATTRIBUTE_FO_FONT_FAMILY, ATTRIBUTE_FO_FONT_FAMILY_GENERIC, ATTRIBUTE_MANIFEST_FILE_PATH, ATTRIBUTE_MANIFEST_FILE_TYPE, ATTRIBUTE_OFFICE_CLASS, ATTRIBUTE_SPACE_COUNT, ATTRIBUTE_STYLE_FONT_PITCH, ATTRIBUTE_STYLE_NAME, ATTRIBUTE_TABLE_BASE_CELL_ADDRESS, ATTRIBUTE_TABLE_BOOLEAN_VALUE, ATTRIBUTE_TABLE_CELL_RANGE_ADDRESS, ATTRIBUTE_TABLE_CURRENCY, ATTRIBUTE_TABLE_DATE_VALUE, ATTRIBUTE_TABLE_EXPRESSION, ATTRIBUTE_TABLE_FORMULA, ATTRIBUTE_TABLE_NAME, ATTRIBUTE_TABLE_NUM_COLUMNS_REPEATED, ATTRIBUTE_TABLE_NUM_ROWS_REPEATED, ATTRIBUTE_TABLE_STRING_VALUE, ATTRIBUTE_TABLE_STYLE_NAME, ATTRIBUTE_TABLE_TIME_VALUE, ATTRIBUTE_TABLE_VALUE, ATTRIBUTE_TABLE_VALUE_TYPE, ATTRIBUTE_TEXT_STYLE_NAME, CELLTYPE_BOOLEAN, CELLTYPE_CURRENCY, CELLTYPE_DATE, CELLTYPE_FLOAT, CELLTYPE_PERCENT, CELLTYPE_STRING, CELLTYPE_TIME, STC_MIME_TYPE, STI_MIME_TYPE, STW_MIME_TYPE, SXC_FILE_EXTENSION, SXC_MIME_TYPE, SXC_TYPE, SXD_MIME_TYPE, SXG_MIME_TYPE, SXI_MIME_TYPE, SXM_MIME_TYPE, SXW_FILE_EXTENSION, SXW_MIME_TYPE, SXW_TYPE, TAG_BOOKMARK, TAG_BOOKMARK_START, TAG_CONFIG_ITEM, TAG_CONFIG_ITEM_MAP_ENTRY, TAG_CONFIG_ITEM_MAP_INDEXED, TAG_CONFIG_ITEM_MAP_NAMED, TAG_CONFIG_ITEM_SET, TAG_HEADING, TAG_HYPERLINK, TAG_LINE_BREAK, TAG_LIST_HEADER, TAG_LIST_ITEM, TAG_MANIFEST_FILE, TAG_MANIFEST_ROOT, TAG_NAMED_EXPRESSIONS, TAG_OFFICE_AUTOMATIC_STYLES, TAG_OFFICE_BODY, TAG_OFFICE_DOCUMENT, TAG_OFFICE_DOCUMENT_CONTENT, TAG_OFFICE_DOCUMENT_META, TAG_OFFICE_DOCUMENT_SETTINGS, TAG_OFFICE_DOCUMENT_STYLES, TAG_OFFICE_FONT_DECLS, TAG_OFFICE_FONT_FACE_DECLS, TAG_OFFICE_MASTER_STYLES, TAG_OFFICE_META, TAG_OFFICE_SETTINGS, TAG_OFFICE_STYLES, TAG_ORDERED_LIST, TAG_PARAGRAPH, TAG_SPACE, TAG_SPAN, TAG_STYLE_FONT_DECL, TAG_TAB_STOP, TAG_TABLE, TAG_TABLE_CELL, TAG_TABLE_COLUMN, TAG_TABLE_NAMED_EXPRESSION, TAG_TABLE_NAMED_RANGE, TAG_TABLE_ROW, TAG_TABLE_SCENARIO, TAG_TEXT, TAG_TEXT_AUTHOR_INITIALS, TAG_TEXT_CREATION_TIME, TAG_TEXT_DATE, TAG_TEXT_EXPRESSION, TAG_TEXT_PAGE_COUNT, TAG_TEXT_PAGE_NUMBER, TAG_TEXT_PAGE_VARIABLE_GET, TAG_TEXT_SEQUENCE, TAG_TEXT_SUBJECT, TAG_TEXT_TEXT_INPUT, TAG_TEXT_TIME, TAG_TEXT_TITLE, TAG_TEXT_USER_FIELD_GET, TAG_TEXT_VARIABLE_GET, TAG_TEXT_VARIABLE_INPUT, TAG_TEXT_VARIABLE_SET, TAG_UNORDERED_LIST
-
Constructor Summary
ConstructorsConstructorDescriptionOfficeDocument
(String name) Default constructor.OfficeDocument
(String name, boolean namespaceAware, boolean validating) Constructor with arguments to setnamespaceAware
andvalidating
flags. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEmbeddedObject
(EmbeddedObject embObj) Adds a new embedded object to the document.Return a DOMDocument
object of the content.xml file.protected String
Method to return the MIME type of the document.getEmbeddedObject
(String name) Returns the embedded object corresponding to the name provided.Returns all the embedded objects (graphics, formulae, etc.) present in this document.protected String
Returns the file extension for this type ofDocument
.Return the file name of theDocument
, possibly with the standard extension.Return a DOMDocument
object of the meta.xml file.getName()
Return the name of theDocument
.protected String
Return the office:class attribute value.Return a DOMDocument
object of the settings.xml file.Return a DOMDocument
object of the style.xml file.final void
Initializes a new DOMDocument
with the content containing minimum OpenOffice XML tags.final void
Initializes a new DOMDocument
with the content containing minimum OpenOffice XML tags.final void
Initializes a new DOM Document with styles containing minimum OpenOffice XML tags.boolean
Package or flat format?void
read
(InputStream is) Read the OfficeDocument
from the givenInputStream
.void
read
(InputStream is, boolean isZip) Read the OfficeDocument
from the givenInputStream
.void
setContentDOM
(Node newDom) Sets the content tree of the document.void
setMetaDOM
(Node newDom) Sets the meta tree of the document.void
setSettingsDOM
(Node newDom) Sets the settings tree of the document.void
setStyleDOM
(Node newDom) Sets the style tree of the document.void
write
(OutputStream os) Write out Office ZIP file format.void
write
(OutputStream os, boolean isZip) Write out Office ZIP file format.
-
Constructor Details
-
OfficeDocument
Default constructor.- Parameters:
name
-Document
name.
-
OfficeDocument
Constructor with arguments to setnamespaceAware
andvalidating
flags.- Parameters:
name
-Document
name (may or may not contain extension).namespaceAware
- Value fornamespaceAware
flag.validating
- Value forvalidating
flag.
-
-
Method Details
-
isPackageFormat
public boolean isPackageFormat()Package or flat format?- Returns:
- true if the document is in package format, false if it's flat xml
-
getContentDOM
Return a DOMDocument
object of the content.xml file. Note that a content DOM is not created when the constructor is called. So, either theread
method or theinitContentDOM
method will need to be called ahead on this object before calling this method.- Returns:
- DOM
Document
object.
-
getMetaDOM
Return a DOMDocument
object of the meta.xml file. Note that a content DOM is not created when the constructor is called. So, either theread
method or theinitContentDOM
method will need to be called ahead on this object before calling this method.- Returns:
- DOM
Document
object.
-
getSettingsDOM
Return a DOMDocument
object of the settings.xml file. Note that a content DOM is not created when the constructor is called. So, either theread
method or theinitContentDOM
method will need to be called ahead on this object before calling this method.- Returns:
- DOM
Document
object.
-
setContentDOM
Sets the content tree of the document.- Parameters:
newDom
-Node
containing the new content tree.
-
setMetaDOM
Sets the meta tree of the document.- Parameters:
newDom
-Node
containing the new meta tree.
-
setSettingsDOM
Sets the settings tree of the document.- Parameters:
newDom
-Node
containing the new settings tree.
-
setStyleDOM
Sets the style tree of the document.- Parameters:
newDom
-Node
containing the new style tree.
-
getStyleDOM
Return a DOMDocument
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 theInputStream
, aread
method may or may not build a style DOM. When creating a new style DOM, call theinitStyleDOM
method first.- Returns:
- DOM
Document
object.
-
getName
Return the name of theDocument
. -
getFileName
Return the file name of theDocument
, possibly with the standard extension.- Specified by:
getFileName
in interfaceOutputFile
- Returns:
- The file name of
Document
.
-
getFileExtension
Returns the file extension for this type ofDocument
.- Returns:
- The file extension of
Document
.
-
getEmbeddedObjects
Returns all the embedded objects (graphics, formulae, etc.) present in this document.- Returns:
- An
Iterator
ofEmbeddedObject
objects.
-
getEmbeddedObject
Returns the embedded object corresponding to the name provided. The name should be stripped of any preceding path characters, such as '/', '.' or '#'.- Parameters:
name
- The name of the embedded object to retrieve.- Returns:
- An
EmbeddedObject
instance representing the named object.
-
addEmbeddedObject
Adds a new embedded object to the document.- Parameters:
embObj
- An instance ofEmbeddedObject
.
-
read
Read the OfficeDocument
from the givenInputStream
. FIX3 (HJ): Perform simple type detection to determine package or flat format- Specified by:
read
in interfaceDocument
- Parameters:
is
- Office documentInputStream
.- Throws:
IOException
- If any I/O error occurs.
-
read
Read the OfficeDocument
from the givenInputStream
.- Parameters:
is
- Office documentInputStream
.isZip
-boolean
Identifies whether a file is zipped or not- Throws:
IOException
- If any I/O error occurs.
-
getDocumentMimeType
Method to return the MIME type of the document.- Returns:
- String The document's MIME type.
-
write
Write out Office ZIP file format.- Specified by:
write
in interfaceOutputFile
- Parameters:
os
- XMLOutputStream
.- Throws:
IOException
- If any I/O error occurs.
-
write
Write out Office ZIP file format.- Parameters:
os
- XMLOutputStream
.isZip
-boolean
- Throws:
IOException
- If any I/O error occurs.
-
initContentDOM
Initializes a new DOMDocument
with the content containing minimum OpenOffice XML tags.- Throws:
IOException
- If any I/O error occurs.
-
initSettingsDOM
Initializes a new DOMDocument
with the content containing minimum OpenOffice XML tags.- Throws:
IOException
- If any I/O error occurs.
-
initStyleDOM
Initializes a new DOM Document with styles containing minimum OpenOffice XML tags.- Throws:
IOException
- If any I/O error occurs.
-
getOfficeClassAttribute
Return the office:class attribute value.- Returns:
- The attribute value.
-