FilterParameter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.task.Parameter<ProcessingStep[]>
- - uk.ac.starlink.ttools.task.FilterParameter

All Implemented Interfaces:

uk.ac.starlink.task.MultiParameter, ExtraParameter
```
public class FilterParameter
extends uk.ac.starlink.task.Parameter<ProcessingStep[]>
implements ExtraParameter, uk.ac.starlink.task.MultiParameter
```
Parameter which contains a value representing one or more ProcessingSteps.

Since:

17 Aug 2005

Author:

Mark Taylor

Field Summary
- Fields inherited from class uk.ac.starlink.task.Parameter
  BY_NAME

Constructor Summary

Constructors
Constructor and Description

FilterParameter(java.lang.String name)

Constructors
Constructor and Description
`FilterParameter(java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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)`

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
  - FilterParameter
```
public FilterParameter(java.lang.String name)
```
- Method Detail
  - setTableDescription
```
public final 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. The description and prompt are set. If not set, the wording "the table" is used to describe the table.
    
    Parameters:
    
    shortDescrip - text to replace "the table"
    
    tableParam - if supplied, gives the table parameter on behalf of which this format parameter is operating; may be null
    
    isBefore - TRUE means filter is applied before any other processing, FALSE means after, null don't know
  - getValueSeparator
```
public char getValueSeparator()
```
    Specified by:
    
    getValueSeparator in interface uk.ac.starlink.task.MultiParameter
  - stringToObject
```
public ProcessingStep[] stringToObject(uk.ac.starlink.task.Environment env,
                                       java.lang.String sval)
                                throws uk.ac.starlink.task.TaskException
```
    Specified by:
    
    stringToObject in class uk.ac.starlink.task.Parameter<ProcessingStep[]>
    
    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 java.lang.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 java.lang.String getFiltersUsage(TableEnvironment env)
```
    Returns a formatted string listing available filter commands with their usage.
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    usge string

Class FilterParameter

Field Summary

Fields inherited from class uk.ac.starlink.task.Parameter

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.task.Parameter

Methods inherited from class java.lang.Object

Constructor Detail

FilterParameter

Method Detail

setTableDescription

getValueSeparator

stringToObject

stepsValue

getExtraUsage

getFiltersUsage