adams.data.io.input
Class ExcelSpreadSheetReader

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.input.AbstractSpreadSheetReader
              adams.data.io.input.AbstractMultiSheetSpreadSheetReader
                  adams.data.io.input.AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport
                      adams.data.io.input.AbstractExcelSpreadSheetReader
                          adams.data.io.input.ExcelSpreadSheetReader

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, Stoppable, MultiSheetSpreadSheetReader, SpreadSheetReader, Serializable

public class ExcelSpreadSheetReader
extends AbstractExcelSpreadSheetReader

Reads MS Excel files (using DOM).

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-data-row-type <DENSE|SPARSE> (property: dataRowType)
    The type of row to use for the data.
    default: DENSE
 

-sheets <adams.core.Range> (property: sheetRange)
    The range of sheets to load; A range is a comma-separated list of single 
    1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts 
    the range '...'; the following placeholders can be used as well: first, 
    second, third, last_2, last_1, last
    default: first
 

-missing <java.lang.String> (property: missingValue)
    The placeholder for missing values.
    default: ?
 

-no-auto-extend-header (property: autoExtendHeader)
    If enabled, the header gets automatically extended if rows have more cells 
    than the header.
 

-text-columns <java.lang.String> (property: textColumns)
    The range of columns to treat as text; A range is a comma-separated list 
    of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(..
    .)' inverts the range '...'; the following placeholders can be used as well:
     first, second, third, last_2, last_1, last
    default: 
 

Version:

$Revision: 7023 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.io.input.AbstractSpreadSheetReader

AbstractSpreadSheetReader.InputType

Field Summary

Fields inherited from class adams.data.io.input.AbstractExcelSpreadSheetReader

m_AutoExtendHeader, m_TextColumns

Fields inherited from class adams.data.io.input.AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport

m_MissingValue

Fields inherited from class adams.data.io.input.AbstractMultiSheetSpreadSheetReader

m_SheetRange

Fields inherited from class adams.data.io.input.AbstractSpreadSheetReader

m_DataRowType, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

ExcelSpreadSheetReader()

Method Summary

protected List<SpreadSheet>	doReadRange(InputStream in) Reads the spreadsheet content from the specified file.
String	getFormatDescription() Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions() Returns the extension(s) of the format.
protected AbstractSpreadSheetReader.InputType	getInputType() Returns how to read the data, from a file, stream or reader.
String	globalInfo() Returns a string describing the object.
protected String	numericToString(org.apache.poi.ss.usermodel.Cell cell) Turns a numeric cell into a string.

Methods inherited from class adams.data.io.input.AbstractExcelSpreadSheetReader

autoExtendHeaderTipText, defineOptions, getAutoExtendHeader, getTextColumns, initialize, setAutoExtendHeader, setTextColumns, textColumnsTipText

Methods inherited from class adams.data.io.input.AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport

getMissingValue, missingValueTipText, setMissingValue

Methods inherited from class adams.data.io.input.AbstractMultiSheetSpreadSheetReader

doRead, doRead, doRead, doReadRange, doReadRange, getSheetRange, readRange, readRange, readRange, readRange, setSheetRange, sheetRangeTipText

Methods inherited from class adams.data.io.input.AbstractSpreadSheetReader

check, dataRowTypeTipText, getDataRowType, getDefaultDataRowType, getReaders, isStopped, read, read, read, read, setDataRowType, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.data.io.input.SpreadSheetReader

dataRowTypeTipText, getDataRowType, isStopped, read, read, read, read, setDataRowType, stopExecution

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.Destroyable

destroy

Constructor Detail

ExcelSpreadSheetReader

public ExcelSpreadSheetReader()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface SpreadSheetReader

Specified by:

getFormatDescription in class AbstractSpreadSheetReader

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface SpreadSheetReader

Specified by:

getFormatExtensions in class AbstractSpreadSheetReader

Returns:

the extension (without the dot!)

getInputType

protected AbstractSpreadSheetReader.InputType getInputType()

Returns how to read the data, from a file, stream or reader.

Specified by:

getInputType in class AbstractSpreadSheetReader

Returns:

how to read the data

numericToString

protected String numericToString(org.apache.poi.ss.usermodel.Cell cell)

Turns a numeric cell into a string. Tries to use "long" representation if possible.

Parameters:

cell - the cell to process

Returns:

the string representation

doReadRange

protected List<SpreadSheet> doReadRange(InputStream in)

Reads the spreadsheet content from the specified file.

Overrides:

doReadRange in class AbstractMultiSheetSpreadSheetReader

Parameters:

in - the input stream to read from

Returns:

the spreadsheets or null in case of an error