uk.ac.starlink.ttools.task
Class InputTablesParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<T>
      extended by uk.ac.starlink.ttools.task.AbstractInputTableParameter<TableProducer[]>
          extended by uk.ac.starlink.ttools.task.InputTablesParameter
All Implemented Interfaces:
MultiParameter

public class InputTablesParameter
extends AbstractInputTableParameter<TableProducer[]>
implements 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
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

InputTablesParameter

public InputTablesParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

getMultiParameter

public 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()
Description copied from interface: MultiParameter
Returns a character which is to be used as the separator between values found in adjacent occurrences of the parameter in the execution environment.

Specified by:
getValueSeparator in interface MultiParameter

stringToObject

public TableProducer[] stringToObject(Environment env,
                                      String sval)
                               throws TaskException
The toString method of the returned elements can be used to refer to them in user-directed messages.

Specified by:
stringToObject in class Parameter<TableProducer[]>
Parameters:
env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result
sval - non-null, non-empty string value
Returns:
typed value
Throws:
TaskException

objectToString

public String objectToString(Environment env,
                             TableProducer[] tables)
Sets the value of this parameter from an array of TableProducers. The toString method of each element should be suitable for use in user-directed messges.

Overrides:
objectToString in class Parameter<TableProducer[]>
Parameters:
env - execution environment
tables - typed parameter value
Returns:
string value for presentation


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.