adams.flow.transformer.plotgenerator
Class XYPlotGenerator

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

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class XYPlotGenerator
extends AbstractPlotGenerator

Uses one column for the X value and one or more other columns as Y to plot against.

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: 
 

-x-column <java.lang.String> (property: XColumn)
    The (optional) index of the column which values to use as X values in the 
    plot; An index is a number starting with 1; apart from column names (case-sensitive
    ), the following placeholders can be used as well: first, second, third, 
    last_2, last_1, last
    default: 
 

-prefix-columns <adams.data.spreadsheet.SpreadSheetColumnRange> (property: prefixColumns)
    The range of columns to prefix the plot name with; 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: 
 

-separator <java.lang.String> (property: separator)
    The separator to use between columns.
    default:  
 

Version:

$Revision: 6969 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected SpreadSheetColumnRange	m_PlotColumns the columns to plot.
protected SpreadSheetColumnRange	m_PrefixColumns the columns to prefix the plot name with.
protected String	m_Separator the separator string.
protected SpreadSheetColumnIndex	m_XColumn the (optional) column to use as X value.

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

XYPlotGenerator()

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.
SpreadSheetColumnRange	getPrefixColumns() Returns the current column range to generate the prefix of the plot with.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	getSeparator() Returns the separator in use between columns.
String	getXColumn() Returns the index of the column which values to use as X values.
String	globalInfo() Returns a string describing the object.
protected void	initialize() Initializes the members.
String	plotColumnsTipText() Returns the tip text for this property.
String	prefixColumnsTipText() Returns the tip text for this property.
String	separatorTipText() Returns the tip text for this property.
void	setPlotColumns(String value) Sets the column range to use in the plot.
void	setPrefixColumns(SpreadSheetColumnRange value) Sets the column range to generate the prefix of the plot with.
void	setSeparator(String value) Missing tooltip: adams.flow.transformer.plotgenerator.XYPlotGenerator.separatorTipText Sets the separator to use between columns.
void	setXColumn(String value) Sets the index of the column which values to use as X values.
String	XColumnTipText() Returns the tip text for this property.

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 SpreadSheetColumnRange m_PlotColumns

the columns to plot.

m_XColumn

protected SpreadSheetColumnIndex m_XColumn

the (optional) column to use as X value.

m_PrefixColumns

protected SpreadSheetColumnRange m_PrefixColumns

the columns to prefix the plot name with.

m_Separator

protected String m_Separator

the separator string.

Constructor Detail

XYPlotGenerator

public XYPlotGenerator()

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.

setXColumn

public void setXColumn(String value)

Sets the index of the column which values to use as X values.

Parameters:

value - the column index

getXColumn

public String getXColumn()

Returns the index of the column which values to use as X values.

Returns:

the column index

XColumnTipText

public String XColumnTipText()

Returns the tip text for this property.

Returns:

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

setPrefixColumns

public void setPrefixColumns(SpreadSheetColumnRange value)

Sets the column range to generate the prefix of the plot with.

Parameters:

value - the column range

getPrefixColumns

public SpreadSheetColumnRange getPrefixColumns()

Returns the current column range to generate the prefix of the plot with.

Returns:

the column range

prefixColumnsTipText

public String prefixColumnsTipText()

Returns the tip text for this property.

Returns:

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

setSeparator

public void setSeparator(String value)

Missing tooltip: adams.flow.transformer.plotgenerator.XYPlotGenerator.separatorTipText Sets the separator to use between columns.

Parameters:

value - the separator

getSeparator

public String getSeparator()

Returns the separator in use between columns.

Returns:

the separator

separatorTipText

public String separatorTipText()

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