LibreOffice Module xmerge (master)  1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer Class Referenceabstract

General spreadsheet implementation of. More...

Inheritance diagram for org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer:
[legend]
Collaboration diagram for org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer:
[legend]

Public Member Functions

 SxcDocumentSerializer ()
 Constructor. More...
 
abstract ConvertData serialize () throws ConvertException, IOException
 Method to convert a DOM. More...
 
void traverseSettings (Node node) throws IOException
 This method traverses office:settings More...
 

Protected Member Functions

void loadStyles (SxcDocument sxcDoc)
 Handles the loading of defined styles from the style.xml file as well as automatic styles from the content.xml file. More...
 
void traverseBody (Node node) throws IOException
 This method traverses office:body More...
 
void traverseNamedExpressions (Node node) throws IOException
 This method traverses the table:table element. More...
 
void traverseTable (Node node) throws IOException
 This method traverses the table:table element. More...
 
void traverseTableRow (Node node) throws IOException
 This method traverses the table:table-row element. More...
 
void traverseTableColumn (Node node) throws IOException
 This method traverses the table:table-column More...
 
void traverseCell (Node node) throws IOException
 This method traverses a table:table-cell element. More...
 
void traverseParagraph (Node node) throws IOException
 This method traverses the text:p element. More...
 
void addCell (String cellValue) throws IOException
 This method will take the input cell value and add it to the spreadsheet. More...
 
int getDecimalPlaces (Node node)
 This method takes a table:table-cell More...
 

Protected Attributes

SpreadsheetEncoder encoder = null
 A. More...
 

Private Attributes

Format fmt = null
 
int rowID = 1
 The row number. More...
 
int colID = 1
 The column number. More...
 
int rowsRepeated = 1
 The number of times the current row is repeated. More...
 
int colsRepeated = 1
 The number of times the current column is repeated. More...
 
StyleCatalog styleCat = null
 The number of times the current column is repeated. More...
 
ArrayList< ColumnRowInfoColumnRowList
 An array of column widths of the current worksheet. More...
 

Additional Inherited Members

- Public Attributes inherited from org.openoffice.xmerge.converter.xml.OfficeConstants
String TAG_OFFICE_DOCUMENT = "office:document"
 Element tag for office:document, this is the root tag. More...
 
String TAG_OFFICE_DOCUMENT_CONTENT = "office:document-content"
 Element tag for office:document-content, this is the root tag in content.xml. More...
 
String TAG_OFFICE_DOCUMENT_SETTINGS = "office:document-settings"
 Element tag for office:document-settings, this is the root tag in content.xml. More...
 
String TAG_OFFICE_DOCUMENT_META = "office:document-meta"
 Element tag for office:document-meta, this is the root tag in content.xml. More...
 
String TAG_OFFICE_DOCUMENT_STYLES = "office:document-styles"
 Element tag for office:document-styles, this is the root tag in styles.xml. More...
 
String TAG_OFFICE_STYLES = "office:styles"
 Element tag for office:styles. More...
 
String TAG_OFFICE_META = "office:meta"
 Element tag for office:meta. More...
 
String TAG_OFFICE_AUTOMATIC_STYLES = "office:automatic-styles"
 Element tag for office:automatic-styles. More...
 
String TAG_OFFICE_MASTER_STYLES = "office:master-styles"
 Element tag for office:master-styles. More...
 
String TAG_OFFICE_BODY = "office:body"
 Element tag for office:body. More...
 
String TAG_OFFICE_SETTINGS = "office:settings"
 Element tag for office:settings. More...
 
String TAG_OFFICE_FONT_DECLS = "office:font-decls"
 Element tag for office:font-decls. More...
 
String TAG_STYLE_FONT_DECL = "style:font-decl"
 Element tag for style:font-decl. More...
 
String ATTRIBUTE_STYLE_NAME = "style:name"
 Attribute tag for style:name of element style:name. More...
 
String ATTRIBUTE_STYLE_FONT_PITCH = "style:font-pitch"
 Attribute tag for style:font-pitch of element style:font-pitch. More...
 
String ATTRIBUTE_FO_FONT_FAMILY = "fo:font-family"
 Attribute tag for fo:font-family of element fo:font-family. More...
 
String ATTRIBUTE_FO_FONT_FAMILY_GENERIC = "fo:font-family-generic"
 Attribute tag for fo:font-family of element fo:font-family. More...
 
String TAG_PARAGRAPH = "text:p"
 Element tag for text:p. More...
 
String TAG_HEADING = "text:h"
 Element tag for text:h. More...
 
String TAG_SPACE = "text:s"
 Element tag for text:s. More...
 
String TAG_TAB_STOP = "text:tab-stop"
 Element tag for text:tab-stop. More...
 
String TAG_LINE_BREAK = "text:line-break"
 Element tag for text:line-break. More...
 
String TAG_SPAN = "text:span"
 Element tag for text:span. More...
 
String TAG_HYPERLINK = "text:a"
 Element tag for text:a. More...
 
String TAG_UNORDERED_LIST = "text:unordered-list"
 Element tag for text:unordered-list. More...
 
String TAG_ORDERED_LIST = "text:ordered-list"
 Element tag for text:ordered-list. More...
 
String TAG_LIST_HEADER = "text:list-header"
 Element tag for text:list-header. More...
 
String TAG_LIST_ITEM = "text:list-item"
 Element tag for text:list-item. More...
 
String ATTRIBUTE_SPACE_COUNT = "text:c"
 Attribute tag for text:c of element text:s. More...
 
String TAG_TABLE = "table:table"
 Element tag for table:table. More...
 
String TAG_NAMED_EXPRESSIONS = "table:named-expressions"
 Element tag for table:named-expression. More...
 
String TAG_TABLE_NAMED_RANGE = "table:named-range"
 Element tag for table:named-range. More...
 
String TAG_TABLE_NAMED_EXPRESSION = "table:named-expression"
 Element tag for table:named-expression. More...
 
String ATTRIBUTE_TABLE_NAME = "table:name"
 Attribute tag for table:name of element table:table. More...
 
String ATTRIBUTE_TABLE_EXPRESSION = "table:expression"
 Attribute tag for table:expression of element table:named-range. More...
 
String ATTRIBUTE_TABLE_BASE_CELL_ADDRESS = "table:base-cell-address"
 Attribute tag for table:base-cell-address of element table:named-range. More...
 
String ATTRIBUTE_TABLE_CELL_RANGE_ADDRESS = "table:cell-range-address"
 Attribute tag for table:cell-range-address of element table:named-range. More...
 
String TAG_TABLE_ROW = "table:table-row"
 Element tag for table:table-row. More...
 
String TAG_TABLE_COLUMN = "table:table-column"
 Element tag for table:table-column. More...
 
String ATTRIBUTE_DEFAULT_CELL_STYLE = "table:default-cell-style-name"
 Attribute tag for table:default-cell-style-name of element table:table-column. More...
 
String TAG_TABLE_SCENARIO = "table:scenario"
 Element tag for table:scenario. More...
 
String TAG_TABLE_CELL = "table:table-cell"
 Element tag for table:table-cell. More...
 
String ATTRIBUTE_TABLE_VALUE_TYPE = "table:value-type"
 Attribute tag for table:value-type of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_NUM_COLUMNS_REPEATED
 Attribute tag for table:number-columns-repeated of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_NUM_ROWS_REPEATED = "table:number-rows-repeated"
 Attribute tag for table:number-rows-repeated of element table:table-row. More...
 
String ATTRIBUTE_TABLE_FORMULA = "table:formula"
 Attribute tag for table:formula of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_VALUE = "table:value"
 Attribute tag for table:value of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_DATE_VALUE = "table:date-value"
 Attribute tag for table:date-value of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_TIME_VALUE = "table:time-value"
 Attribute tag for table:time-value of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_STRING_VALUE = "table:string-value"
 Attribute tag for table:string-value of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_BOOLEAN_VALUE = "table:boolean-value"
 Attribute tag for table:time-boolean-value of element table:table-cell. More...
 
String ATTRIBUTE_TABLE_STYLE_NAME = "table:style-name"
 Attribute tag for table:style-name of table elements. More...
 
String ATTRIBUTE_TABLE_CURRENCY = "table:currency"
 Attribute tag for table:currency of element table:table-cell. More...
 
String CELLTYPE_STRING = "string"
 The cell contains data of type string. More...
 
String CELLTYPE_FLOAT = "float"
 The cell contains data of type float. More...
 
