Package adams.flow.transformer.plotgenerator

Class NamedPlotGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.plotgenerator.AbstractPlotGenerator

adams.flow.transformer.plotgenerator.NamedPlotGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class NamedPlotGenerator
extends AbstractPlotGenerator

Plots the numeric data of two columns, X and Y with the plot name from a separate column.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

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

-plot-name-range <java.lang.String> (property: plotNameRange)
    The range of columns to use for generating the plot name (overrides any 
    plot generator specific names); A range is a comma-separated list of single 
    1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts 
    the range '...'; column names (case-sensitive) as well as the following 
    placeholders can be used: first, second, third, last_2, last_1, last
    default: 
 

-plot-name-separator <java.lang.String> (property: plotNameSeparator)
    The separator to use when constructing the plot name from cell values.
    default: 
 

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

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

-name-column <java.lang.String> (property: nameColumn)
    The index of the column which values to use as for naming the plots; An 
    index is a number starting with 1; column names (case-sensitive) as well 
    as the following placeholders can be used: first, second, third, last_2, 
    last_1, last
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnIndex	m_NameColumn	the column for the plot name.
protected SpreadSheetColumnIndex	m_XColumn	the X column.
protected SpreadSheetColumnIndex	m_YColumn	the Y column.

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

m_DefaultCellValue, m_PlotNameRange, m_PlotNameSeparator, MISSING_CELL_VALUE

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
NamedPlotGenerator()

Method Summary

Modifier and Type	Method	Description
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	getNameColumn()	Returns the index of the column which values to use to name the plots.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	getXColumn()	Returns the index of the column which values to use as X values.
String	getYColumn()	Returns the index of the column which values to use as Y values.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	nameColumnTipText()	Returns the tip text for this property.
void	setNameColumn(String value)	Sets the index of the column which values to use to name the plots.
void	setXColumn(String value)	Sets the index of the column which values to use as X values.
void	setYColumn(String value)	Sets the index of the column which values to use as Y values.
String	XColumnTipText()	Returns the tip text for this property.
String	YColumnTipText()	Returns the tip text for this property.

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

defaultCellValueTipText, generate, getActualPlotName, getCellObject, getCellString, getCellValue, getCellValue, getDefaultCellValue, getPlotNameRange, getPlotNameSeparator, plotNameRangeTipText, plotNameSeparatorTipText, setDefaultCellValue, setPlotNameRange, setPlotNameSeparator

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, 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

Field Detail

m_XColumn

protected SpreadSheetColumnIndex m_XColumn

the X column.

m_YColumn

protected SpreadSheetColumnIndex m_YColumn

the Y column.

m_NameColumn

protected SpreadSheetColumnIndex m_NameColumn

the column for the plot name.

Constructor Detail

NamedPlotGenerator

public NamedPlotGenerator()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

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 AbstractPlotGenerator

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

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.

setYColumn

public void setYColumn(String value)

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

Parameters:

value - the column index

getYColumn

public String getYColumn()

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

Returns:

the column index

YColumnTipText

public String YColumnTipText()

Returns the tip text for this property.

Returns:

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

setNameColumn

public void setNameColumn(String value)

Sets the index of the column which values to use to name the plots.

Parameters:

value - the column index

getNameColumn

public String getNameColumn()

Returns the index of the column which values to use to name the plots.

Returns:

the column index

nameColumnTipText

public String nameColumnTipText()

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