adams.data.io.input
Class AbstractExcelSpreadSheetReader

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.input.AbstractSpreadSheetReader
              adams.data.io.input.AbstractSpreadSheetReaderWithMissingValueSupport
                  adams.data.io.input.AbstractExcelSpreadSheetReader

All Implemented Interfaces:

adams.core.Debuggable, adams.core.Destroyable, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.core.Stoppable, Serializable

Direct Known Subclasses:

ExcelSAXSpreadSheetReader, ExcelSpreadSheetReader

public abstract class AbstractExcelSpreadSheetReader
extends adams.data.io.input.AbstractSpreadSheetReaderWithMissingValueSupport

Ancestor for special Excel readers.

Version:

$Revision: 6317 $

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

adams.data.io.input.AbstractSpreadSheetReader.InputType

Field Summary

protected boolean	m_AutoExtendHeader whether to automatically extend the header if rows have more cells than header.
protected adams.core.Index	m_SheetIndex the sheet to load.
protected adams.core.Range	m_TextColumns the range of columns to force to be text.

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

m_MissingValue

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

AbstractExcelSpreadSheetReader()

Method Summary

String	autoExtendHeaderTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
boolean	getAutoExtendHeader() Returns whether to extend the header if rows have more cells than the header.
adams.core.Index	getSheetIndex() Returns the index of the sheet to load.
String	getTextColumns() Returns the range of columns to treat as text.
protected void	initialize() Initializes the members.
void	setAutoExtendHeader(boolean value) Sets whether to extend the header if rows have more cells than the header.
void	setSheetIndex(adams.core.Index value) Sets the index of the sheet to load.
void	setTextColumns(String value) Sets the range of columns to treat as text.
String	sheetIndexTipText() Returns the tip text for this property.
String	textColumnsTipText() Returns the tip text for this property.

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

getMissingValue, missingValueTipText, setMissingValue

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

dataRowTypeTipText, doRead, doRead, doRead, getDataRowType, getFormatDescription, getFormatExtensions, getInputType, getReaders, read, read, read, read, setDataRowType, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, globalInfo, 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

Field Detail

m_SheetIndex

protected adams.core.Index m_SheetIndex

the sheet to load.

m_AutoExtendHeader

protected boolean m_AutoExtendHeader

whether to automatically extend the header if rows have more cells than header.

m_TextColumns

protected adams.core.Range m_TextColumns

the range of columns to force to be text.

Constructor Detail

AbstractExcelSpreadSheetReader

public AbstractExcelSpreadSheetReader()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.data.io.input.AbstractSpreadSheetReaderWithMissingValueSupport

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class adams.core.option.AbstractOptionHandler

setSheetIndex

public void setSheetIndex(adams.core.Index value)

Sets the index of the sheet to load.

Parameters:

value - the index (1-based)

getSheetIndex

public adams.core.Index getSheetIndex()

Returns the index of the sheet to load.

Returns:

the index (1-based)

sheetIndexTipText

public String sheetIndexTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setAutoExtendHeader

public void setAutoExtendHeader(boolean value)

Sets whether to extend the header if rows have more cells than the header.

Parameters:

value - if true then the header gets extended if necessary

getAutoExtendHeader

public boolean getAutoExtendHeader()

Returns whether to extend the header if rows have more cells than the header.

Returns:

true if the header gets extended if necessary

autoExtendHeaderTipText

public String autoExtendHeaderTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setTextColumns

public void setTextColumns(String value)

Sets the range of columns to treat as text.

Parameters:

value - the range of columns

getTextColumns

public String getTextColumns()

Returns the range of columns to treat as text.

Returns:

the range of columns

textColumnsTipText

public String textColumnsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui