uk.ac.starlink.ttools.task
Class OutputModeParameter

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

public class OutputModeParameter
extends uk.ac.starlink.task.Parameter
implements TableConsumerParameter, ExtraParameter

Parameter for table output mode.

Since:
15 Aug 2005
Author:
Mark Taylor

Constructor Summary
OutputModeParameter(String name)
          Constructor.
 
Method Summary
 TableConsumer consumerValue(uk.ac.starlink.task.Environment env)
          Returns a TableConsumer which corresponds to the value of this parameter.
 String getExtraUsage(TableEnvironment env)
          Returns an extended usage message.
 String getModeUsage(String modeName, String prefix)
          Returns a usage message for a given processing mode.
 void setValueFromConsumer(TableConsumer consumer)
          Sets the value directly from a given TableConsumer.
 void setValueFromString(uk.ac.starlink.task.Environment env, String stringval)
           
 
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

OutputModeParameter

public OutputModeParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

getExtraUsage

public String getExtraUsage(TableEnvironment env)
Description copied from interface: ExtraParameter
Returns an extended usage message. This should not repeat the content of the normal usage message. It should be preformatted, that is it should contain newlines to keep the line length down to less than 80 characters.

Specified by:
getExtraUsage in interface ExtraParameter
Parameters:
env - execution envrionment
Returns:
extended usage message

getModeUsage

public String getModeUsage(String modeName,
                           String prefix)
                    throws uk.ac.starlink.util.LoadException
Returns a usage message for a given processing mode.

Parameters:
modeName - name of the mode
prefix - prefix for each line of output (e.g. padding spaces)
Returns:
usage message
Throws:
uk.ac.starlink.util.LoadException

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String stringval)
                        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

setValueFromConsumer

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

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


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