Package uk.ac.starlink.ttools.task
Class InputTablesParameter
java.lang.Object
uk.ac.starlink.task.Parameter<TableProducer[]>
uk.ac.starlink.ttools.task.AbstractInputTableParameter<TableProducer[]>
uk.ac.starlink.ttools.task.InputTablesParameter
- All Implemented Interfaces:
uk.ac.starlink.task.MultiParameter
public class InputTablesParameter
extends AbstractInputTableParameter<TableProducer[]>
implements uk.ac.starlink.task.MultiParameter
Parameter for specifying an indeterminate number of input tables.
All use the same format specifier and streaming flag.
- Since:
- 15 Sep 2006
- Author:
- Mark Taylor
-
Field Summary
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionuk.ac.starlink.task.BooleanParameter
Returns the parameter which determines whether just the first or all tables in a multi-table container file will be used.char
objectToString
(uk.ac.starlink.task.Environment env, TableProducer[] tables) Sets the value of this parameter from an array of TableProducers.stringToObject
(uk.ac.starlink.task.Environment env, String sval) ThetoString
method of the returned elements can be used to refer to them in user-directed messages.Methods inherited from class uk.ac.starlink.ttools.task.AbstractInputTableParameter
getFormatParameter, getLocationFormList, getStreamParameter, makeTable, makeTable, makeTables, setTableDescription
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
-
Constructor Details
-
InputTablesParameter
Constructor.- Parameters:
name
- parameter name
-
-
Method Details
-
getMultiParameter
public uk.ac.starlink.task.BooleanParameter getMultiParameter()Returns the parameter which determines whether just the first or all tables in a multi-table container file will be used.- Returns:
- multi-table parameter
-
getValueSeparator
public char getValueSeparator()- Specified by:
getValueSeparator
in interfaceuk.ac.starlink.task.MultiParameter
-
stringToObject
public TableProducer[] stringToObject(uk.ac.starlink.task.Environment env, String sval) throws uk.ac.starlink.task.TaskException ThetoString
method of the returned elements can be used to refer to them in user-directed messages.- Specified by:
stringToObject
in classuk.ac.starlink.task.Parameter<TableProducer[]>
- Throws:
uk.ac.starlink.task.TaskException
-
objectToString
Sets the value of this parameter from an array of TableProducers. ThetoString
method of each element should be suitable for use in user-directed messges.- Overrides:
objectToString
in classuk.ac.starlink.task.Parameter<TableProducer[]>
-