uk.ac.starlink.task.MultiParameter
, ExtraParameter
public class FilterParameter extends uk.ac.starlink.task.Parameter<ProcessingStep[]> implements ExtraParameter, uk.ac.starlink.task.MultiParameter
ProcessingStep
s.Constructor | Description |
---|---|
FilterParameter(java.lang.String name) |
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getExtraUsage(TableEnvironment env) |
Returns an extended usage message.
|
static java.lang.String |
getFiltersUsage(TableEnvironment env) |
Returns a formatted string listing available filter commands
with their usage.
|
char |
getValueSeparator() |
|
void |
setTableDescription(java.lang.String shortDescrip,
AbstractInputTableParameter tableParam,
java.lang.Boolean isBefore) |
Sets the wording used to refer to the target table for the filters
this parameter acquires.
|
ProcessingStep[] |
stepsValue(uk.ac.starlink.task.Environment env) |
Returns the value of this parameter as an array of processing steps.
|
ProcessingStep[] |
stringToObject(uk.ac.starlink.task.Environment env,
java.lang.String sval) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
public final void setTableDescription(java.lang.String shortDescrip, AbstractInputTableParameter tableParam, java.lang.Boolean isBefore)
shortDescrip
- text to replace "the table"tableParam
- if supplied, gives the table parameter on behalf
of which this format parameter is operating;
may be nullisBefore
- TRUE means filter is applied before any other
processing, FALSE means after, null don't knowpublic char getValueSeparator()
getValueSeparator
in interface uk.ac.starlink.task.MultiParameter
public ProcessingStep[] stringToObject(uk.ac.starlink.task.Environment env, java.lang.String sval) throws uk.ac.starlink.task.TaskException
stringToObject
in class uk.ac.starlink.task.Parameter<ProcessingStep[]>
uk.ac.starlink.task.TaskException
public ProcessingStep[] stepsValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
env
- execution environmentuk.ac.starlink.task.TaskException
public java.lang.String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionmentpublic static java.lang.String getFiltersUsage(TableEnvironment env)
env
- execution environmentCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.