Package uk.ac.starlink.ttools.task
Class VariableTablesInput
- java.lang.Object
-
- uk.ac.starlink.ttools.task.VariableTablesInput
-
- All Implemented Interfaces:
TablesInput
public class VariableTablesInput extends java.lang.Object implements TablesInput
TablesInput which allows a variable number of input tables, fixed at runtime using an integer parameter. Each input table has its own input format and filter parameters and so on.This object constructs its list of parameters on the fly when the environment is available (within
getInputSpecs(uk.ac.starlink.task.Environment)
). ThegetParameters()
method returns a list which is suitable for documentation purposes only. Execution environments which need thegetParameters
call to return the actual list of parameters to be used may not therefore be able to work with instances of this class.- Since:
- 1 Jul 2010
- Author:
- Mark Taylor
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NUM_SUFFIX
Suffix applied to parameters to denote a symbolic variable part of the name, where the symbolic part can take integer values.
-
Constructor Summary
Constructors Constructor Description VariableTablesInput(boolean useInFilters)
Constructs an input tables parameter with a default base name.VariableTablesInput(boolean useInFilters, java.lang.String inName, java.lang.String inWord)
Constructs an input tables parameter with a given base name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description uk.ac.starlink.task.IntegerParameter
getCountParam()
Returns the parameter which contains the number of input tables that the user wants to use.InputTableSpec[]
getInputSpecs(uk.ac.starlink.task.Environment env)
Returns an array of InputTableSpec objects describing the input tables used by this task.uk.ac.starlink.task.Parameter<?>[]
getParameters()
Returns the parameters associated with this object.
-
-
-
Field Detail
-
NUM_SUFFIX
public static final java.lang.String NUM_SUFFIX
Suffix applied to parameters to denote a symbolic variable part of the name, where the symbolic part can take integer values.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
VariableTablesInput
public VariableTablesInput(boolean useInFilters)
Constructs an input tables parameter with a default base name.- Parameters:
useInFilters
- whether to use input filter parameters
-
VariableTablesInput
public VariableTablesInput(boolean useInFilters, java.lang.String inName, java.lang.String inWord)
Constructs an input tables parameter with a given base name.- Parameters:
useInFilters
- whether to use input filter parametersinName
- base name for parameterinWord
- base word describing parameter content for textual descriptions
-
-
Method Detail
-
getCountParam
public uk.ac.starlink.task.IntegerParameter getCountParam()
Returns the parameter which contains the number of input tables that the user wants to use.- Returns:
- count parameter
-
getParameters
public uk.ac.starlink.task.Parameter<?>[] getParameters()
Description copied from interface:TablesInput
Returns the parameters associated with this object.- Specified by:
getParameters
in interfaceTablesInput
- Returns:
- parameters
-
getInputSpecs
public InputTableSpec[] getInputSpecs(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
Description copied from interface:TablesInput
Returns an array of InputTableSpec objects describing the input tables used by this task.- Specified by:
getInputSpecs
in interfaceTablesInput
- Parameters:
env
- execution environment- Returns:
- input table specifiers
- Throws:
uk.ac.starlink.task.TaskException
-
-