Package uk.ac.starlink.ttools.plot2.task
Class GenericPlot2Task
java.lang.Object
uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task
uk.ac.starlink.ttools.plot2.task.GenericPlot2Task
- All Implemented Interfaces:
uk.ac.starlink.task.Task
,DynamicTask
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
DOC_ZONE_SUFFIX, DOMAINMAPPER_SUFFIX, EXAMPLE_LAYER_SUFFIX, EXAMPLE_ZONE_SUFFIX, LAYER_PREFIX, ZONE_PREFIX
-
Constructor Summary
ConstructorsConstructorDescriptionGenericPlot2Task
(boolean allowAnimate, boolean hasZoneSuffixes) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected <T> String
getConfigParamDefault
(uk.ac.starlink.task.Environment env, ConfigKey<T> key, 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<?>[]
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.Methods inherited from class uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task
createAuxCrowdParameter, createAuxLabelParameter, createAuxVisibleParameter, createAuxWidthParameter, createBasicConfigMap, createCaptioner, createConfigMap, createCustomConfigMap, createDataParameter, createDomainMapperParameter, createExecutable, createFilterParameter, createLabelParameter, createLayerSuffixedConfigMap, createLayerTypeParameter, createLegend, createLegendPositionParameter, createPaintModeParameter, createPlotComponent, createPlotConfiguration, createPlotIcon, createPlotIcon, createShadeAxisFactory, createTableParameter, createTitleParameter, createZoneParameter, getBasicParameters, getBitmapParameter, getCompositorParameter, getContextParameters, getCoordValue, getDataStoreParameter, getInputTable, getLegendBorderParameter, getLegendOpaqueParameter, getLegendParameter, getLegendSequenceParameter, getPaddingParameter, getParameterByName, getPlotters, getSequenceParameter, getXpixParameter, getYpixParameter, getZoneKeyParams, hasDomainMappers, hasZoneSuffixes, testEnv
-
Constructor Details
-
GenericPlot2Task
public GenericPlot2Task(boolean allowAnimate, boolean hasZoneSuffixes) Constructor.- Parameters:
allowAnimate
- true iff animation options should be providedhasZoneSuffixes
- true iff zone content can be controlled explicitly by use of parameter suffixes
-
-
Method Details
-
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 classAbstractPlot2Task
- Parameters:
env
- execution environment- Returns:
- context
- Throws:
uk.ac.starlink.task.TaskException
-
getConfigParamDefault
protected <T> String getConfigParamDefault(uk.ac.starlink.task.Environment env, ConfigKey<T> key, 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 classAbstractPlot2Task
- Parameters:
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- Returns:
- default for parameter getting value for
key
, or null if none is obvious
-