Package adams.data.conversion
Class SpreadSheetDoubleColumnToString
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.conversion.AbstractConversion
-
- adams.data.conversion.AbstractSpreadSheetConversion
-
- adams.data.conversion.AbstractInPlaceSpreadSheetConversion
-
- adams.data.conversion.AbstractSpreadSheetColumnConverter
-
- adams.data.conversion.SpreadSheetDoubleColumnToString
-
- All Implemented Interfaces:
AdditionalInformationHandler
,CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter
,SizeOfHandler
,Stoppable
,Conversion
,InPlaceProcessing
,Serializable
public class SpreadSheetDoubleColumnToString extends AbstractSpreadSheetColumnConverter
Converts the specified spreadsheet double column to 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
-column <adams.core.Index> (property: column) The double column to convert to string; An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last default: first
-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 int
m_NumDecimals
the number of decimals to in the output.-
Fields inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter
m_Column, m_KeepFailed
-
Fields inherited from class adams.data.conversion.AbstractInPlaceSpreadSheetConversion
m_NoCopy
-
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 SpreadSheetDoubleColumnToString()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
columnTipText()
Returns the tip text for this property.protected void
convert(Cell cellOld, Cell cellNew)
Converts the cell's content to a new format.void
defineOptions()
Adds options to the internal list of options.String
fixedDecimalsTipText()
Returns the tip text for this property.boolean
getFixedDecimals()
Returns whether to always use a fixed number of decimals, incl trailing zeroes.int
getNumDecimals()
Returns the number of decimals for numbers in tables.String
globalInfo()
Returns a string describing the object.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
setNumDecimals(int value)
Sets the number of decimals for numbers in tables.-
Methods inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter
convert, getColumn, getKeepFailed, keepFailedTipText, preConvert, setColumn, setKeepFailed
-
Methods inherited from class adams.data.conversion.AbstractInPlaceSpreadSheetConversion
getNoCopy, noCopyTipText, setNoCopy
-
Methods inherited from class adams.data.conversion.AbstractSpreadSheetConversion
accepts, doConvert, generates
-
Methods inherited from class adams.data.conversion.AbstractConversion
checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, 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.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractSpreadSheetColumnConverter
-
columnTipText
public String columnTipText()
Returns the tip text for this property.- Specified by:
columnTipText
in classAbstractSpreadSheetColumnConverter
- 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.
-
convert
protected void convert(Cell cellOld, Cell cellNew) throws Exception
Converts the cell's content to a new format.- Specified by:
convert
in classAbstractSpreadSheetColumnConverter
- Parameters:
cellOld
- the current cellcellNew
- the new cell with the converted content- Throws:
Exception
- if conversion fails
-
-