Class GenericPlot2Task

  • All Implemented Interfaces:
    uk.ac.starlink.task.Task, DynamicTask

    public class GenericPlot2Task
    extends AbstractPlot2Task
    Generic plot2 task for STILTS. The plot type is determined from the environment using a Parameter. The resulting task is very flexible, but the details of the parameters that will actually be used cannot be determined in absence of the plot type (that is, before the Environment is available), so the task is not very good at describing its required parameters.
    Since:
    22 Aug 2014
    Author:
    Mark Taylor
    • Constructor Detail

      • GenericPlot2Task

        public GenericPlot2Task()
        Constructor.
    • Method Detail

      • getPurpose

        public java.lang.String getPurpose()
      • getParameters

        public uk.ac.starlink.task.Parameter<?>[] getParameters()
      • getPlotContext

        public PlotContext<?,​?> getPlotContext​(uk.ac.starlink.task.Environment env)
                                              throws uk.ac.starlink.task.TaskException
        Description copied from class: AbstractPlot2Task
        Concrete subclasses must implement this method to provide the PlotType and other information from the environment that may not be available at construction time.
        Specified by:
        getPlotContext in class AbstractPlot2Task
        Parameters:
        env - execution environment
        Returns:
        context
        Throws:
        uk.ac.starlink.task.TaskException
      • getConfigParamDefault

        protected <T> java.lang.String getConfigParamDefault​(uk.ac.starlink.task.Environment env,
                                                             ConfigKey<T> key,
                                                             java.lang.String[] suffixes)
        Description copied from class: AbstractPlot2Task
        May provide a default value for a given config parameter that is sensitive to the content of the execution environment. This is here to provide a hook for subclasses to set up defaults for some config parameters on the basis of what layers are present.
        Specified by:
        getConfigParamDefault in class AbstractPlot2Task
        Parameters:
        env - execution environment
        key - config key for which a parameter is required
        suffixes - ordered list of the plot layer suffixes in use for the plot being performed
        Returns:
        default for parameter getting value for key, or null if none is obvious