|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.task.AbstractPlot2Task
uk.ac.starlink.ttools.plot2.task.GenericPlot2Task
public class GenericPlot2Task
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.
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
|
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 |
---|
public GenericPlot2Task()
Method Detail |
---|
public String getPurpose()
Task
public Parameter[] getParameters()
Task
public PlotContext getPlotContext(Environment env) throws TaskException
AbstractPlot2Task
getPlotContext
in class AbstractPlot2Task
env
- execution environment
TaskException
protected <T> ConfigParameter createConfigParameter(Environment env, ConfigKey<T> key, String[] suffixes)
AbstractPlot2Task
createConfigParameter
in class AbstractPlot2Task
env
- execution environmentkey
- config key for which a parameter is requiredsuffixes
- ordered list of the plot layer suffixes
in use for the plot being performed
key
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |