uk.ac.starlink.ttools.task
Class InputTableParameter
java.lang.Object
uk.ac.starlink.task.Parameter<T>
uk.ac.starlink.ttools.task.AbstractInputTableParameter<StarTable>
uk.ac.starlink.ttools.task.InputTableParameter
public class InputTableParameter
- extends AbstractInputTableParameter<StarTable>
Parameter for specifying a single input table.
- Author:
- Mark Taylor
Methods inherited from class uk.ac.starlink.task.Parameter |
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString |
InputTableParameter
public InputTableParameter(String name)
- Constructor.
- Parameters:
name
- parameter name
stringToObject
public StarTable stringToObject(Environment env,
String sval)
throws TaskException
- Returns the input table which has been selected by this parameter.
- Specified by:
stringToObject
in class Parameter<StarTable>
- Parameters:
env
- execution environmentsval
- non-null, non-empty string value
- Returns:
- typed value
- Throws:
TaskException
objectToString
public String objectToString(Environment env,
StarTable table)
- Description copied from class:
Parameter
- Takes a typed value of this parameter and formats it as a string
which may be used for presentation to the user.
Ideally, round-tripping between this method and
stringToObject
should be possible,
but that is not in general required/guaranteed.
The default implementation uses the value's toString method,
but subclasses can override this for smarter behaviour.
- Overrides:
objectToString
in class Parameter<StarTable>
- Parameters:
env
- execution environmenttable
- typed parameter value
- Returns:
- string value for presentation
tableValue
public StarTable tableValue(Environment env)
throws TaskException
- Throws:
TaskException
Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.