adams.flow.transformer.plotgenerator
Class SimplePlotGenerator

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.transformer.plotgenerator.AbstractPlotGenerator
              adams.flow.transformer.plotgenerator.SimplePlotGenerator

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class SimplePlotGenerator
extends AbstractPlotGenerator

Plots the numeric data from one or more columns. The plot name is the column name and the X value is the row index.

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
 

-default-cell-value <double> (property: defaultCellValue)
    The default value for missing or non-numeric cells.
    default: -1.0
 

-columns <java.lang.String> (property: plotColumns)
    The range of columns to include in the plot; A range is a comma-separated 
    list of single 1-based indices or sub-ranges of indices ('start-end'); '
    inv(...)' inverts the range '...'; the following placeholders can be used 
    as well: first, second, third, last_2, last_1, last
    default: 
 

Version:

$Revision: 6518 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected Range

m_PlotColumns the columns to plot.

Fields inherited from class adams.flow.transformer.plotgenerator.AbstractPlotGenerator

m_DefaultCellValue, MISSING_CELL_VALUE

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SimplePlotGenerator()

Method Summary

protected void	check(SpreadSheet sheet) Checks the spreadsheet.
void	defineOptions() Adds options to the internal list of options.
protected List<SequencePlotterContainer>	doGenerate(SpreadSheet sheet) Performs the actual generation of containers.
String	getPlotColumns() Returns the current column range to use in the plot.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo() Returns a string describing the object.
protected void	initialize() Initializes the members.
String	plotColumnsTipText() Returns the tip text for this property.
void	setPlotColumns(String value) Sets the column range to use in the plot.

Methods inherited from class adams.flow.transformer.plotgenerator.AbstractPlotGenerator

defaultCellValueTipText, generate, getCellString, getCellValue, getDefaultCellValue, setDefaultCellValue

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Field Detail

m_PlotColumns

protected Range m_PlotColumns

the columns to plot.

Constructor Detail

SimplePlotGenerator

public SimplePlotGenerator()

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 AbstractPlotGenerator

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractPlotGenerator

Returns:

null if no info available, otherwise short string

setPlotColumns

public void setPlotColumns(String value)

Sets the column range to use in the plot.

Parameters:

value - the column range

getPlotColumns

public String getPlotColumns()

Returns the current column range to use in the plot.

Returns:

the column range

plotColumnsTipText

public String plotColumnsTipText()

Returns the tip text for this property.

Returns:

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

check

protected void check(SpreadSheet sheet)

Checks the spreadsheet.

Overrides:

check in class AbstractPlotGenerator

Parameters:

sheet - the sheet to check

doGenerate

protected List<SequencePlotterContainer> doGenerate(SpreadSheet sheet)

Performs the actual generation of containers.

Specified by:

doGenerate in class AbstractPlotGenerator

Parameters:

sheet - the basis for the containers

Returns:

the generated containers