Package uk.ac.starlink.ttools.filter
Class SetParameterFilter
- java.lang.Object
-
- uk.ac.starlink.ttools.filter.BasicFilter
-
- uk.ac.starlink.ttools.filter.SetParameterFilter
-
- All Implemented Interfaces:
ProcessingFilter
public class SetParameterFilter extends BasicFilter
Filter which sets a parameter on the table.- Since:
- 2 Aug 2006
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description SetParameterFilter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ProcessingStep
createStep(java.util.Iterator<java.lang.String> argIt)
Creates a new ProcessingStep based on a sequence of command-line arguments.static java.lang.Object
evaluate(java.lang.String expr, uk.ac.starlink.table.StarTable table, java.lang.Class<?> clazz, java.lang.String type)
Evaluates an expression in the context of a table.protected java.lang.String[]
getDescriptionLines()
-
Methods inherited from class uk.ac.starlink.ttools.filter.BasicFilter
explainSyntax, getDescription, getName, getUsage
-
-
-
-
Method Detail
-
getDescriptionLines
protected java.lang.String[] getDescriptionLines()
- Specified by:
getDescriptionLines
in classBasicFilter
-
createStep
public ProcessingStep createStep(java.util.Iterator<java.lang.String> argIt) throws ArgException
Description copied from interface:ProcessingFilter
Creates a new ProcessingStep based on a sequence of command-line arguments. The argIt argument is an iterator over the command-line arguments positioned just before any arguments intended for this filter. If legal, any that can be comprehended by this filter should be read (iterated over) and removed, and a ProcessingStep should accordingly be returned. In the case of a successful return, it is essential that no arguments other than the ones intended for this filter are read from the iterator.If the argument list is badly-formed as far as this filter is concerned, an
ArgException
should be thrown.- Parameters:
argIt
- iterator over command-line arguments positioned at the first one- Throws:
ArgException
-
evaluate
public static java.lang.Object evaluate(java.lang.String expr, uk.ac.starlink.table.StarTable table, java.lang.Class<?> clazz, java.lang.String type) throws java.io.IOException
Evaluates an expression in the context of a table. If a class is specified, the result is guaranteed to be of the type indicated by that class (or an error will be thrown). If no JEL expression can be evaluated, the supplied expression itself will be returned as a string, as long as that is not inconsistent with the requested class.- Parameters:
expr
- expression to evaluatetable
- evaluation contextclazz
- required class of result, or null; a primitive, rather than wrapper, class should be supplied if availabletype
- user-supplied string corresponding to clazz, or null (used for error messages only)- Throws:
java.io.IOException
-
-