uk.ac.starlink.ttools.plot2.task
Class GenericPlot2Task

java.lang.Object
  extended by uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task
      extended by uk.ac.starlink.ttools.plot2.task.GenericPlot2Task
All Implemented Interfaces:
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

Field Summary
 
Fields inherited from class uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task
EXAMPLE_LAYER_SUFFIX, LAYER_PREFIX
 
Constructor Summary
GenericPlot2Task()
          Constructor.
 
Method Summary
protected
<T> ConfigParameter
createConfigParameter(Environment env, ConfigKey<T> key, String[] suffixes)
          Returns a config parameter for a given config key that may be sensitive to the content of the execution environment.
 Parameter[] getParameters()
          Returns the list of parameters which may be used by this task.
 PlotContext getPlotContext(Environment env)
          Concrete subclasses must implement this method to provide the PlotType and other information from the environment that may not be available at construction time.
 String getPurpose()
          Returns a short (one-line) description of the purpose of this task.
 
Methods inherited from class uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task
createDataParameter, createExecutable, createFilterParameter, createLabelParameter, createLayerTypeParameter, createPlotComponent, createPlotIcon, createPlotIcon, createTableParameter, getBasicParameters, getContextParameters, getKeyParams, getParameterByName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenericPlot2Task

public GenericPlot2Task()
Constructor.

Method Detail

getPurpose

public String getPurpose()
Description copied from interface: Task
Returns a short (one-line) description of the purpose of this task.

Returns:
plain text description of this task's purpose

getParameters

public Parameter[] getParameters()
Description copied from interface: Task
Returns the list of parameters which may be used by this task.

Returns:
an array of the Parameter objects this task may request values for during its invocation

getPlotContext

public PlotContext getPlotContext(Environment env)
                           throws 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:
TaskException

createConfigParameter

protected <T> ConfigParameter createConfigParameter(Environment env,
                                                    ConfigKey<T> key,
                                                    String[] suffixes)
Description copied from class: AbstractPlot2Task
Returns a config parameter for a given config key that may be 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:
createConfigParameter 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:
parameter to get the value of key


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.