|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<ProcessingStep[]>
uk.ac.starlink.ttools.task.FilterParameter
public class FilterParameter
Parameter which contains a value representing one or more
ProcessingStep
s.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
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()
Returns a character which is to be used as the separator between values found in adjacent occurrences of the parameter in the execution environment. |
void |
setTableDescription(String shortDescrip,
AbstractInputTableParameter tableParam,
Boolean isBefore)
Sets the wording used to refer to the target table for the filters this parameter acquires. |
ProcessingStep[] |
stepsValue(Environment env)
Returns the value of this parameter as an array of processing steps. |
ProcessingStep[] |
stringToObject(Environment env,
String sval)
Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. |
Methods inherited from class uk.ac.starlink.task.Parameter |
---|
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 |
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 final void setTableDescription(String shortDescrip, AbstractInputTableParameter tableParam, 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()
MultiParameter
getValueSeparator
in interface MultiParameter
public ProcessingStep[] stringToObject(Environment env, String sval) throws TaskException
Parameter
It is an error to supply a null or empty string value.
If this method fails (throws a ParameterValueException)
and if allowClassnameValue
is set, then a subsequent
attempt will be made to interpret the stringVal
as the classname of a suitable class with a no-arg constructor.
stringToObject
in class Parameter<ProcessingStep[]>
env
- execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultsval
- non-null, non-empty string value
TaskException
public ProcessingStep[] stepsValue(Environment env) throws TaskException
env
- execution environment
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 |