Package adams.data.conversion
Class SpreadSheetToNumeric
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.conversion.AbstractConversion
-
- adams.data.conversion.SpreadSheetToNumeric
-
- All Implemented Interfaces:
AdditionalInformationHandler
,CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<AbstractConversion>
,SizeOfHandler
,Stoppable
,Conversion
,Serializable
public class SpreadSheetToNumeric extends AbstractConversion
Turns a spreadsheet into a purely numeric one.
Missing cells can get replaced with a specified value or skipped.
Booleans gets turned into 0/1 (false/true).
Date/time types get turned into numeric ones by using their Java epoch.
Strings (per column) get a 0-based index assigned in the order they appear.
Any other cell type get flagged as missing or, if provided, set to the unhandled value.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-replace-missing-cells <boolean> (property: replaceMissingCells) If enabled, missing cells get replaced with the specified value. default: false
-missing-value <double> (property: missingValue) The writer setup to use for generating the string. default: NaN
-unhandled <double> (property: unhandled) The replacement value for unhandled cell types. default: NaN
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected double
m_MissingValue
the replacement value for missing values.protected boolean
m_ReplaceMissingCells
whether to replace missing cells.protected double
m_Unhandled
the replacement value for unhandled values.-
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 SpreadSheetToNumeric()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.Class
generates()
Returns the class that is generated as output.double
getMissingValue()
Returns the replacement value for missing cells.String
getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.boolean
getReplaceMissingCells()
Returns whether to replace missing cells.double
getUnhandled()
Returns the replacement value for unhandled cell types.String
globalInfo()
Returns a string describing the object.String
missingValueTipText()
Returns the tip text for this property.String
replaceMissingCellsTipText()
Returns the tip text for this property.void
setMissingValue(double value)
Sets the replacement value for missing cells.void
setReplaceMissingCells(boolean value)
Sets whether to replace missing cells.void
setUnhandled(double value)
Sets the replacement value for unhandled cell types.String
unhandledTipText()
Returns the tip text for this property.-
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.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 classAbstractOptionHandler
-
setReplaceMissingCells
public void setReplaceMissingCells(boolean value)
Sets whether to replace missing cells.- Parameters:
value
- true if to replace
-
getReplaceMissingCells
public boolean getReplaceMissingCells()
Returns whether to replace missing cells.- Returns:
- true if to replace
-
replaceMissingCellsTipText
public String replaceMissingCellsTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setMissingValue
public void setMissingValue(double value)
Sets the replacement value for missing cells.- Parameters:
value
- the missing value
-
getMissingValue
public double getMissingValue()
Returns the replacement value for missing cells.- Returns:
- the missing value
-
missingValueTipText
public String missingValueTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setUnhandled
public void setUnhandled(double value)
Sets the replacement value for unhandled cell types.- Parameters:
value
- the unhandled value
-
getUnhandled
public double getUnhandled()
Returns the replacement value for unhandled cell types.- Returns:
- the unhandled value
-
unhandledTipText
public String unhandledTipText()
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 interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractConversion
- 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 interfaceConversion
- Specified by:
accepts
in classAbstractConversion
- Returns:
- the class
-
generates
public Class generates()
Returns the class that is generated as output.- Specified by:
generates
in interfaceConversion
- Specified by:
generates
in classAbstractConversion
- Returns:
- the class
-
doConvert
protected Object doConvert() throws Exception
Performs the actual conversion.- Specified by:
doConvert
in classAbstractConversion
- Returns:
- the converted data
- Throws:
Exception
- if something goes wrong with the conversion
-
-