|
|||||||||
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.TypedPlot2Task
public class TypedPlot2Task
Plot2 task specialised for a fixed PlotType. Knowing the PlotType up front doesn't make it more capable, but it allows much more parameter auto-documentation to be done than if the PlotType is determined only from the Environment.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task |
---|
EXAMPLE_LAYER_SUFFIX, LAYER_PREFIX |
Constructor Summary | |
---|---|
TypedPlot2Task(PlotType plotType,
Map<ConfigKey<String>,Input> axlabelMap)
Constructs a plot task with a default plot context. |
|
TypedPlot2Task(PlotType plotType,
Map<ConfigKey<String>,Input> axlabelMap,
PlotContext context)
Constructs a plot task with a supplied PlotContext. |
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()
Returns the fixed plot context for 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 TypedPlot2Task(PlotType plotType, Map<ConfigKey<String>,Input> axlabelMap, PlotContext context)
The axlabelMap
parameter gives the chance to set
up a correspondence between axis label config keys and the coordinates
to which they correspond. If this is done, then the names of the
data values actually supplied to the task can be used as defaults
for the axis labels.
plotType
- fixed plot typeaxlabelMap
- mapping from axis label keys to corresponding
common data input coordinates, or nullcontext
- fixed plot contextpublic TypedPlot2Task(PlotType plotType, Map<ConfigKey<String>,Input> axlabelMap)
The axlabelMap
parameter gives the chance to set
up a correspondence between axis label config keys and the coordinates
to which they correspond. If this is done, then the names of the
data values actually supplied to the task can be used as defaults
for the axis labels.
plotType
- fixed plot typeaxlabelMap
- mapping from axis label keys to corresponding
common data input coordinates, or nullMethod Detail |
---|
public String getPurpose()
Task
public Parameter[] getParameters()
Task
public PlotContext getPlotContext(Environment env)
AbstractPlot2Task
getPlotContext
in class AbstractPlot2Task
env
- execution environment
public PlotContext getPlotContext()
protected <T> ConfigParameter<T> createConfigParameter(Environment env, ConfigKey<T> key, String[] suffixes) throws TaskException
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
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |