adams.data.io.output
Class AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.output.AbstractSpreadSheetWriter
              adams.data.io.output.AbstractMultiSheetSpreadSheetWriter
                  adams.data.io.output.AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, MultiSheetSpreadSheetWriter, SpreadSheetWriter, Serializable

Direct Known Subclasses:

AbstractMultiSheetFormattedSpreadSheetWriter, GnumericSpreadSheetWriter

public abstract class AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport
extends AbstractMultiSheetSpreadSheetWriter

Ancestor for spreadsheet writers that support missing values.

Version:

$Revision: 7025 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected String

m_MissingValue The placeholder for missing values.

Fields inherited from class adams.data.io.output.AbstractMultiSheetSpreadSheetWriter

m_SheetPrefix

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected String	getDefaultMissingValue() Returns the default missing value.
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.output.AbstractMultiSheetSpreadSheetWriter

doWrite, doWrite, doWrite, doWrite, getDefaultSheetPrefix, getSheetPrefix, setSheetPrefix, sheetPrefixTipText, write, write, write, write

Methods inherited from class adams.data.io.output.AbstractSpreadSheetWriter

getFormatDescription, getFormatExtensions, getUseOutputStream, getWriters, write, write, write, write

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.output.SpreadSheetWriter

getFormatDescription, getFormatExtensions, write, write, write, write

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

AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport

public AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractMultiSheetSpreadSheetWriter

getDefaultMissingValue

protected String getDefaultMissingValue()

Returns the default missing value.

Returns:

the default for missing values

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