uk.ac.starlink.ttools.task
Class FilterParameter

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

public class FilterParameter
extends uk.ac.starlink.task.Parameter
implements ExtraParameter, uk.ac.starlink.task.MultiParameter

Parameter which contains a value representing one or more ProcessingSteps.

Since:
17 Aug 2005
Author:
Mark Taylor

Constructor Summary
FilterParameter(String name)
           
 
Method Summary
 String getExtraUsage(TableEnvironment env)
          Returns an extended usage message.
static String getFiltersUsage(TableEnvironment env)
          Returns a formatted string listing available filter commands with their usage.
 char getValueSeparator()
           
 void setValueFromString(uk.ac.starlink.task.Environment env, String sval)
           
 ProcessingStep[] stepsValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as an array of processing steps.
 
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

FilterParameter

public FilterParameter(String name)
Method Detail

getValueSeparator

public char getValueSeparator()
Specified by:
getValueSeparator in interface uk.ac.starlink.task.MultiParameter

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

stepsValue

public ProcessingStep[] stepsValue(uk.ac.starlink.task.Environment env)
                            throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as an array of processing steps.

Parameters:
env - execution environment
Returns:
array of zero or more processing steps
Throws:
uk.ac.starlink.task.TaskException

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

getFiltersUsage

public static String getFiltersUsage(TableEnvironment env)
Returns a formatted string listing available filter commands with their usage.

Parameters:
env - execution environment
Returns:
usge string


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