|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<T>
uk.ac.starlink.ttools.task.AbstractInputTableParameter<TableProducer[]>
uk.ac.starlink.ttools.task.InputTablesParameter
public class InputTablesParameter
Parameter for specifying an indeterminate number of input tables. All use the same format specifier and streaming flag.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
InputTablesParameter(String name)
Constructor. |
Method Summary | |
---|---|
BooleanParameter |
getMultiParameter()
Returns the parameter which determines whether just the first or all tables in a multi-table container file will be used. |
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. |
String |
objectToString(Environment env,
TableProducer[] tables)
Sets the value of this parameter from an array of TableProducers. |
TableProducer[] |
stringToObject(Environment env,
String sval)
The toString 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, 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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public InputTablesParameter(String name)
name
- parameter nameMethod Detail |
---|
public BooleanParameter getMultiParameter()
public char getValueSeparator()
MultiParameter
getValueSeparator
in interface MultiParameter
public TableProducer[] stringToObject(Environment env, String sval) throws TaskException
toString
method of the returned elements
can be used to refer to them in user-directed messages.
stringToObject
in class Parameter<TableProducer[]>
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 String objectToString(Environment env, TableProducer[] tables)
toString
method of each element should be suitable
for use in user-directed messges.
objectToString
in class Parameter<TableProducer[]>
env
- execution environmenttables
- typed parameter value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |