/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package org.openoffice.xmerge.converter.xml.sxc;
import java.io.IOException;
import java.util.Iterator;
import org.openoffice.xmerge.ConvertData;
import org.openoffice.xmerge.ConvertException;
import org.openoffice.xmerge.Document;
import org.openoffice.xmerge.DocumentDeserializer;
import org.openoffice.xmerge.converter.xml.OfficeConstants;
import org.openoffice.xmerge.converter.xml.Style;
import org.openoffice.xmerge.converter.xml.StyleCatalog;
import org.openoffice.xmerge.util.Debug;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* General spreadsheet implementation of {@code DocumentDeserializer} for the
* {@link org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory
* SxcPluginFactory}.
*
*
Used with SXC {@code Document} objects.
*
* The {@code deserialize} method uses a {@code DocDecoder} to read the device
* spreadsheet format into a {@code String} object, then it calls
* {@code buildDocument} to create a {@code SxcDocument} object from it.
*/
public abstract class SxcDocumentDeserializer implements OfficeConstants,
DocumentDeserializer {
/**
* A {@code SpreadsheetDecoder} object for decoding from device formats.
*/
private SpreadsheetDecoder decoder = null;
/** A w3c {@code Document}. */
private org.w3c.dom.Document settings = null;
/** A w3c {@code Document}. */
private org.w3c.dom.Document doc = null;
/** A {@code ConvertData} object assigned to this object. */
private final ConvertData cd ;
/** A {@code StyleCatalog} for the workbook. */
private StyleCatalog styleCat = null;
private int textStyles = 1;
private int colStyles = 1;
private int rowStyles = 1;
/**
* Constructor.
*
* @param cd {@code ConvertData} consisting of a device content object.
*/
public SxcDocumentDeserializer(ConvertData cd) {
this.cd = cd;
}
/**
* This {@code abstract} method will be implemented by concrete subclasses
* and will return an application-specific Decoder.
*
* @param workbook The WorkBook to read.
* @param password The WorkBook password.
*
* @return The appropriate {@code SpreadSheetDecoder}.
*
* @throws IOException If any I/O error occurs.
*/
public abstract SpreadsheetDecoder createDecoder(String workbook, String[] worksheetNames, String password)
throws IOException;
/**
* This method will return the name of the WorkBook from the
* {@code ConvertData}.
*
* Allows for situations where the WorkBook name differs from the Device
* Content name.
*
* Implemented in the Deserializer as the Decoder's constructor requires
* a name.
*
* @param cd The {@code ConvertData} containing the Device content.
*
* @return The WorkBook name.
*/
protected abstract String getWorkbookName(ConvertData cd) throws IOException;
/**
* This method will return the name of the WorkSheet from the
* {@code ConvertData}.
*
* @param cd The {@code ConvertData} containing the Device content.
*
* @return The WorkSheet names.
*/
protected abstract String[] getWorksheetNames(ConvertData cd) throws IOException;
/**
* Method to convert a set of "Device" {@code Document} objects
* into a {@code SxcDocument} object and returns it as a {@code Document}.
*
* 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.
*
* @return document A {@code SxcDocument} consisting of the data converted
* from the input stream.
*
* @throws ConvertException If any conversion error occurs.
* @throws IOException If any I/O error occurs.
*/
public Document deserialize() throws ConvertException,
IOException {
// Get the name of the WorkBook from the ConvertData.
String[] worksheetNames = getWorksheetNames(cd);
String workbookName = getWorkbookName(cd);
// Create a document
SxcDocument sxcDoc = new SxcDocument(workbookName);
sxcDoc.initContentDOM();
sxcDoc.initSettingsDOM();
// Default to an initial 5 entries in the catalog.
styleCat = new StyleCatalog(5);
doc = sxcDoc.getContentDOM();
settings = sxcDoc.getSettingsDOM();
initFontTable();
// Little fact for the curious reader: workbookName should
// be the name of the StarCalc file minus the file extension suffix.
// Create a Decoder to decode the DeviceContent to a spreadsheet document
// ToDo - we aren't using a password in StarCalc, so we can
// use any value for password here. If StarCalc XML supports
// passwords in the future, we should try to get the correct
// password value here.
decoder = createDecoder(workbookName, worksheetNames, "password");
Debug.log(Debug.TRACE, "");
Debug.log(Debug.TRACE, "");
decoder.addDeviceContent(cd);
decode();
Debug.log(Debug.TRACE, "");
return sxcDoc;
}
/**
* This initializes a font table so we can include some basic font support
* for spreadsheets.
*/
private void initFontTable() {
String fontTable[]= new String[] { "Tahoma", "Tahoma", "swiss", "variable",
"Courier New", "'Courier New'",
"modern", "fixed" };
// Traverse to the office:body element.
// There should only be one.
NodeList list = doc.getElementsByTagName(TAG_OFFICE_FONT_DECLS);
Node root = list.item(0);
for(int i=0;i 0) {
// Process the spreadsheet
processTable(node);
}
}
// Add the Defined Name table if there is one
Iterator nameDefinitionTable = decoder.getNameDefinitions();
if(nameDefinitionTable.hasNext()) {
processNameDefinition(node, nameDefinitionTable);
}
// add settings
NodeList settingsList = settings.getElementsByTagName(TAG_OFFICE_SETTINGS);
Node settingsNode = settingsList.item(0);
processSettings(settingsNode);
}
/**
* This method process the settings portion of the {@code Document}.
*
* @param root The root {@code Node} of the {@code Document} we are
* building. This {@code Node} should be a
* {@code TAG_OFFICE_SETTINGS} tag.
*/
protected void processSettings(Node root) {
Element configItemSetEntry = settings.createElement(TAG_CONFIG_ITEM_SET);
configItemSetEntry.setAttribute(ATTRIBUTE_CONFIG_NAME, "view-settings");
Element configItemMapIndexed = settings.createElement(TAG_CONFIG_ITEM_MAP_INDEXED);
configItemMapIndexed.setAttribute(ATTRIBUTE_CONFIG_NAME, "Views");
Element configItemMapEntry = settings.createElement(TAG_CONFIG_ITEM_MAP_ENTRY);
BookSettings bs = decoder.getSettings();
bs.writeNode(settings, configItemMapEntry);
configItemMapIndexed.appendChild(configItemMapEntry);
configItemSetEntry.appendChild(configItemMapIndexed);
root.appendChild(configItemSetEntry);
}
/**
* This method process a Name Definition Table and generates a portion of
* the {@code Document}.
*
* @param root The root {@code Node} of the {@code Document} we are
* building. This {@code Node} should be a
* {@code TAG_OFFICE_BODY} tag.
*
* @throws IOException If any I/O error occurs.
*/
protected void processNameDefinition(Node root, Iterator eNameDefinitions) throws IOException {
Debug.log(Debug.TRACE, "");
Element namedExpressionsElement = doc.createElement(TAG_NAMED_EXPRESSIONS);
while(eNameDefinitions.hasNext()) {
NameDefinition tableEntry = eNameDefinitions.next();
tableEntry.writeNode(doc, namedExpressionsElement);
}
root.appendChild(namedExpressionsElement);
Debug.log(Debug.TRACE, "");
}
/**
* This method process a WorkSheet and generates a portion of the
* {@code Document}.
*
* A spreadsheet is represented as a table Node in StarOffice XML format.
*
* @param root The root {@code Node} of the {@code Document} we are
* building. This {@code Node} should be a
* {@code TAG_OFFICE_BODY} tag.
*
* @throws IOException If any I/O error occurs.
*/
protected void processTable(Node root) throws IOException {
Debug.log(Debug.TRACE, "");
// Create an element node for the table
Element tableElement = doc.createElement(TAG_TABLE);
// Get the sheet name
String sheetName = decoder.getSheetName();
// Set the table name attribute
tableElement.setAttribute(ATTRIBUTE_TABLE_NAME, sheetName);
// ToDo - style currently hardcoded - get real value
// Set table style-name attribute
tableElement.setAttribute(ATTRIBUTE_TABLE_STYLE_NAME, "Default");
// Append the table element to the root node
root.appendChild(tableElement);
Debug.log(Debug.TRACE, "" + sheetName + "");
// Add the various different table-columns
processColumns(tableElement);
// Get each cell and add to doc
processCells(tableElement);
Debug.log(Debug.TRACE, "
");
}
/**
* This method process the cells in a {@code Document} and generates a
* portion of the {@code Document}.
*
* This method assumes that records are sorted by row and then column.
*
* @param root The {@code Node} of the {@code Document} we are building
* that we will append our cell {@code Node} objects. This
* {@code Node} should be a {@code TAG_TABLE} tag.
*
* @throws IOException If any I/O error occurs.
*/
protected void processColumns(Node root) throws IOException {
for(Iterator e = decoder.getColumnRowInfos();e.hasNext();) {
ColumnRowInfo ci = e.next();
if(ci.isColumn()) {
ColumnStyle cStyle = new ColumnStyle("Default",SxcConstants.COLUMN_STYLE_FAMILY,
SxcConstants.DEFAULT_STYLE, ci.getSize(), null);
Style result[] = styleCat.getMatching(cStyle);
String styleName;
if(result.length==0) {
cStyle.setName("co" + colStyles++);
styleName = cStyle.getName();
Debug.log(Debug.TRACE,"No existing style found, adding " + styleName);
styleCat.add(cStyle);
} else {
ColumnStyle existingStyle = (ColumnStyle) result[0];
styleName = existingStyle.getName();
Debug.log(Debug.TRACE,"Existing style found : " + styleName);
}
// Create an element node for the new row
Element colElement = doc.createElement(TAG_TABLE_COLUMN);
colElement.setAttribute(ATTRIBUTE_TABLE_STYLE_NAME, styleName);
if(ci.getRepeated()!=1) {
String repeatStr = String.valueOf(ci.getRepeated());
colElement.setAttribute(ATTRIBUTE_TABLE_NUM_COLUMNS_REPEATED, repeatStr);
}
root.appendChild(colElement);
}
}
}
/**
* This method process the cells in a {@code Document} and generates a
* portion of the {@code Document}.
*
* This method assumes that records are sorted by row and then column.
*
* @param root The {@code Node} of the {@code Document} we are building
* that we will append our cell {@code Node} objects. This
* {@code Node} should be a {@code TAG_TABLE} tag.
*
* @throws IOException If any I/O error occurs.
*/
protected void processCells(Node root) throws IOException {
// The current row element
Element rowElement = null;
// The current cell element
Element cellElement = null;
// The row number - we may not have any rows (empty sheet)
// so set to zero.
int row = 0;
// The column number - This is the expected column number of
// the next cell we are reading.
int col = 1;
// The number of columns in the spreadsheet
int lastColumn = decoder.getNumberOfColumns();
Node autoStylesNode = null;
// Loop over all cells in the spreadsheet
while (decoder.goToNextCell()) {
// Get the row number
int newRow = decoder.getRowNumber();
// Is the cell in a new row, or part of the current row?
if (newRow != row) {
// Make sure that all the cells in the previous row
// have been entered.
if (col <= lastColumn && rowElement != null) {
int numSkippedCells = lastColumn - col + 1;
addEmptyCells(numSkippedCells, rowElement);
}
// log an end row - if we already have a row
if (row != 0) {
Debug.log(Debug.TRACE, "");
}
// How far is the new row from the last row?
int deltaRows = newRow - row;
// Check if we have skipped any rows
if (deltaRows > 1) {
// Add in empty rows
addEmptyRows(deltaRows-1, root, lastColumn);
}
// Re-initialize column (since we are in a new row)
col = 1;
// Create an element node for the new row
rowElement = doc.createElement(TAG_TABLE_ROW);
for(Iterator e = decoder.getColumnRowInfos();e.hasNext();) {
ColumnRowInfo cri = e.next();
if(cri.isRow() && cri.getRepeated()==newRow-1) {
// We have the correct Row BIFFRecord for this row
RowStyle rStyle = new RowStyle("Default",SxcConstants.ROW_STYLE_FAMILY,
SxcConstants.DEFAULT_STYLE, cri.getSize(), null);
Style result[] = styleCat.getMatching(rStyle);
String styleName;
if(result.length==0) {
rStyle.setName("ro" + rowStyles++);
styleName = rStyle.getName();
Debug.log(Debug.TRACE,"No existing style found, adding " + styleName);
styleCat.add(rStyle);
} else {
RowStyle existingStyle = (RowStyle) result[0];
styleName = existingStyle.getName();
Debug.log(Debug.TRACE,"Existing style found : " + styleName);
}
rowElement.setAttribute(ATTRIBUTE_TABLE_STYLE_NAME, styleName);
// For now we will not use the repeat column attribute
}
}
// Append the row element to the root node
root.appendChild(rowElement);
// Update row number
row = newRow;
Debug.log(Debug.TRACE, "");
}
// Get the column number of the current cell
int newCol = decoder.getColNumber();
// Check to see if some columns were skipped
if (newCol != col) {
// How many columns have we skipped?
int numColsSkipped = newCol - col;
addEmptyCells(numColsSkipped, rowElement);
// Update the column number to account for the
// skipped cells
col = newCol;
}
// Lets start dealing with the cell data
Debug.log(Debug.TRACE, "");
// Get the cell's contents
String cellContents = decoder.getCellContents();
// Get the type of the data in the cell
String cellType = decoder.getCellDataType();
// Get the cell format
Format fmt = decoder.getCellFormat();
// Create an element node for the cell
cellElement = doc.createElement(TAG_TABLE_CELL);
Node bodyNode = doc.getElementsByTagName(TAG_OFFICE_BODY).item(0);
// Not every document has an automatic style tag
autoStylesNode = doc.getElementsByTagName(
TAG_OFFICE_AUTOMATIC_STYLES).item(0);
if (autoStylesNode == null) {
autoStylesNode = doc.createElement(TAG_OFFICE_AUTOMATIC_STYLES);
doc.insertBefore(autoStylesNode, bodyNode);
}
CellStyle tStyle = new
CellStyle( "Default",SxcConstants.TABLE_CELL_STYLE_FAMILY,
SxcConstants.DEFAULT_STYLE, fmt, null);
String styleName;
Style result[] = styleCat.getMatching(tStyle);
if(result.length==0) {
tStyle.setName("ce" + textStyles++);
styleName = tStyle.getName();
Debug.log(Debug.TRACE,"No existing style found, adding " + styleName);
styleCat.add(tStyle);
} else {
CellStyle existingStyle = (CellStyle) result[0];
styleName = existingStyle.getName();
Debug.log(Debug.TRACE,"Existing style found : " + styleName);
}
cellElement.setAttribute(ATTRIBUTE_TABLE_STYLE_NAME, styleName);
// Store the cell data into the appropriate attributes
processCellData(cellElement, cellType, cellContents);
// Append the cell element to the row node
rowElement.appendChild(cellElement);
// Append the cellContents as a text node
Element textElement = doc.createElement(TAG_PARAGRAPH);
cellElement.appendChild(textElement);
textElement.appendChild(doc.createTextNode(cellContents));
Debug.log(Debug.TRACE, cellContents);
Debug.log(Debug.TRACE, " | ");
// Increment to the column number of the next expected cell
col++;
}
// Make sure that the last row is padded correctly
if (col <= lastColumn && rowElement != null) {
int numSkippedCells = lastColumn - col + 1;
addEmptyCells(numSkippedCells, rowElement);
}
// Now write the style catalog to the document
if(autoStylesNode!=null) {
Debug.log(Debug.TRACE, "Well the autostyle node was found!!!");
NodeList nl = styleCat.writeNode(doc, "dummy").getChildNodes();
int nlLen = nl.getLength(); // nl.item reduces the length
for (int i = 0; i < nlLen; i++) {
autoStylesNode.appendChild(nl.item(0));
}
}
if (row != 0) {
// The sheet does have rows, so write out a /tr
Debug.log(Debug.TRACE, "
");
}
}
/**
* This method will add empty rows to the {@code Document}.
*
* It is called when the conversion process encounters a row (or rows)
* that do not contain any data in its cells.
*
* @param numEmptyRows The number of empty rows that we need to add to
* the {@code Document}.
* @param root The {@code Node} of the {@code Document} we are
* building that we will append our empty row
* {@code Node} objects. This {@code Node} should
* be a {@code TAG_TABLE} tag.
* @param numEmptyCells The number of empty cells in the empty row.
*/
protected void addEmptyRows(int numEmptyRows, Node root, int numEmptyCells) {
// Create an element node for the row
Element rowElement = doc.createElement(TAG_TABLE_ROW);
// ToDo - style currently hardcoded - get real value
// Set row style-name attribute
rowElement.setAttribute(ATTRIBUTE_TABLE_STYLE_NAME, "Default");
// Set cell number-rows-repeated attribute
rowElement.setAttribute(ATTRIBUTE_TABLE_NUM_ROWS_REPEATED,
Integer.toString(numEmptyRows));
// Append the row element to the root node
root.appendChild(rowElement);
// Open Office requires the empty row to have an empty cell (or cells)
addEmptyCells(numEmptyCells, rowElement);
// Write empty rows to the log
for (int i = 0; i < numEmptyRows; i++) {
Debug.log(Debug.TRACE, "
");
}
}
/**
* This method will add empty cells to the {@code Document}.
*
* It is called when the conversion process encounters a row that
* contains some cells without data.
*
* @param numColsSkipped The number of empty cells that we need to add to
* the current row.
* @param row The {@code Node} of the {@code Document} we are
* building that we will append our empty cell
* {@code Node} objects. This {@code Node} should
* be a {@code TAG_TABLE_ROW} tag.
*/
protected void addEmptyCells(int numColsSkipped, Node row) {
// Create an empty cellElement
Element cellElement = doc.createElement(TAG_TABLE_CELL);
// ToDo - style currently hardcoded - get real value
// Set cell style-name attribute
cellElement.setAttribute(ATTRIBUTE_TABLE_STYLE_NAME, "Default");
// If we skipped more than 1 cell, we must set the
// appropriate attribute
if (numColsSkipped > 1) {
// Set cell number-columns-repeated attribute
cellElement.setAttribute(ATTRIBUTE_TABLE_NUM_COLUMNS_REPEATED,
Integer.toString(numColsSkipped));
}
// Append the empty cell element to the row node
row.appendChild(cellElement);
// Write empty cells to the log
for (int i = 0; i < numColsSkipped; i++) {
Debug.log(Debug.TRACE, " | ");
}
}
/**
* This method process the data in a cell and sets the appropriate attributes
* on the cell {@code Element}.
*
* @param cellElement A {@code TAG_TABLE_CELL} {@code Element} that we
* will be adding attributes to based on the type of
* data in the cell.
* @param type The type of data contained in the cell.
* @param contents The contents of the data contained in the cell.
*/
protected void processCellData(Element cellElement, String type,
String contents) {
// Set cell value-type attribute
cellElement.setAttribute(ATTRIBUTE_TABLE_VALUE_TYPE, type);
// Does the cell contain a formula?
if (contents.startsWith("=")) {
cellElement.setAttribute(ATTRIBUTE_TABLE_FORMULA, contents);
cellElement.setAttribute(ATTRIBUTE_TABLE_VALUE, decoder.getCellValue());
// String data does not require any additional attributes
} else if (!type.equals(CELLTYPE_STRING)) {
if (type.equals(CELLTYPE_TIME)) {
// Data returned in StarOffice XML format, so store in
// attribute
cellElement.setAttribute(ATTRIBUTE_TABLE_TIME_VALUE,
contents);
} else if (type.equals(CELLTYPE_DATE)) {
// Data returned in StarOffice XML format, so store in
// attribute
cellElement.setAttribute(ATTRIBUTE_TABLE_DATE_VALUE,
contents);
} else if (type.equals(CELLTYPE_BOOLEAN)) {
// StarOffice XML format requires stored boolean value
// to be in lower case
cellElement.setAttribute(ATTRIBUTE_TABLE_BOOLEAN_VALUE,
contents.toLowerCase());
} else if (type.equals(CELLTYPE_CURRENCY)) {
// TODO - StarOffice XML format requires a correct style to
// display currencies correctly. Need to implement styles.
// TODO - USD is for US currencies. Need to pick up
// the correct currency location from the source file.
cellElement.setAttribute(ATTRIBUTE_TABLE_CURRENCY, "USD");
// Data comes stripped of currency symbols
cellElement.setAttribute(ATTRIBUTE_TABLE_VALUE, contents);
} else if (type.equals(CELLTYPE_PERCENT)) {
// Data comes stripped of percent signs
cellElement.setAttribute(ATTRIBUTE_TABLE_VALUE, contents);
} else {
// Remaining data types use table-value attribute
cellElement.setAttribute(ATTRIBUTE_TABLE_VALUE, contents);
}
}
}
}