|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.task.ConsumerTask
public abstract class ConsumerTask
Abstract task which takes an input table and disposes of it. Concrete subclasses must supply the table.
Constructor Summary | |
---|---|
ConsumerTask(String purpose,
ProcessingMode outMode,
boolean useOutFilter)
Constructor. |
Method Summary | |
---|---|
Executable |
createExecutable(Environment env)
Creates an executable object which will do the work of this task in the given Environment. |
abstract TableProducer |
createProducer(Environment env)
Returns an object which can produce the effective output table which will be consumed by this task. |
static TableProducer |
createProducer(Environment env,
FilterParameter filterParam,
InputTableParameter inParam)
Constructs a table producer given an input parameter and an input filter parameter. |
ProcessingMode |
getOutputMode()
Returns this task's output mode. |
protected List |
getParameterList()
Returns the parameter list for this task; it may be modified. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConsumerTask(String purpose, ProcessingMode outMode, boolean useOutFilter)
purpose
- one-line description of the taskoutMode
- processing mode which determines the destination of
the processed tableuseOutFilter
- allow specification of filters for output tableMethod Detail |
---|
public String getPurpose()
Task
getPurpose
in interface Task
public Parameter[] getParameters()
Task
getParameters
in interface Task
protected List getParameterList()
public abstract TableProducer createProducer(Environment env) throws TaskException
env
- execution environment
TaskException
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 subclasspublic ProcessingMode getOutputMode()
public static TableProducer createProducer(Environment env, FilterParameter filterParam, InputTableParameter inParam) throws TaskException
env
- execution environmentfilterParam
- parameter giving filter steps (or null)inParam
- parameter giving input table
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |