uk.ac.starlink.ttools.task
Class OutputTableParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.ttools.task.OutputTableParameter
All Implemented Interfaces:
TableConsumerParameter

public class OutputTableParameter
extends uk.ac.starlink.task.Parameter
implements TableConsumerParameter

Parameter to hold an output table.


Constructor Summary
OutputTableParameter(String name)
           
 
Method Summary
 TableConsumer consumerValue(uk.ac.starlink.task.Environment env)
          Returns a TableConsumer which corresponds to the value of this parameter.
 OutputFormatParameter getFormatParameter()
           
 void setValueFromConsumer(TableConsumer consumer)
          Sets the value directly from a given TableConsumer.
 void setValueFromString(uk.ac.starlink.task.Environment env, String sval)
           
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, stringValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OutputTableParameter

public OutputTableParameter(String name)
Method Detail

getFormatParameter

public OutputFormatParameter getFormatParameter()

setValueFromConsumer

public void setValueFromConsumer(TableConsumer consumer)
Sets the value directly from a given TableConsumer.

Specified by:
setValueFromConsumer in interface TableConsumerParameter
Parameters:
consumer - table consumer

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String sval)
                        throws uk.ac.starlink.task.TaskException
Overrides:
setValueFromString in class uk.ac.starlink.task.Parameter
Throws:
uk.ac.starlink.task.TaskException

consumerValue

public TableConsumer consumerValue(uk.ac.starlink.task.Environment env)
                            throws uk.ac.starlink.task.TaskException
Returns a TableConsumer which corresponds to the value of this parameter.

Specified by:
consumerValue in interface TableConsumerParameter
Parameters:
env - execution environment
Throws:
uk.ac.starlink.task.TaskException


Copyright © 2009 Central Laboratory of the Research Councils. All Rights Reserved.