adams.data.conversion
Class SpreadSheetToHeatmap

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.conversion.AbstractConversion
              adams.data.conversion.SpreadSheetToHeatmap

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

public class SpreadSheetToHeatmap
extends AbstractConversion

Turns an all-numeric spreadsheet into a heatmap.
Missing values/cells are tolerated and replaced with the specified value for missing values.

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
 

-missing-value <double> (property: missingValue)
    The value to use in case of missing values/cells.
    default: 0.0
 

Version:

$Revision: 6057 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected double

m_MissingValue the default value for missing 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_DebugLevel, m_OptionManager

Constructor Summary

SpreadSheetToHeatmap()

Method Summary

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 value to use for missing values/celss.
String	globalInfo() Returns a string describing the object.
String	missingValueTipText() Returns the tip text for this property.
void	setMissingValue(double value) Sets the value to use for missing values/cells.

Methods inherited from class adams.data.conversion.AbstractConversion

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, 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

Field Detail

m_MissingValue

protected double m_MissingValue

the default value for missing values.

Constructor Detail

SpreadSheetToHeatmap

public SpreadSheetToHeatmap()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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

setMissingValue

public void setMissingValue(double value)

Sets the value to use for missing values/cells.

Parameters:

value - the value

getMissingValue

public double getMissingValue()

Returns the value to use for missing values/celss.

Returns:

the 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.

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

generates

public Class generates()

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates 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