|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plottask.PlotTask
public abstract class PlotTask
Abstract superclass for tasks which generate plots from table data.
Constructor Summary | |
---|---|
PlotTask(String purpose,
PlotStateFactory stateFactory,
TablePlot plot)
Constructor. |
Method Summary | |
---|---|
Executable |
createExecutable(Environment env)
Creates an executable object which will do the work of this task in the given Environment. |
protected List<Parameter> |
getParameterList()
|
Parameter[] |
getParameters()
Returns the list of parameters which may be used by this task. |
String |
getPurpose()
Returns a short (one-line) description of the purpose of this task. |
Parameter |
getXpixParameter()
Returns the parameter used for setting plot output X dimension. |
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 |
---|
public PlotTask(String purpose, PlotStateFactory stateFactory, TablePlot plot)
purpose
- short (one-line) task purposestateFactory
- PlotStateFactory for use with this plotplot
- plot component for use with this plotMethod Detail |
---|
protected List<Parameter> getParameterList()
public String getPurpose()
Task
getPurpose
in interface Task
public Parameter[] getParameters()
Task
getParameters
in interface Task
public Parameter getXpixParameter()
public Parameter getYpixParameter()
public Executable createExecutable(Environment env) throws TaskException
Task
env
, though this is not
absolutely prohibited.
createExecutable
in interface Task
env
- the environment in which the task will operate
TaskException
- if no executable can be created;
this should usually be a UsageException
or
some subclass
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |