|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.task.VariableTablesInput
public class VariableTablesInput
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)
).
The getParameters()
method returns a list which is suitable
for documentation purposes only.
Execution environments which need the getParameters
call to return the actual list of parameters to be used may not
therefore be able to work with instances of this class.
Field Summary | |
---|---|
static 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 | |
---|---|
VariableTablesInput(boolean useInFilters)
Constructs an input tables parameter with a default base name. |
|
VariableTablesInput(boolean useInFilters,
String inName,
String inWord)
Constructs an input tables parameter with a given base name. |
Method Summary | |
---|---|
IntegerParameter |
getCountParam()
Returns the parameter which contains the number of input tables that the user wants to use. |
InputTableSpec[] |
getInputSpecs(Environment env)
Returns an array of InputTableSpec objects describing the input tables used by this task. |
Parameter[] |
getParameters()
Returns the parameters associated with this object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String NUM_SUFFIX
Constructor Detail |
---|
public VariableTablesInput(boolean useInFilters)
useInFilters
- whether to use input filter parameterspublic VariableTablesInput(boolean useInFilters, String inName, String inWord)
useInFilters
- whether to use input filter parametersinName
- base name for parameterinWord
- base word describing parameter content for textual
descriptionsMethod Detail |
---|
public IntegerParameter getCountParam()
public Parameter[] getParameters()
TablesInput
getParameters
in interface TablesInput
public InputTableSpec[] getInputSpecs(Environment env) throws TaskException
TablesInput
getInputSpecs
in interface TablesInput
env
- execution environment
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |