uk.ac.starlink.ttools.task

Class VariableTablesInput

java.lang.Object

uk.ac.starlink.ttools.task.VariableTablesInput

All Implemented Interfaces:

TablesInput

public class VariableTablesInput
extends 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)). 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.

Since:

1 Jul 2010

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
FilterParameter	createFilterParameter(String label) Constructs an input filter parameter with a given distinguishing label.
InputTableParameter	createInputParameter(String label) Constructs an input table parameter with a given distinguishing label.
IntegerParameter	getCountParam() Returns the parameter which contains the number of input tables that the user wants to use.
FilterParameter	getFilterParameter(int i) Returns a parameter used for acquiring an input filter for one of the numbered input tables.
InputTableSpec[]	getInputSpecs(Environment env) Returns an array of InputTableSpec objects describing the input tables used by this task.
InputTableParameter	getInputTableParameter(int i) Returns a parameter used for acquiring one of the numbered input tables.
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

NUM_SUFFIX

public static final 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,
                           String inName,
                           String inWord)

Constructs an input tables parameter with a given base name.

Parameters:

useInFilters - whether to use input filter parameters

inName - base name for parameter

inWord - base word describing parameter content for textual descriptions

Method Detail

getCountParam

public IntegerParameter getCountParam()

Returns the parameter which contains the number of input tables that the user wants to use.

Returns:

count parameter

getParameters

public Parameter<?>[] getParameters()

Description copied from interface: TablesInput

Returns the parameters associated with this object.

Specified by:

getParameters in interface TablesInput

Returns:

parameters

getInputSpecs

public InputTableSpec[] getInputSpecs(Environment env)
                               throws TaskException

Description copied from interface: TablesInput

Returns an array of InputTableSpec objects describing the input tables used by this task.

Specified by:

getInputSpecs in interface TablesInput

Parameters:

env - execution environment

Returns:

input table specifiers

Throws:

TaskException

getInputTableParameter

public InputTableParameter getInputTableParameter(int i)

Description copied from interface: TablesInput

Returns a parameter used for acquiring one of the numbered input tables.

Behaviour is undefined if you ask for a table index not applicable to this input.

Specified by:

getInputTableParameter in interface TablesInput

Parameters:

i - table index (0-based)

Returns:

table input parameter

getFilterParameter

public FilterParameter getFilterParameter(int i)

Description copied from interface: TablesInput

Returns a parameter used for acquiring an input filter for one of the numbered input tables.

Behaviour is undefined if you ask for a table index not applicable to this input.

Specified by:

getFilterParameter in interface TablesInput

Parameters:

i - table index (0-based)

Returns:

input filter parameter

createInputParameter

public InputTableParameter createInputParameter(String label)

Constructs an input table parameter with a given distinguishing label.

Parameters:

label - input identifier - typically "1", "2", etc

Returns:

new input parameter

createFilterParameter

public FilterParameter createFilterParameter(String label)

Constructs an input filter parameter with a given distinguishing label.

Parameters:

label - input identifier - typically "1", "2", etc

Returns:

new filter parameter