String CELLTYPE_TIME = "time"
 The cell contains data of type time. More...
 
String CELLTYPE_DATE = "date"
 The cell contains data of type date. More...
 
String CELLTYPE_CURRENCY = "currency"
 The cell contains data of type currency. More...
 
String CELLTYPE_BOOLEAN = "boolean"
 The cell contains data of type boolean. More...
 
String CELLTYPE_PERCENT = "percentage"
 The cell contains data of type percent. More...
 
String SXW_FILE_EXTENSION = ".sxw"
 StarWriter XML file extension. More...
 
String SXW_TYPE = "text"
 StarWriter XML office:class value. More...
 
String SXC_FILE_EXTENSION = ".sxc"
 StarCalc XML file extension. More...
 
String SXC_TYPE = "spreadsheet"
 StarCalc XML office:class value. More...
 
String TAG_MANIFEST_ROOT = "manifest:manifest"
 Element tag for manifest:manifestentry in Manifest XML. More...
 
String TAG_MANIFEST_FILE = "manifest:file-entry"
 Element tag for manifest:file-entry entry in Manifest XML. More...
 
String ATTRIBUTE_MANIFEST_FILE_TYPE = "manifest:media-type"
 Attribute tag for manifest:media-type of element manifest:file-entry. More...
 
String ATTRIBUTE_MANIFEST_FILE_PATH = "manifest:full-path"
 Attribute tag for manifest:full-path of element manifest:file-entry. More...
 
String TAG_CONFIG_ITEM = "config:config-item"
 Element tag for config:config-item. More...
 
String TAG_CONFIG_ITEM_SET = "config:config-item-set"
 Element tag for config:config-item-set. More...
 
String TAG_CONFIG_ITEM_MAP_INDEXED = "config:config-item-map-indexed"
 Element tag for config:config-item-map-indexed. More...
 
String TAG_CONFIG_ITEM_MAP_NAMED = "config:config-item-map-named"
 Element tag for config:config-item-map-named. More...
 
String TAG_CONFIG_ITEM_MAP_ENTRY = "config:config-item-map-entry"
 Element tag for config:config-item-map-entry. More...
 
String ATTRIBUTE_CONFIG_NAME = "config:name"
 Attribute tag for config:name of element config:config-item. More...
 
String ATTRIBUTE_CONFIG_TYPE = "config:type"
 Attribute tag for config:type of element config:config-item. More...
 
String SXW_MIME_TYPE = "application/vnd.sun.xml.writer"
 StarWriter XML MIME type. More...
 
String SXC_MIME_TYPE = "application/vnd.sun.xml.calc"
 StarCalc XML MIME type. More...
 

Detailed Description

General spreadsheet implementation of.

DocumentSerializer

for the SxcPluginFactory.

Used with SXC

objects.

The

method traverses the DOM

from the given

object. It uses a

DocEncoder

object for the actual conversion of contents to the device spreadsheet format.

Definition at line 48 of file SxcDocumentSerializer.java.

Constructor & Destructor Documentation

org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.SxcDocumentSerializer ( )
inline

Constructor.

Parameters
documentInput
SxcDocument
.

Definition at line 85 of file SxcDocumentSerializer.java.

Member Function Documentation

void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.addCell ( String  cellValue) throws IOException
inlineprotected
int org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.getDecimalPlaces ( Node  node)
inlineprotected

This method takes a table:table-cell

and traverses down to the text:p tag.

The value is extracted from the text:p tag and the number of decimal places is calculated.

Parameters
nodeA table:table-cell .
Returns
The number of decimal places in the display string of the data in the input .

Definition at line 844 of file SxcDocumentSerializer.java.

References paragraph, String, and org.openoffice.xmerge.converter.xml.OfficeConstants.TAG_PARAGRAPH.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseCell().

void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.loadStyles ( SxcDocument  sxcDoc)
inlineprotected
abstract ConvertData org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.serialize ( ) throws ConvertException, IOException
abstract

Method to convert a DOM.

into "Device"

objects.

This method is not thread safe for performance reasons. This method should not be called from within two threads. It would be best to call this method only once per object instance.

Returns
containing "Device" objects.
Exceptions
ConvertExceptionIf any conversion error occurs.
IOExceptionIf any I/O error occurs.

