public class TypedPlot2Task extends AbstractPlot2Task
DOC_ZONE_SUFFIX, EXAMPLE_LAYER_SUFFIX, EXAMPLE_ZONE_SUFFIX, LAYER_PREFIX, ZONE_PREFIX
Constructor and Description |
---|
TypedPlot2Task(PlotType plotType,
java.util.Map<ConfigKey<java.lang.String>,Input> axlabelMap)
Constructs a plot task with a default plot context, and without
plot ganging.
|
TypedPlot2Task(PlotType plotType,
java.util.Map<ConfigKey<java.lang.String>,Input> axlabelMap,
PlotContext context)
Constructs a plot task with a supplied PlotContext.
|
Modifier and Type | Method and Description |
---|---|
static PlotContext |
createDefaultPlotContext(PlotType plotType,
GangerFactory gangerFact)
Returns a default plot context for a given PlotType.
|
protected <T> java.lang.String |
getConfigParamDefault(uk.ac.starlink.task.Environment env,
ConfigKey<T> key,
java.lang.String[] suffixes)
May provide a default value for a given config parameter that is
sensitive to the content of the execution environment.
|
uk.ac.starlink.task.Parameter[] |
getParameters() |
PlotContext |
getPlotContext()
Returns the fixed plot context for this task.
|
PlotContext |
getPlotContext(uk.ac.starlink.task.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.
|
PlotType |
getPlotType()
Returns the plot type.
|
java.lang.String |
getPurpose() |
createAuxCrowdParameter, createAuxLabelParameter, createAuxVisibleParameter, createAuxWidthParameter, createDataParameter, createExecutable, createFilterParameter, createLabelParameter, createLayerTypeParameter, createLegendPositionParameter, createPaintModeParameter, createPlotComponent, createPlotIcon, createPlotIcon, createTableParameter, createTitleParameter, createZoneParameter, getBasicParameters, getContextParameters, getLegendBorderParameter, getLegendOpaqueParameter, getLegendParameter, getLegendSequenceParameter, getPaddingParameter, getParameterByName, getSequenceParameter, getXpixParameter, getYpixParameter, getZoneKeyParams, testEnv
public TypedPlot2Task(PlotType plotType, java.util.Map<ConfigKey<java.lang.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, java.util.Map<ConfigKey<java.lang.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 nullpublic PlotType getPlotType()
public java.lang.String getPurpose()
public uk.ac.starlink.task.Parameter[] getParameters()
public PlotContext getPlotContext(uk.ac.starlink.task.Environment env)
AbstractPlot2Task
getPlotContext
in class AbstractPlot2Task
env
- execution environmentpublic PlotContext getPlotContext()
protected <T> java.lang.String getConfigParamDefault(uk.ac.starlink.task.Environment env, ConfigKey<T> key, java.lang.String[] suffixes) throws uk.ac.starlink.task.TaskException
AbstractPlot2Task
getConfigParamDefault
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 performedkey
,
or null if none is obviousuk.ac.starlink.task.TaskException
public static PlotContext createDefaultPlotContext(PlotType plotType, GangerFactory gangerFact)
plotType
- plot typegangerFact
- defines plot groupingCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.