adams.data.io.input
Class AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GnumericSpreadSheetReader

public abstract class AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport
extends AbstractMultiSheetSpreadSheetReader

Ancestor for spreadsheet readers that allow the specification of a custom missing value string.

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 String

m_MissingValue The placeholder for missing values.

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

AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport()

Method Summary

void	defineOptions() Adds options to the internal list of options.
String	getMissingValue() Returns the current placeholder for missing values.
String	missingValueTipText() Returns the tip text for this property.
void	setMissingValue(String value) Sets the placeholder for missing values.

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, initialize, 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_MissingValue

protected String m_MissingValue

The placeholder for missing values.

Constructor Detail

AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport

public AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractMultiSheetSpreadSheetReader

setMissingValue

public void setMissingValue(String value)

Sets the placeholder for missing values.

Parameters:

value - the placeholder

getMissingValue

public String getMissingValue()

Returns the current placeholder for missing values.

Returns:

the placeholder

missingValueTipText

public String missingValueTipText()

Returns the tip text for this property.

Returns:

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