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

This. More...

Public Member Functions

abstract int getNumberOfSheets ()
 Returns the total number of sheets in the WorkBook. More...
 
abstract Iterator< NameDefinitiongetNameDefinitions ()
 Returns an Enumeration to a Vector of. More...
 
abstract BookSettings getSettings ()
 Returns the. More...
 
abstract Iterator< ColumnRowInfogetColumnRowInfos ()
 Returns an Enumeration to a Vector of. More...
 
abstract int getNumberOfRows ()
 Returns the number of populated rows in the current WorkSheet. More...
 
abstract int getNumberOfColumns ()
 Returns the number of populated columns in the current WorkSheet. More...
 
abstract String getSheetName ()
 Returns the name of the current WorkSheet. More...
 
abstract int getColNumber ()
 Returns the number of the active column. More...
 
abstract int getRowNumber ()
 Returns the number of the active row. More...
 
abstract void setWorksheet (int sheetIndex) throws IOException
 Sets the active WorkSheet. More...
 
abstract boolean goToNextCell () throws IOException
 Move on the next populated cell in the current WorkSheet. More...
 
abstract String getCellContents ()
 Return the contents of the active cell. More...
 
abstract String getCellValue ()
 Return the value of the active cell. More...
 
abstract String getCellDataType ()
 Return the data type of the active cell. More...
 
abstract Format getCellFormat ()
 Return a. More...
 
abstract void addDeviceContent (ConvertData cd) throws IOException
 Add the contents of a. More...
 

Detailed Description

This.

class

is a

abstract class

for encoding a "Device"

format into an alternative spreadsheet format.

Definition at line 30 of file SpreadsheetDecoder.java.

Member Function Documentation

abstract void org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.addDeviceContent ( ConvertData  cd) throws IOException
abstract

Add the contents of a.

to the workbook.

Parameters
cdThe containing the content.
Exceptions
IOExceptionIf any I/O error occurs.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.deserialize().

abstract String org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getCellContents ( )
abstract

Return the contents of the active cell.

Returns
The cell contents.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

abstract String org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getCellDataType ( )
abstract

Return the data type of the active cell.

Returns
The cell data type.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

abstract Format org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getCellFormat ( )
abstract

Return a.

object describing the active cells formatting.

Returns
object for the cell.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

abstract String org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getCellValue ( )
abstract

Return the value of the active cell.

Used in the case of Formula where the cell contents and the cell value are not the same thing.

Returns
The cell value.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCellData().

abstract int org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getColNumber ( )
abstract

Returns the number of the active column.

Returns
The number of the active column.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

abstract Iterator<ColumnRowInfo> org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getColumnRowInfos ( )
abstract
abstract Iterator<NameDefinition> org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getNameDefinitions ( )
abstract

Returns an Enumeration to a Vector of.

NameDefinition

.

Returns
The Enumeration.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.decode().

abstract int org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getNumberOfColumns ( )
abstract

Returns the number of populated columns in the current WorkSheet.

Returns
The number of populated columns in the current WorkSheet.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

abstract int org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getNumberOfRows ( )
abstract

Returns the number of populated rows in the current WorkSheet.

Returns
the number of populated rows in the current WorkSheet.
abstract int org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getNumberOfSheets ( )
abstract

Returns the total number of sheets in the WorkBook.

Returns
The number of sheets in the WorkBook.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.decode().

abstract int org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getRowNumber ( )
abstract

Returns the number of the active row.

Returns
The number of the active row.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

abstract BookSettings org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getSettings ( )
abstract
abstract String org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.getSheetName ( )
abstract

Returns the name of the current WorkSheet.

Returns
Name of the current WorkSheet.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processTable().

abstract boolean org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.goToNextCell ( ) throws IOException
abstract

Move on the next populated cell in the current WorkSheet.

Returns
true
if successful,
false
otherwise.
Exceptions
IOExceptionIf any I/O error occurs.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

abstract void org.openoffice.xmerge.converter.xml.sxc.SpreadsheetDecoder.setWorksheet ( int  sheetIndex) throws IOException
abstract

Sets the active WorkSheet.

Parameters
sheetIndexThe index of the sheet to be made active.
Exceptions
IOExceptionIf any I/O error occurs.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.decode().


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