Class 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 Detail

      • m_Chart

        protected ControlChart m_Chart
        the control chart to generate.
      • m_ViolationFinder

        protected ViolationFinder m_ViolationFinder
        for locating violations.
    • Constructor Detail

      • ControlChart

        public ControlChart()
    • Method Detail

      • 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 class AbstractChartGenerator
        Parameters:
        name - the name of the tab/sheet
        sheet - 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 class AbstractChartGenerator
        Parameters:
        flow - the flow to extend
        name - the name of the tab/sheet
        sheet - the spreadsheet to generate the flow for