uk.ac.starlink.ttools.task
Class InputTablesParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.ttools.task.AbstractInputTableParameter
          extended by uk.ac.starlink.ttools.task.InputTablesParameter
All Implemented Interfaces:
uk.ac.starlink.task.MultiParameter

public class InputTablesParameter
extends AbstractInputTableParameter
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

Constructor Summary
InputTablesParameter(String name)
          Constructor.
 
Method Summary
 char getValueSeparator()
           
 void setValueFromTables(TableProducer[] tables)
          Sets the value of this parameter from an array of tables.
 String[] stringsValue(uk.ac.starlink.task.Environment env)
          Returns an array of table locations representing the input tables specified by this parameter.
 TableProducer[] tablesValue(uk.ac.starlink.task.Environment env)
          Returns the array of tables specified by this parameter.
 
Methods inherited from class uk.ac.starlink.ttools.task.AbstractInputTableParameter
getFormatParameter, getStreamParameter, makeTable
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, setValueFromString, stringValue, 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

getValueSeparator

public char getValueSeparator()
Specified by:
getValueSeparator in interface uk.ac.starlink.task.MultiParameter

tablesValue

public TableProducer[] tablesValue(uk.ac.starlink.task.Environment env)
                            throws uk.ac.starlink.task.TaskException
Returns the array of tables specified by this parameter.

Parameters:
env - execution environment
Returns:
array of input tables
Throws:
uk.ac.starlink.task.TaskException

stringsValue

public String[] stringsValue(uk.ac.starlink.task.Environment env)
                      throws uk.ac.starlink.task.TaskException
Returns an array of table locations representing the input tables specified by this parameter.

Parameters:
env - execution environment
Returns:
input table locations
Throws:
uk.ac.starlink.task.TaskException

setValueFromTables

public void setValueFromTables(TableProducer[] tables)
Sets the value of this parameter from an array of tables.

Parameters:
tables - input table array


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