Package adams.data.io.input

Class AbstractSpreadSheetReaderWithMissingValueSupport

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractSpreadSheetReader

adams.data.io.input.AbstractSpreadSheetReaderWithMissingValueSupport

All Implemented Interfaces:

AdditionalInformationHandler, Destroyable, ErrorProvider, GlobalInfoSupporter, EncodingSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, MissingValueSpreadSheetReader, SpreadSheetReader, DataRowTypeHandler, SpreadSheetTypeHandler, Serializable

Direct Known Subclasses:

AutoWidthTabularSpreadSheetReader, CsvSpreadSheetReader, FastCsvSpreadSheetReader, FixedTabularSpreadSheetReader, SimpleCsvSpreadSheetReader

public abstract class AbstractSpreadSheetReaderWithMissingValueSupport
extends AbstractSpreadSheetReader
implements MissingValueSpreadSheetReader

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

Version:

$Revision$

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

Modifier and Type	Field	Description
protected BaseRegExp	m_MissingValue	The placeholder for missing values.

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

m_DataRowType, m_Encoding, m_LastError, m_SpreadSheetType, m_Stopped, OPTION_INPUT, OPTION_OUTPUT

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractSpreadSheetReaderWithMissingValueSupport()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected BaseRegExp	getDefaultMissingValue()	Returns the default missing value to use.
BaseRegExp	getMissingValue()	Returns the current placeholder for missing values.
String	missingValueTipText()	Returns the tip text for this property.
void	setMissingValue(BaseRegExp value)	Sets the placeholder for missing values.

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

canDecompress, check, dataRowTypeTipText, doRead, doRead, doRead, encodingTipText, getAdditionalInformation, getDataRowType, getDefaultDataRowType, getDefaultFormatExtension, getDefaultSpreadSheet, getEncoding, getFormatDescription, getFormatExtensions, getInputType, getLastError, getReaders, getSpreadSheetType, hasLastError, initialize, isStopped, read, read, read, read, runReader, setDataRowType, setEncoding, setLastError, setSpreadSheetType, spreadSheetTypeTipText, stopExecution, supportsCompressedInput

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

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

dataRowTypeTipText, getCorrespondingWriter, getDataRowType, getDefaultFormatExtension, getFormatDescription, getFormatExtensions, getLastError, getSpreadSheetType, hasLastError, isStopped, read, read, read, read, setDataRowType, setSpreadSheetType, spreadSheetTypeTipText, stopExecution

Field Detail

m_MissingValue

protected BaseRegExp m_MissingValue

The placeholder for missing values.

Constructor Detail

AbstractSpreadSheetReaderWithMissingValueSupport

public AbstractSpreadSheetReaderWithMissingValueSupport()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractSpreadSheetReader

getDefaultMissingValue

protected BaseRegExp getDefaultMissingValue()

Returns the default missing value to use.

Returns:

the default

setMissingValue

public void setMissingValue(BaseRegExp value)

Sets the placeholder for missing values.

Specified by:

setMissingValue in interface MissingValueSpreadSheetReader

Parameters:

value - the placeholder

getMissingValue

public BaseRegExp getMissingValue()

Returns the current placeholder for missing values.

Specified by:

getMissingValue in interface MissingValueSpreadSheetReader

Returns:

the placeholder

missingValueTipText

public String missingValueTipText()

Returns the tip text for this property.

Specified by:

missingValueTipText in interface MissingValueSpreadSheetReader

Returns:

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