AbstractPlot2Task (Starlink-UK API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task

All Implemented Interfaces:

Task, DynamicTask

Direct Known Subclasses:

GenericPlot2Task, TypedPlot2Task
```
public abstract class AbstractPlot2Task
extends Object
implements Task, DynamicTask
```
Abstract superclass for tasks performing plot2 plots using STILTS. Concrete subclasses must supply the PlotType (perhaps from the environment), and may customise the visible task parameter set.
As currently implemented, this will only work with single-zone plots or multi-zone plots with per-zone trimmings and shade axes. Multi-zone plots with global trimming or shade axes must be handled using custom code.

Since:

22 Aug 2014

Author:

Mark Taylor

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DOC_ZONE_SUFFIX`
`static String`	`DOMAINMAPPER_SUFFIX`
`static String`	`EXAMPLE_LAYER_SUFFIX`
`static String`	`EXAMPLE_ZONE_SUFFIX`
`static String`	`LAYER_PREFIX`
`static String`	`ZONE_PREFIX`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractPlot2Task(boolean allowAnimate, boolean hasZoneSuffixes)` Constructor with explicit animation capability.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`DoubleParameter`	`createAuxCrowdParameter(String suffix)` Returns a parameter for determining crowding on the aux axis.
`StringParameter`	`createAuxLabelParameter(String suffix)` Returns a parameter for acquiring the aux ramp label.
`BooleanParameter`	`createAuxVisibleParameter(String suffix)` Returns a parameter for determining whether the aux colour ramp is painted for a given plot zone.
`IntegerParameter`	`createAuxWidthParameter(String suffix)` Returns a parameter for determining aux colour ramp lateral size in pixels.
`static ConfigMap`	`createBasicConfigMap(Environment env, ConfigKey<?>[] keys)` Returns a config map based on given keys with values derived from the execution environment.
`Captioner`	`createCaptioner(Environment env, String zoneSuffix)` Acquires a captioner from the environment.
`static ConfigMap`	`createConfigMap(Environment env, ConfigKey<?>[] configKeys, ConfigParameterFactory cpFact)` Returns a ConfigMap derived from the assignments made in a given execution environment.
`ConfigMap`	`createCustomConfigMap(Environment env)` Provides any additional config keys (beyond layer style and aux map) that should be provided for layer creation.
`static StringParameter`	`createDataParameter(Input input, String suffix, boolean fullDetail)` Returns a parameter for acquiring a column of data.
`static Parameter<DomainMapper>`	`createDomainMapperParameter(Input input, String suffix)` Returns a parameter for specifying the DomainMapper associated with a given Input.
`Executable`	`createExecutable(Environment env)` Creates an executable object which will do the work of this task in the given Environment.
`static FilterParameter`	`createFilterParameter(String suffix, InputTableParameter tableParam)` Returns a parameter for acquiring a filter applied to the table input for a given layer.
`static Parameter<String>`	`createLabelParameter(String suffix)` Returns a parameter to get a textual label corresponding to the layer identified by a given layer suffix.
`static ConfigMap`	`createLayerSuffixedConfigMap(Environment env, ConfigKey<?>[] configKeys, String layerSuffix)` Returns a ConfigMap specific to a given layer derived from the assignments made in a given execution environment, based on config keys and a layer identifier.
`static LayerTypeParameter`	`createLayerTypeParameter(String suffix, PlotContext<?,?> context)` Returns a parameter for acquiring a plotter.
`Icon`	`createLegend(Environment env, Map<String,PlotLayer> layerMap, String zoneSuffix, String[] layerSuffixSeq)` Turns the map of defined layers into a legend icon.
`DoubleArrayParameter`	`createLegendPositionParameter(String suffix)` Returns a parameter to get the legend position for the zone identified by a given zone suffix.
`static PaintModeParameter`	`createPaintModeParameter()` Returns a parameter for specifying a paint mode.
`PlotDisplay<?,?>`	`createPlotComponent(Environment env, boolean caching)` Returns a graphical component that displays an interactive view of the plot described by a value-bearing execution environment.
`protected <P,A> PlotConfiguration<P,A>`	`createPlotConfiguration(Environment env, PlotContext<P,A> context)` Turns an execution environment (containing value-bearing parameters) into an object with all the required plot configuration information.
`Icon`	`createPlotIcon(Environment env)` Returns an Icon that paints the plot described by a value-bearing execution environment.
`static <P,A> Icon`	`createPlotIcon(Ganger<P,A> ganger, SurfaceFactory<P,A> surfFact, ZoneContent<P,A>[] contents, Trimming[] trimmings, ShadeAxisKit[] shadeKits, PaperTypeSelector ptSel, Compositor compositor, DataStore dataStore, int xpix, int ypix, boolean forceBitmap)` Creates an icon which will paint the content of a plot.
`ShadeAxisFactory`	`createShadeAxisFactory(Environment env, PlotLayer[] layers, String zoneSuffix)` Acquires a ShadeAxisFactory from the environment for a given plot zone.
`static InputTableParameter`	`createTableParameter(String suffix)` Returns a parameter for acquiring a data table.
`Parameter<String>`	`createTitleParameter(String suffix)` Returns a parameter to get a plot title for the zone identified by a given zone suffix.
`static Parameter<String>`	`createZoneParameter(String layerSuffix)` Returns a parameter for associating a zone identifier with a given layer.
`Parameter<?>[]`	`getBasicParameters()` Returns the list of parameters supplied by the AbstractPlot2Task implementation.
`BooleanParameter`	`getBitmapParameter()` Returns the parameter used to force bitmap output.
`Parameter<Compositor>`	`getCompositorParameter()` Returns the parameter for configuring the compositor.
`protected abstract <T> String`	`getConfigParamDefault(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.
`Parameter<?>[]`	`getContextParameters(Environment env)` Returns the parameters for this task in the context of a given execution environment.
`static CoordValue`	`getCoordValue(Environment env, Coord coord, String suffix)` Turns a coord into a CoordValue.
`Parameter<DataStoreFactory>`	`getDataStoreParameter()` Returns the parameter for configurig the data storage.
`static StarTable`	`getInputTable(Environment env, String suffix)` Returns a table from the environment.
`Parameter<Boolean>`	`getLegendBorderParameter()` Returns the parameter for indicating whether the legend border will be visible.
`Parameter<Boolean>`	`getLegendOpaqueParameter()` Returns the parameter for indicating whether the legend background will be opaque.
`Parameter<Boolean>`	`getLegendParameter()` Returns the parameter for indicating whether the legend will be visible.
`Parameter<String[]>`	`getLegendSequenceParameter()` Returns the parameter for determining the sequence and inclusion of layers in the legend.
`Parameter<Padding>`	`getPaddingParameter()` Returns the parameter for assigning the plot external padding.
`Parameter<?>`	`getParameterByName(Environment env, String paramName)` Attempts to find a parameter with a given name that might be used by this task in the content of the given environment.
`abstract 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.
`static Map<String,Plotter<?>>`	`getPlotters(Environment env, PlotContext<?,?> context)` Returns a map of suffix strings to Plotter objects.
`Parameter<String[]>`	`getSequenceParameter()` Returns the parameter for determining the sequence of layers appearing in the plot.
`IntegerParameter`	`getXpixParameter()` Returns the parameter for assigning the external horizontal extent of the plot.
`IntegerParameter`	`getYpixParameter()` Returns the parameter for assigning the external vertical extent of the plot.
`List<Parameter<?>>`	`getZoneKeyParams(ConfigKey<?>[] keys)` Returns a list of parameters suffixed by zone based on a list of ConfigKeys.
`static boolean`	`hasDomainMappers(Input input)` Indicates whether a DomainMapper should be sought for a given Input.
`boolean`	`hasZoneSuffixes()` Indicates whether relevant parameters can be suffixed by zone label for explicit control of per-zone characteristics.
`void`	`testEnv(Environment env)` Prepares a plot for this task as specified by a given environment, but does not run any of the actual plotting code.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.ac.starlink.task.Task
getParameters, getPurpose

- Field Detail
  - LAYER_PREFIX
```
public static final String LAYER_PREFIX
```
    See Also:
    
    Constant Field Values
  - ZONE_PREFIX
```
public static final String ZONE_PREFIX
```
    See Also:
    
    Constant Field Values
  - DOMAINMAPPER_SUFFIX
```
public static final String DOMAINMAPPER_SUFFIX
```
    See Also:
    
    Constant Field Values
  - EXAMPLE_LAYER_SUFFIX
```
public static final String EXAMPLE_LAYER_SUFFIX
```
    See Also:
    
    Constant Field Values
  - EXAMPLE_ZONE_SUFFIX
```
public static final String EXAMPLE_ZONE_SUFFIX
```
    See Also:
    
    Constant Field Values
  - DOC_ZONE_SUFFIX
```
public static final String DOC_ZONE_SUFFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractPlot2Task
```
protected AbstractPlot2Task(boolean allowAnimate,
                            boolean hasZoneSuffixes)
```
    Constructor with explicit animation capability.
    
    Parameters:
    
    allowAnimate - true iff animation options should be provided
    
    hasZoneSuffixes - true iff zone content can be controlled explicitly by use of parameter suffixes
- Method Detail
  - getPlotContext
```
public abstract PlotContext<?,?> getPlotContext(Environment env)
                                         throws TaskException
```
    Concrete subclasses must implement this method to provide the PlotType and other information from the environment that may not be available at construction time.
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    context
    
    Throws:
    
    TaskException
  - getConfigParamDefault
```
protected abstract <T> String getConfigParamDefault(Environment env,
                                                    ConfigKey<T> key,
                                                    String[] suffixes)
                                             throws TaskException
```
    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.
    
    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:
    
    default for parameter getting value for key, or null if none is obvious
    
    Throws:
    
    TaskException
  - getBasicParameters
```
public final Parameter<?>[] getBasicParameters()
```
    Returns the list of parameters supplied by the AbstractPlot2Task implementation. Subclasses should include these alongside any they want to add for presentation to the user.
    
    Returns:
    
    basic parameter list
  - createExecutable
```
public Executable createExecutable(Environment env)
                            throws TaskException
```
    Description copied from interface: Task
    
    Creates an executable object which will do the work of this task in the given Environment. This method should do all of the parameter processing and prepare an object which just executes. The idea is that any communication with the user related to the supplied parameter values can be done before the task starts to execute in earnest. Consequently, the returned Executable object ought not to make any reference to env, though this is not absolutely prohibited.
    
    Specified by:
    
    createExecutable in interface Task
    
    Parameters:
    
    env - the environment in which the task will operate
    
    Throws:
    
    TaskException - if no executable can be created; this should usually be a UsageException or some subclass
  - hasZoneSuffixes
```
public boolean hasZoneSuffixes()
```
    Indicates whether relevant parameters can be suffixed by zone label for explicit control of per-zone characteristics.
    
    Returns:
    
    true iff zone suffixes are in use
  - getXpixParameter
```
public IntegerParameter getXpixParameter()
```
    Returns the parameter for assigning the external horizontal extent of the plot.
    
    Returns:
    
    xpix parameter
  - getYpixParameter
```
public IntegerParameter getYpixParameter()
```
    Returns the parameter for assigning the external vertical extent of the plot.
    
    Returns:
    
    ypix parameter
  - getSequenceParameter
```
public Parameter<String[]> getSequenceParameter()
```
    Returns the parameter for determining the sequence of layers appearing in the plot.
    
    Returns:
    
    sequence parameter
  - getLegendParameter
```
public Parameter<Boolean> getLegendParameter()
```
    Returns the parameter for indicating whether the legend will be visible.
    
    Returns:
    
    legend visible parameter
  - getLegendBorderParameter
```
public Parameter<Boolean> getLegendBorderParameter()
```
    Returns the parameter for indicating whether the legend border will be visible.
    
    Returns:
    
    legend border parameter
  - getLegendOpaqueParameter
```
public Parameter<Boolean> getLegendOpaqueParameter()
```
    Returns the parameter for indicating whether the legend background will be opaque.
    
    Returns:
    
    legend opaque parameter
  - getLegendSequenceParameter
```
public Parameter<String[]> getLegendSequenceParameter()
```
    Returns the parameter for determining the sequence and inclusion of layers in the legend.
    
    Returns:
    
    legend sequence parameter
  - getPaddingParameter
```
public Parameter<Padding> getPaddingParameter()
```
    Returns the parameter for assigning the plot external padding.
    
    Returns:
    
    padding parameter
  - getDataStoreParameter
```
public Parameter<DataStoreFactory> getDataStoreParameter()
```
    Returns the parameter for configurig the data storage.
    
    Returns:
    
    data storage parameter
  - getBitmapParameter
```
public BooleanParameter getBitmapParameter()
```
    Returns the parameter used to force bitmap output.
    
    Returns:
    
    force bitmap parameter
  - getCompositorParameter
```
public Parameter<Compositor> getCompositorParameter()
```
    Returns the parameter for configuring the compositor.
    
    Returns:
    
    compositor parameter
  - createCustomConfigMap
```
public ConfigMap createCustomConfigMap(Environment env)
                                throws TaskException
```
    Provides any additional config keys (beyond layer style and aux map) that should be provided for layer creation. The default implementation returns an empty map, but this behaviour may be overridden by subclasses.
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    custom config entries
    
    Throws:
    
    TaskException
  - createPlotIcon
```
public Icon createPlotIcon(Environment env)
                    throws TaskException,
                           IOException,
                           InterruptedException
```
    Returns an Icon that paints the plot described by a value-bearing execution environment. This utility method is not used for executing this class.
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    plot icon
    
    Throws:
    
    TaskException
    
    IOException
    
    InterruptedException
  - testEnv
```
public void testEnv(Environment env)
             throws TaskException
```
    Prepares a plot for this task as specified by a given environment, but does not run any of the actual plotting code. If this utility method completes without error, there is a good chance that the specified plot will also run without error.
    
    Parameters:
    
    env - populated environment
    
    Throws:
    
    TaskException - in case of error
  - createPlotComponent
```
public PlotDisplay<?,?> createPlotComponent(Environment env,
                                            boolean caching)
                                     throws TaskException,
                                            IOException,
                                            InterruptedException
```
    Returns a graphical component that displays an interactive view of the plot described by a value-bearing execution environment. This utility method is not used for executing the task defined by this class.
    
    Parameters:
    
    env - execution environment
    
    caching - whether data and plot should be cached or re-read at every repaint
    
    Returns:
    
    active plot view component
    
    Throws:
    
    TaskException
    
    IOException
    
    InterruptedException
  - getContextParameters
```
public Parameter<?>[] getContextParameters(Environment env)
                                    throws TaskException
```
    Description copied from interface: DynamicTask
    
    Returns the parameters for this task in the context of a given execution environment. If the environment is empty, this should give the same result as Task.getParameters(), but found settings of parameters in the presented environment may lead to parameters being added to or removed from the list.
    This ought not to result in additional prompts to the user.
    
    Specified by:
    
    getContextParameters in interface DynamicTask
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    list of known parameters
    
    Throws:
    
    TaskException
  - getParameterByName
```
public Parameter<?> getParameterByName(Environment env,
                                       String paramName)
                                throws TaskException
```
    Description copied from interface: DynamicTask
    
    Attempts to find a parameter with a given name that might be used by this task in the content of the given environment.
    This ought not to result in additional prompts to the user.
    
    Specified by:
    
    getParameterByName in interface DynamicTask
    
    Parameters:
    
    env - execution environment
    
    paramName - requested parameter name
    
    Returns:
    
    parameter with the given name, or null
    
    Throws:
    
    TaskException
  - createPlotConfiguration
```
protected <P,A> PlotConfiguration<P,A> createPlotConfiguration(Environment env,
                                                               PlotContext<P,A> context)
                                                        throws TaskException
```
    Turns an execution environment (containing value-bearing parameters) into an object with all the required plot configuration information.
    
    Parameters:
    
    env - execution environment
    
    context - plot context
    
    Returns:
    
    plot configuration
    
    Throws:
    
    TaskException
  - createLegend
```
public Icon createLegend(Environment env,
                         Map<String,PlotLayer> layerMap,
                         String zoneSuffix,
                         String[] layerSuffixSeq)
                  throws TaskException
```
    Turns the map of defined layers into a legend icon.
    
    Parameters:
    
    env - execution environment
    
    layerMap - suffix->layer map for all defined layers
    
    zoneSuffix - suffix identifying zone if any
    
    layerSuffixSeq - ordered array of suffixes for layers plotted
    
    Returns:
    
    legend icon, may be null
    
    Throws:
    
    TaskException
  - getPlotters
```
public static Map<String,Plotter<?>> getPlotters(Environment env,
                                                 PlotContext<?,?> context)
                                          throws TaskException
```
    Returns a map of suffix strings to Plotter objects. Each suffix string is appended to parameters associated with the relevant plotter as a namespacing device on the command line.
    
    Parameters:
    
    env - execution environment
    
    context - plot context
    
    Returns:
    
    mapping from suffixes to plotters for the environment
    
    Throws:
    
    TaskException
  - createCaptioner
```
public Captioner createCaptioner(Environment env,
                                 String zoneSuffix)
                          throws TaskException
```
    Acquires a captioner from the environment. At present, a single captioner is used for labelling the legend and any axes; this is also the one that will be used by default for any label-type plot layers. However you could refine it to use different parameter sets for different purposes.
    
    Parameters:
    
    env - execution environment
    
    zoneSuffix - suffix for zone to which the caption will apply, may be the empty string for global
    
    Returns:
    
    captioner
    
    Throws:
    
    TaskException
  - createShadeAxisFactory
```
public ShadeAxisFactory createShadeAxisFactory(Environment env,
                                               PlotLayer[] layers,
                                               String zoneSuffix)
                                        throws TaskException
```
    Acquires a ShadeAxisFactory from the environment for a given plot zone.
    
    Parameters:
    
    env - execution environment
    
    layers - layers that will be plotted
    
    zoneSuffix - identifier for zone whose shader is to be calculated
    
    Returns:
    
    shade axis factory, may be null
    
    Throws:
    
    TaskException
  - createBasicConfigMap
```
public static ConfigMap createBasicConfigMap(Environment env,
                                             ConfigKey<?>[] keys)
                                      throws TaskException
```
    Returns a config map based on given keys with values derived from the execution environment. There is no funny business with appending suffixes etc.
    
    Parameters:
    
    env - execution environment
    
    keys - config keys
    
    Returns:
    
    config map
    
    Throws:
    
    TaskException
  - getCoordValue
```
public static CoordValue getCoordValue(Environment env,
                                       Coord coord,
                                       String suffix)
                                throws TaskException
```
    Turns a coord into a CoordValue.
    
    Parameters:
    
    env - execution environment
    
    coord - coordinate definition
    
    suffix - suffix to append to parameter name
    
    Returns:
    
    coordinate with expression values acquired from environment
    
    Throws:
    
    TaskException
  - createLayerSuffixedConfigMap
```
public static ConfigMap createLayerSuffixedConfigMap(Environment env,
                                                     ConfigKey<?>[] configKeys,
                                                     String layerSuffix)
                                              throws TaskException
```
    Returns a ConfigMap specific to a given layer derived from the assignments made in a given execution environment, based on config keys and a layer identifier.
    
    Parameters:
    
    env - execution environment bearing the parameter values
    
    configKeys - layer-specific configuration keys to find values for
    
    layerSuffix - layer identifier string appended to config key shortnames to make env parameter names
    
    Returns:
    
    config map with values for the supplied keys
    
    Throws:
    
    TaskException
  - createConfigMap
```
public static ConfigMap createConfigMap(Environment env,
                                        ConfigKey<?>[] configKeys,
                                        ConfigParameterFactory cpFact)
                                 throws TaskException
```
    Returns a ConfigMap derived from the assignments made in a given execution environment.
    
    Parameters:
    
    env - execution environment bearing the parameter values
    
    configKeys - configuration keys to find values for
    
    cpFact - turns config keys into Parameters
    
    Returns:
    
    config map with values for the supplied keys
    
    Throws:
    
    TaskException
  - getInputTable
```
public static StarTable getInputTable(Environment env,
                                      String suffix)
                               throws TaskException
```
    Returns a table from the environment.
    
    Parameters:
    
    env - execution environment
    
    suffix - parameter suffix
    
    Returns:
    
    table
    
    Throws:
    
    TaskException
  - createTableParameter
```
public static InputTableParameter createTableParameter(String suffix)
```
    Returns a parameter for acquiring a data table.
    
    Parameters:
    
    suffix - layer-specific suffix
    
    Returns:
    
    table parameter
  - createFilterParameter
```
public static FilterParameter createFilterParameter(String suffix,
                                                    InputTableParameter tableParam)
```
    Returns a parameter for acquiring a filter applied to the table input for a given layer.
    
    Parameters:
    
    suffix - layer-specific suffix
    
    tableParam - input table parameter associated with the layer
    
    Returns:
    
    filter parameter
  - createLabelParameter
```
public static Parameter<String> createLabelParameter(String suffix)
```
    Returns a parameter to get a textual label corresponding to the layer identified by a given layer suffix. This label is displayed in the legend.
    
    Parameters:
    
    suffix - layer suffix
    
    Returns:
    
    parameter to get legend label for layer
  - createTitleParameter
```
public Parameter<String> createTitleParameter(String suffix)
```
    Returns a parameter to get a plot title for the zone identified by a given zone suffix.
    
    Parameters:
    
    suffix - zone suffix, or either null or empty string for all zones
    
    Returns:
    
    parameter to get plot title for zone
  - createAuxLabelParameter
```
public StringParameter createAuxLabelParameter(String suffix)
```
    Returns a parameter for acquiring the aux ramp label.
    
    Parameters:
    
    suffix - zone suffix
    
    Returns:
    
    parameter
  - createAuxVisibleParameter
```
public BooleanParameter createAuxVisibleParameter(String suffix)
```
    Returns a parameter for determining whether the aux colour ramp is painted for a given plot zone.
    
    Parameters:
    
    suffix - zone suffix
    
    Returns:
    
    parameter
  - createAuxCrowdParameter
```
public DoubleParameter createAuxCrowdParameter(String suffix)
```
    Returns a parameter for determining crowding on the aux axis.
    
    Parameters:
    
    suffix - zone suffix
    
    Returns:
    
    parameter
  - createAuxWidthParameter
```
public IntegerParameter createAuxWidthParameter(String suffix)
```
    Returns a parameter for determining aux colour ramp lateral size in pixels.
    
    Parameters:
    
    suffix - zone suffix
    
    Returns:
    
    parameter
  - createLegendPositionParameter
```
public DoubleArrayParameter createLegendPositionParameter(String suffix)
```
    Returns a parameter to get the legend position for the zone identified by a given zone suffix.
    
    Parameters:
    
    suffix - zone suffix, or either null or empty string for all zones
    
    Returns:
    
    parameter to get legend position for zone
  - hasDomainMappers
```
public static boolean hasDomainMappers(Input input)
```
    Indicates whether a DomainMapper should be sought for a given Input.
    
    Parameters:
    
    input - input specifier
    
    Returns:
    
    true iff input's Domain supports multiple known mappers
  - createLayerTypeParameter
```
public static LayerTypeParameter createLayerTypeParameter(String suffix,
                                                          PlotContext<?,?> context)
```
    Returns a parameter for acquiring a plotter.
    
    Parameters:
    
    suffix - parameter name suffix
    
    context - plot context
    
    Returns:
    
    plotter parameter
  - createZoneParameter
```
public static Parameter<String> createZoneParameter(String layerSuffix)
```
    Returns a parameter for associating a zone identifier with a given layer. The value acquired by this parameter is the zone suffix.
    
    Parameters:
    
    layerSuffix - identifier for the layer whose zone is to be determined
    
    Returns:
    
    zone suffix parameter
  - createDataParameter
```
public static StringParameter createDataParameter(Input input,
                                                  String suffix,
                                                  boolean fullDetail)
```
    Returns a parameter for acquiring a column of data.
    
    Parameters:
    
    input - specifies input value required from user
    
    suffix - layer-specific suffix
    
    fullDetail - if true, extra detail is appended to the description
    
    Returns:
    
    data parameter
  - createDomainMapperParameter
```
public static Parameter<DomainMapper> createDomainMapperParameter(Input input,
                                                                  String suffix)
```
    Returns a parameter for specifying the DomainMapper associated with a given Input.
    
    Parameters:
    
    input - coordinate specifier
    
    suffix - layer suffix
    
    Returns:
    
    domain mapper selection parameter
  - createPaintModeParameter
```
public static PaintModeParameter createPaintModeParameter()
```
    Returns a parameter for specifying a paint mode.
    
    Returns:
    
    paint mode parameter
  - createPlotIcon
```
public static <P,A> Icon createPlotIcon(Ganger<P,A> ganger,
                                        SurfaceFactory<P,A> surfFact,
                                        ZoneContent<P,A>[] contents,
                                        Trimming[] trimmings,
                                        ShadeAxisKit[] shadeKits,
                                        PaperTypeSelector ptSel,
                                        Compositor compositor,
                                        DataStore dataStore,
                                        int xpix,
                                        int ypix,
                                        boolean forceBitmap)
```
    Creates an icon which will paint the content of a plot. This icon is expected to be painted once and then discarded, so it's not cached.
    The contents array must have a number of entries that matches the zone count of the ganger. The trimmings and shadeKits are supplied as arrays, and in each case may be either a 1- or nzone-element array depending on the Ganger's Ganger.isTrimmingGlobal()/Ganger.isShadingGlobal() flags.
    
    Parameters:
    
    ganger - defines plot surface grouping
    
    surfFact - surface factory
    
    contents - zone contents (nz-element array)
    
    trimmings - zone trimmings (nz- or 1-element array, elements may be null)
    
    shadeKits - shader axis kits by zone (nz- or 1-element array, elements may be null)
    
    ptSel - paper type selector
    
    compositor - compositor for pixel composition
    
    dataStore - data storage object
    
    xpix - horizontal size of icon in pixels
    
    ypix - vertical size of icon in pixels
    
    forceBitmap - true to force bitmap output of vector graphics, false to use default behaviour
    
    Returns:
    
    icon icon for plotting
  - getZoneKeyParams
```
public final List<Parameter<?>> getZoneKeyParams(ConfigKey<?>[] keys)
```
    Returns a list of parameters suffixed by zone based on a list of ConfigKeys.
    
    Parameters:
    
    keys - config keys
    
    Returns:
    
    parameters for acquiring config key values

Class AbstractPlot2Task

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface uk.ac.starlink.task.Task

Field Detail

LAYER_PREFIX

ZONE_PREFIX

DOMAINMAPPER_SUFFIX

EXAMPLE_LAYER_SUFFIX

EXAMPLE_ZONE_SUFFIX

DOC_ZONE_SUFFIX

Constructor Detail

AbstractPlot2Task

Method Detail

getPlotContext

getConfigParamDefault

getBasicParameters

createExecutable

hasZoneSuffixes

getXpixParameter

getYpixParameter

getSequenceParameter

getLegendParameter

getLegendBorderParameter

getLegendOpaqueParameter

getLegendSequenceParameter

getPaddingParameter

getDataStoreParameter

getBitmapParameter

getCompositorParameter

createCustomConfigMap

createPlotIcon

testEnv

createPlotComponent

getContextParameters

getParameterByName

createPlotConfiguration

createLegend

getPlotters

createCaptioner

createShadeAxisFactory

createBasicConfigMap

getCoordValue

createLayerSuffixedConfigMap

createConfigMap

getInputTable

createTableParameter

createFilterParameter

createLabelParameter

createTitleParameter

createAuxLabelParameter

createAuxVisibleParameter

createAuxCrowdParameter

createAuxWidthParameter

createLegendPositionParameter

hasDomainMappers

createLayerTypeParameter

createZoneParameter

createDataParameter

createDomainMapperParameter

createPaintModeParameter

createPlotIcon

getZoneKeyParams