Class HistogramPlotStateFactory


  • public class HistogramPlotStateFactory
    extends PlotStateFactory
    PlotStateFactory for a histogram plot.
    Since:
    15 Aug 2008
    Author:
    Mark Taylor
    • Constructor Detail

      • HistogramPlotStateFactory

        public HistogramPlotStateFactory()
        Constructor.
    • Method Detail

      • getParameters

        public uk.ac.starlink.task.Parameter<?>[] getParameters()
        Description copied from class: PlotStateFactory
        Returns the parameters associated with this object. The returned list is intended for external use in documentation; the parameter objects returned may or may not be those used for obtaining values from a particular execution environment. For this reason they may have names which are symbolic, that is, represent possible parameter names. Since actual parameter names are dynamically determined from other parameter names, it is not possible to return an exhaustive list.
        Overrides:
        getParameters in class PlotStateFactory
        Returns:
        array of parameters to be used for documentation
      • configurePlotState

        protected void configurePlotState​(PlotState pstate,
                                          uk.ac.starlink.task.Environment env)
                                   throws uk.ac.starlink.task.TaskException
        Description copied from class: PlotStateFactory
        Configures a PlotState object by examining parameter values in a given execution environment. Such an object was presumably previously created by a call to PlotStateFactory.createPlotState().
        Overrides:
        configurePlotState in class PlotStateFactory
        Parameters:
        pstate - plot state to configure
        env - execution environment
        Throws:
        uk.ac.starlink.task.TaskException
      • createPlotData

        protected TablePlotData createPlotData​(uk.ac.starlink.task.Environment env,
                                               java.lang.String tLabel,
                                               uk.ac.starlink.table.StarTable table,
                                               java.lang.String[] setExprs,
                                               java.lang.String[] setNames,
                                               Style[] setStyles,
                                               java.lang.String labelExpr,
                                               java.lang.String[] coordExprs,
                                               java.lang.String[] errExprs)
                                        throws uk.ac.starlink.task.TaskException,
                                               gnu.jel.CompilationException
        Description copied from class: PlotStateFactory
        Constructs a PlotData object. Called by PlotStateFactory.configurePlotState(uk.ac.starlink.ttools.plot.PlotState, uk.ac.starlink.task.Environment); may be overridden by subclasses.
        Overrides:
        createPlotData in class PlotStateFactory
        Parameters:
        env - execution environment
        tLabel - table identifier suffix
        table - input table
        setExprs - nset-element JEL boolean-valued expression array for set inclusion
        setNames - nset-element set name array
        setStyles - nset-elemnt set style array
        labelExpr - JEL expression for text label
        coordExprs - ndim-element JEL double-valued expression array for coordinate values
        errExprs - nerr-element expression(s) array for error values
        Returns:
        new PlotData object based on parameters
        Throws:
        uk.ac.starlink.task.TaskException
        gnu.jel.CompilationException
      • createStyleFactory

        protected StyleFactory createStyleFactory​(java.lang.String prefix)
        Description copied from class: PlotStateFactory
        Constructs a style factory which can retrieve a plotting style suitable for use with this factory from the environment.
        Overrides:
        createStyleFactory in class PlotStateFactory
        Parameters:
        prefix - prefix to use for all style-type variables
      • configureFromBounds

        protected void configureFromBounds​(PlotState pstate,
                                           DataBounds bounds)
        Description copied from class: PlotStateFactory
        Updates a plot state generated by this factory with information generated from a first pass through the data.
        Overrides:
        configureFromBounds in class PlotStateFactory
        Parameters:
        pstate - plot state to update
        bounds - data bounds calculated by a pass through the data