Class SimplePlotGenerator
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.transformer.plotgenerator.AbstractPlotGenerator
-
- adams.flow.transformer.plotgenerator.SimplePlotGenerator
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,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.
-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:
-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 '...'; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last default:
-meta-data-columns <java.lang.String> (property: metaDataColumns) The range of columns to add as meta-data 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 '...'; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last default:
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected SpreadSheetColumnRange
m_MetaDataColumns
the meta-data columns.protected SpreadSheetColumnRange
m_PlotColumns
the columns to plot.-
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 SimplePlotGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods 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
getMetaDataColumns()
Returns the current column range to add as meta-data in the plot.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
metaDataColumnsTipText()
Returns the tip text for this property.String
plotColumnsTipText()
Returns the tip text for this property.void
setMetaDataColumns(String value)
Sets the column range to add as meta-data in the plot.void
setPlotColumns(String value)
Sets the column range to use in the plot.-
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_PlotColumns
protected SpreadSheetColumnRange m_PlotColumns
the columns to plot.
-
m_MetaDataColumns
protected SpreadSheetColumnRange m_MetaDataColumns
the meta-data columns.
-
-
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 classAbstractPlotGenerator
-
initialize
protected void initialize()
Initializes the members.- Overrides:
initialize
in classAbstractPlotGenerator
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractPlotGenerator
- 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.
-
setMetaDataColumns
public void setMetaDataColumns(String value)
Sets the column range to add as meta-data in the plot.- Parameters:
value
- the column range
-
getMetaDataColumns
public String getMetaDataColumns()
Returns the current column range to add as meta-data in the plot.- Returns:
- the column range
-
metaDataColumnsTipText
public String metaDataColumnsTipText()
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 classAbstractPlotGenerator
- Parameters:
sheet
- the sheet to check
-
doGenerate
protected List<SequencePlotterContainer> doGenerate(SpreadSheet sheet)
Performs the actual generation of containers.- Specified by:
doGenerate
in classAbstractPlotGenerator
- Parameters:
sheet
- the basis for the containers- Returns:
- the generated containers
-
-