Implements org.openoffice.xmerge.DocumentSerializer.

void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseBody ( Node  node) throws IOException
inlineprotected
void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseCell ( Node  node) throws IOException
inlineprotected

This method traverses a table:table-cell element.

.

Parameters
nodea table:table-cell .
Exceptions
IOExceptionif any I/O error occurs.

Definition at line 520 of file SxcDocumentSerializer.java.

References org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.addCell(), org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_BOOLEAN_VALUE, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_DATE_VALUE, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_FORMULA, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_NUM_COLUMNS_REPEATED, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_STRING_VALUE, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_STYLE_NAME, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_TIME_VALUE, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_VALUE, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_TABLE_VALUE_TYPE, org.openoffice.xmerge.converter.xml.OfficeConstants.CELLTYPE_BOOLEAN, org.openoffice.xmerge.converter.xml.OfficeConstants.CELLTYPE_CURRENCY, org.openoffice.xmerge.converter.xml.OfficeConstants.CELLTYPE_DATE, org.openoffice.xmerge.converter.xml.OfficeConstants.CELLTYPE_FLOAT, org.openoffice.xmerge.converter.xml.OfficeConstants.CELLTYPE_PERCENT, org.openoffice.xmerge.converter.xml.OfficeConstants.CELLTYPE_STRING, org.openoffice.xmerge.converter.xml.OfficeConstants.CELLTYPE_TIME, org.openoffice.xmerge.converter.xml.sxc.Format.clearFormatting(), org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.colsRepeated, org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.getDecimalPlaces(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getFormat(), org.openoffice.xmerge.converter.xml.sxc.CellStyle.getFormat(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getRepeated(), i, index, org.openoffice.xmerge.util.Debug.INFO, Integer, org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isColumn(), org.openoffice.xmerge.converter.xml.sxc.Format.isDefault(), org.openoffice.xmerge.util.Debug.log(), org.openoffice.xmerge.converter.xml.StyleCatalog.lookup(), org.openoffice.xmerge.converter.xml.sxc.Format.setCategory(), org.openoffice.xmerge.converter.xml.sxc.Format.setDecimalPlaces(), org.openoffice.xmerge.converter.xml.sxc.Format.setValue(), String, org.openoffice.xmerge.converter.xml.sxc.SxcConstants.TABLE_CELL_STYLE_FAMILY, org.openoffice.xmerge.converter.xml.OfficeConstants.TAG_PARAGRAPH, org.openoffice.xmerge.util.Debug.TRACE, and org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseParagraph().

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTableRow().

void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseNamedExpressions ( Node  node) throws IOException
inlineprotected

This method traverses the table:table element.

.

Parameters
nodeA table:table .
Exceptions
IOExceptionIf any I/O error occurs.

Definition at line 241 of file SxcDocumentSerializer.java.

References i, org.openoffice.xmerge.util.Debug.log(), org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder.setNameDefinition(), and org.openoffice.xmerge.util.Debug.TRACE.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseBody().

void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseParagraph ( Node  node) throws IOException
inlineprotected
void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseSettings ( Node  node) throws IOException
inline
void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTable ( Node  node) throws IOException
inlineprotected
void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTableColumn ( Node  node) throws IOException
inlineprotected
void org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTableRow ( Node  node) throws IOException
inlineprotected

Member Data Documentation

int org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.colID = 1
private

The column number.

Definition at line 58 of file SxcDocumentSerializer.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.addCell().

int org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.colsRepeated = 1
private
ArrayList<ColumnRowInfo> org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.ColumnRowList
private

An array of column widths of the current worksheet.

Width is measured in number of characters.

Definition at line 73 of file SxcDocumentSerializer.java.

SpreadsheetEncoder org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.encoder = null
protected

A.

SpreadsheetEncoder

object for encoding to appropriate format.

Definition at line 78 of file SxcDocumentSerializer.java.

Format org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.fmt = null
private

object describing the cell.

Definition at line 52 of file SxcDocumentSerializer.java.

int org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.rowID = 1
private
int org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.rowsRepeated = 1
private
StyleCatalog org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.styleCat = null
private

The number of times the current column is repeated.

Definition at line 67 of file SxcDocumentSerializer.java.


The documentation for this class was generated from the following file: