OpenOffice.org
XMerge API

org.openoffice.xmerge.converter.xml.sxc
Class SpreadsheetDecoder

java.lang.Object
  |
  +--org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder

public abstract class SpreadsheetDecoder
extends java.lang.Object

This class is a abstract class for encoding a "Device" Document format into an alternative spreadsheet format.


Constructor Summary
SpreadsheetDecoder(java.lang.String name, java.lang.String password)
          Constructor for creating new SpreadsheetDecoder.
 
Method Summary
abstract  void addDeviceContent(ConvertData cd)
          Add the contents of a ConvertData to the workbook.
abstract  java.lang.String getCellContents()
          Return the contents of the active cell.
abstract  java.lang.String getCellDataType()
          Return the data type of the active cell.
abstract  Format getCellFormat()
          Return a Format object describing the active cells formatting.
abstract  int getColNumber()
          Returns the number of the active column.
abstract  int getNumberOfColumns()
          Returns the number of populated columns in the current WorkSheet.
abstract  int getNumberOfRows()
          Returns the number of populated rows in the current WorkSheet.
abstract  int getNumberOfSheets()
          Returns the total number of sheets in the WorkBook.
abstract  int getRowNumber()
          Returns the number of the active row.
abstract  java.lang.String getSheetName()
          Returns the name of the current WorkSheet.
abstract  boolean goToNextCell()
          Move on the next populated cell in the current WorkSheet.
abstract  void setWorksheet(int sheetIndex)
          Sets the active WorkSheet.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpreadsheetDecoder

public SpreadsheetDecoder(java.lang.String name,
                          java.lang.String password)
                   throws java.io.IOException
Constructor for creating new SpreadsheetDecoder.
Method Detail

addDeviceContent

public abstract void addDeviceContent(ConvertData cd)
                               throws java.io.IOException
Add the contents of a ConvertData to the workbook.
Parameters:
cd - The ConvertData containing the content.
Throws:
java.io.IOException - If any I/O error occurs.

getCellContents

public abstract java.lang.String getCellContents()
Return the contents of the active cell.
Returns:
The cell contents.

getCellDataType

public abstract java.lang.String getCellDataType()
Return the data type of the active cell.
Returns:
The cell data type.

getCellFormat

public abstract Format getCellFormat()
Return a Format object describing the active cells formatting.
Returns:
Format object for the cell.

getColNumber

public abstract int getColNumber()
Returns the number of the active column.
Returns:
The number of the active column.

getNumberOfColumns

public abstract int getNumberOfColumns()
Returns the number of populated columns in the current WorkSheet.
Returns:
The number of populated columns in the current WorkSheet.

getNumberOfRows

public abstract int getNumberOfRows()
Returns the number of populated rows in the current WorkSheet.
Returns:
the number of populated rows in the current WorkSheet.

getNumberOfSheets

public abstract int getNumberOfSheets()
Returns the total number of sheets in the WorkBook.
Returns:
The number of sheets in the WorkBook.

getRowNumber

public abstract int getRowNumber()
Returns the number of the active row.
Returns:
The number of the active row.

getSheetName

public abstract java.lang.String getSheetName()
Returns the name of the current WorkSheet.
Returns:
Name of the current WorkSheet.

goToNextCell

public abstract boolean goToNextCell()
                              throws java.io.IOException
Move on the next populated cell in the current WorkSheet.
Returns:
true if successful, false otherwise.
Throws:
java.io.IOException - If any I/O error occurs.

setWorksheet

public abstract void setWorksheet(int sheetIndex)
                           throws java.io.IOException
Sets the active WorkSheet.
Parameters:
sheetIndex - The index of the sheet to be made active.
Throws:
java.io.IOException - If any I/O error occurs.

OpenOffice.org
XMerge API

Copyright © 2002 OpenOffice.org