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.AbstractMultiSheetSpreadSheetReader
                  adams.data.io.input.AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport
                      adams.data.io.input.AbstractExcelSpreadSheetReader

All Implemented Interfaces:

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

Direct Known Subclasses:

ExcelSpreadSheetReader, ExcelStreamingSpreadSheetReader

public abstract class AbstractExcelSpreadSheetReader
extends AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport

Ancestor for special Excel readers.

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

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

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

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.
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	setTextColumns(String value) Sets the range of columns to treat as text.
String	textColumnsTipText() Returns the tip text for this property.

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, doReadRange, getSheetRange, readRange, readRange, readRange, readRange, setSheetRange, sheetRangeTipText

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

check, dataRowTypeTipText, getDataRowType, getDefaultDataRowType, getFormatDescription, getFormatExtensions, getInputType, getReaders, isStopped, 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

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

dataRowTypeTipText, getDataRowType, getFormatDescription, getFormatExtensions, 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

Field Detail

m_AutoExtendHeader

protected boolean m_AutoExtendHeader

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

m_TextColumns

protected 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 OptionHandler

Overrides:

defineOptions in class AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

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