Class ControlChart
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.gui.tools.spreadsheetviewer.chart.AbstractChartGenerator
-
- adams.gui.tools.spreadsheetviewer.chart.ControlChart
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,SizeOfHandler
,Serializable
public class ControlChart extends AbstractChartGenerator
Generates the specified control chart from the data.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-width <int> (property: width) The width of the chart dialog. default: 800 minimum: -1
-height <int> (property: height) The height of the chart dialog. default: 600 minimum: -1
-columns <java.lang.String> (property: columns) The columns to generate the control chart(s) for; 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:
-chart <adams.data.spc.ControlChart> (property: chart) The control chart to generate. default: adams.data.spc.CChart
-violation-finder <adams.data.spc.ViolationFinder> (property: violationFinder) The algorithm for locating violations. default: adams.data.spc.NullViolations
- Version:
- $Revision$
- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected ControlChart
m_Chart
the control chart to generate.protected SpreadSheetColumnRange
m_Columns
the column(s) to generate the chart(s) for.protected ViolationFinder
m_ViolationFinder
for locating violations.-
Fields inherited from class adams.gui.tools.spreadsheetviewer.chart.AbstractChartGenerator
m_Height, m_Width, STORAGE_NAME
-
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 ControlChart()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addChartGeneration(Flow flow, String name, SpreadSheet sheet)
Adds the chart generation to the flow.String
chartTipText()
Returns the tip text for this property.protected void
check(String name, SpreadSheet sheet)
Checks whether the spreadsheet can be processed.String
columnsTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.ControlChart
getChart()
Returns the control chart to generate.String
getColumns()
Returns the column range to use for the chart(s).String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.ViolationFinder
getViolationFinder()
Returns the algorithm for locating violations.String
globalInfo()
Returns a string describing the object.protected void
initialize()
Initializes the members.void
setChart(ControlChart value)
Sets the control chart to generate.void
setColumns(String value)
Sets the column range to use for the chart(s).void
setViolationFinder(ViolationFinder value)
Sets the algorithm for locating violations.String
violationFinderTipText()
Returns the tip text for this property.-
Methods inherited from class adams.gui.tools.spreadsheetviewer.chart.AbstractChartGenerator
columnTypesToAxisType, columnTypesToTickGenerator, columnTypeToAxisType, columnTypeToTickGenerator, doGenerate, generate, getDefaultHeight, getDefaultWidth, getHeight, getWidth, heightTipText, setHeight, setWidth, widthTipText
-
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_Chart
protected ControlChart m_Chart
the control chart to generate.
-
m_ViolationFinder
protected ViolationFinder m_ViolationFinder
for locating violations.
-
m_Columns
protected SpreadSheetColumnRange m_Columns
the column(s) to generate the chart(s) for.
-
-
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 classAbstractChartGenerator
-
initialize
protected void initialize()
Initializes the members.- Overrides:
initialize
in classAbstractOptionHandler
-
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 classAbstractChartGenerator
- Returns:
- null if no info available, otherwise short string
-
setChart
public void setChart(ControlChart value)
Sets the control chart to generate.- Parameters:
value
- the chart
-
getChart
public ControlChart getChart()
Returns the control chart to generate.- Returns:
- the chart
-
chartTipText
public String chartTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setViolationFinder
public void setViolationFinder(ViolationFinder value)
Sets the algorithm for locating violations.- Parameters:
value
- the algorithm
-
getViolationFinder
public ViolationFinder getViolationFinder()
Returns the algorithm for locating violations.- Returns:
- the algorithm
-
violationFinderTipText
public String violationFinderTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setColumns
public void setColumns(String value)
Sets the column range to use for the chart(s).- Parameters:
value
- the column range
-
getColumns
public String getColumns()
Returns the column range to use for the chart(s).- Returns:
- the column range
-
columnsTipText
public String columnsTipText()
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(String name, SpreadSheet sheet)
Checks whether the spreadsheet can be processed.- Overrides:
check
in classAbstractChartGenerator
- Parameters:
name
- the name of the tab/sheetsheet
- the spreadsheet to check
-
addChartGeneration
protected void addChartGeneration(Flow flow, String name, SpreadSheet sheet)
Adds the chart generation to the flow. The flow already contains forwarding of spreadsheet and selecting subset of rows.- Specified by:
addChartGeneration
in classAbstractChartGenerator
- Parameters:
flow
- the flow to extendname
- the name of the tab/sheetsheet
- the spreadsheet to generate the flow for
-
-