Package adams.data.conversion

Class DoubleToString

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractConversionToString

adams.data.conversion.DoubleToString

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, LocaleSupporter, OptionHandlingLocaleSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, ConversionToString, Serializable

public class DoubleToString
extends AbstractConversionToString
implements OptionHandlingLocaleSupporter

Turns a Double into a String.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-num-decimals <int> (property: numDecimals)
    The number of decimals for numeric values to use; -1 uses Java's Double.toString
    () method.
    default: -1
    minimum: -1
 

-fixed-decimals (property: fixedDecimals)
    If enabled and 'num-decimals' is specified, a fixed number of decimals will 
    get output (incl. trailing zeroes), otherwise up-to 'num-decimals'.
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_FixedDecimals	whether to use a fixed number of decimals.
protected Locale	m_Locale	the locale to use.
protected int	m_NumDecimals	the number of decimals to use in the output.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

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
DoubleToString()

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
String	fixedDecimalsTipText()	Returns the tip text for this property.
boolean	getFixedDecimals()	Returns whether to always use a fixed number of decimals, incl trailing zeroes.
Locale	getLocale()	Returns the locale in use.
int	getNumDecimals()	Returns the number of decimals for numbers in tables.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	localeTipText()	Returns the tip text for this property.
String	numDecimalsTipText()	Returns the tip text for this property.
void	setFixedDecimals(boolean value)	Sets whether to always use a fixed number of decimals, incl trailing zeroes.
void	setLocale(Locale value)	Sets the locale to use.
void	setNumDecimals(int value)	Sets the number of decimals for numbers in tables.

Methods inherited from class adams.data.conversion.AbstractConversionToString

generates

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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.CleanUpHandler

cleanUp

Methods inherited from interface adams.data.conversion.Conversion

convert, getInput, getInput, getOutput, getOutput, getOwner, setInput, setOwner

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.core.Stoppable

stopExecution

Field Detail

m_Locale

protected Locale m_Locale

the locale to use.

m_NumDecimals

protected int m_NumDecimals

the number of decimals to use in the output.

m_FixedDecimals

protected boolean m_FixedDecimals

whether to use a fixed number of decimals.

Constructor Detail

DoubleToString

public DoubleToString()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setLocale

public void setLocale(Locale value)

Sets the locale to use.

Specified by:

setLocale in interface LocaleSupporter

Parameters:

value - the locale

getLocale

public Locale getLocale()

Returns the locale in use.

Specified by:

getLocale in interface LocaleSupporter

Returns:

the locale

localeTipText

public String localeTipText()

Returns the tip text for this property.

Specified by:

localeTipText in interface OptionHandlingLocaleSupporter

Returns:

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

setNumDecimals

public void setNumDecimals(int value)

Sets the number of decimals for numbers in tables.

Parameters:

value - the number of decimals

getNumDecimals

public int getNumDecimals()

Returns the number of decimals for numbers in tables.

Returns:

the number of decimals

numDecimalsTipText

public String numDecimalsTipText()

Returns the tip text for this property.

Returns:

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

setFixedDecimals

public void setFixedDecimals(boolean value)

Sets whether to always use a fixed number of decimals, incl trailing zeroes.

Parameters:

value - true to use fixed number

getFixedDecimals

public boolean getFixedDecimals()

Returns whether to always use a fixed number of decimals, incl trailing zeroes.

Returns:

true if fixed number used

fixedDecimalsTipText

public String fixedDecimalsTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractConversion

Returns:

null if no info available, otherwise short string

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion