|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter
uk.ac.starlink.ttools.task.FilterParameter
public class FilterParameter
Parameter which contains a value representing one or more
ProcessingStep
s.
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 |
---|
public FilterParameter(String name)
Method Detail |
---|
public char getValueSeparator()
getValueSeparator
in interface uk.ac.starlink.task.MultiParameter
public void setValueFromString(uk.ac.starlink.task.Environment env, String sval) throws uk.ac.starlink.task.TaskException
setValueFromString
in class uk.ac.starlink.task.Parameter
uk.ac.starlink.task.TaskException
public ProcessingStep[] stepsValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
env
- execution environment
uk.ac.starlink.task.TaskException
public String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionment
public static String getFiltersUsage(TableEnvironment env)
env
- execution environment
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |