adams.data.io.output
Class AbstractMultiSheetFormattedSpreadSheetWriter

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
                      adams.data.io.output.AbstractMultiSheetFormattedSpreadSheetWriter

All Implemented Interfaces:

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

public abstract class AbstractMultiSheetFormattedSpreadSheetWriter
extends AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport

Ancestor for writers that format the numbers.

Version:

$Revision: 7025 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected NumberFormat	m_Formatter the formatter to use.
protected Locale	m_Locale the locale to use.
protected String	m_NumberFormat The format for the numbers.

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

m_MissingValue

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

AbstractMultiSheetFormattedSpreadSheetWriter()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected String	format(double value) Formats the number according to the format and returns the generated textual representation.
protected String	getDefaultNumberFormat() Returns the default number format.
Locale	getLocale() Returns the locale in use.
String	getNumberFormat() Returns the number format.
String	localeTipText() Returns the tip text for this property.
String	numberFormatTipText() Returns the tip text for this property.
void	setLocale(Locale value) Sets the locale to use.
void	setNumberFormat(String value) Sets the number format.

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

getDefaultMissingValue, getMissingValue, missingValueTipText, setMissingValue

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_Locale

protected Locale m_Locale

the locale to use.

m_NumberFormat

protected String m_NumberFormat

The format for the numbers.

m_Formatter

protected transient NumberFormat m_Formatter

the formatter to use.

Constructor Detail

AbstractMultiSheetFormattedSpreadSheetWriter

public AbstractMultiSheetFormattedSpreadSheetWriter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport

setLocale

public void setLocale(Locale value)

Sets the locale to use.

Parameters:

value - the locale

getLocale

public Locale getLocale()

Returns the locale in use.

Returns:

the locale

localeTipText

public String localeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getDefaultNumberFormat

protected String getDefaultNumberFormat()

Returns the default number format.

Returns:

the default format

setNumberFormat

public void setNumberFormat(String value)

Sets the number format.

Parameters:

value - the format

getNumberFormat

public String getNumberFormat()

Returns the number format.

Returns:

the format

numberFormatTipText

public String numberFormatTipText()

Returns the tip text for this property.

Returns:

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

format

protected String format(double value)

Formats the number according to the format and returns the generated textual representation.

Parameters:

value - the double value to turn into a string

Returns:

the generated string