PlotTask (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plottask.PlotTask

All Implemented Interfaces:

uk.ac.starlink.task.Task

Direct Known Subclasses:

TableHistogram, TablePlot2D, TablePlot3D
```
public abstract class PlotTask
extends java.lang.Object
implements uk.ac.starlink.task.Task
```
Abstract superclass for tasks which generate plots from table data.

Since:

22 Apr 2008

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor and Description

PlotTask(java.lang.String purpose, PlotStateFactory stateFactory, TablePlot plot)
Constructor.

Constructors
Constructor and Description
`PlotTask(java.lang.String purpose, PlotStateFactory stateFactory, TablePlot plot)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`uk.ac.starlink.task.Executable`	`createExecutable(uk.ac.starlink.task.Environment env)`
`protected java.util.List<uk.ac.starlink.task.Parameter>`	`getParameterList()`
`uk.ac.starlink.task.Parameter[]`	`getParameters()`
`java.lang.String`	`getPurpose()`
`uk.ac.starlink.task.Parameter`	`getXpixParameter()` Returns the parameter used for setting plot output X dimension.
`uk.ac.starlink.task.Parameter`	`getYpixParameter()` Returns the parameter used for setting plot output Y dimension.

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

- Constructor Detail
  - PlotTask
```
public PlotTask(java.lang.String purpose,
                PlotStateFactory stateFactory,
                TablePlot plot)
```
    Constructor.
    
    Parameters:
    
    purpose - short (one-line) task purpose
    
    stateFactory - PlotStateFactory for use with this plot
    
    plot - plot component for use with this plot
- Method Detail
  - getParameterList
```
protected java.util.List<uk.ac.starlink.task.Parameter> getParameterList()
```
  - getPurpose
```
public java.lang.String getPurpose()
```
    Specified by:
    
    getPurpose in interface uk.ac.starlink.task.Task
  - getParameters
```
public uk.ac.starlink.task.Parameter[] getParameters()
```
    Specified by:
    
    getParameters in interface uk.ac.starlink.task.Task
  - getXpixParameter
```
public uk.ac.starlink.task.Parameter getXpixParameter()
```
    Returns the parameter used for setting plot output X dimension.
    
    Returns:
    
    xpix parameter
  - getYpixParameter
```
public uk.ac.starlink.task.Parameter getYpixParameter()
```
    Returns the parameter used for setting plot output Y dimension.
    
    Returns:
    
    ypix parameter
  - createExecutable
```
public uk.ac.starlink.task.Executable createExecutable(uk.ac.starlink.task.Environment env)
                                                throws uk.ac.starlink.task.TaskException
```
    Specified by:
    
    createExecutable in interface uk.ac.starlink.task.Task
    
    Throws:
    
    uk.ac.starlink.task.TaskException

Class PlotTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlotTask

Method Detail

getParameterList

getPurpose

getParameters

getXpixParameter

getYpixParameter

createExecutable