uk.ac.starlink.ttools.task

Interface TablesInput

All Known Implementing Classes:

FixedTablesInput, HomogeneousTablesInput, VariableTablesInput

public interface TablesInput

Interface for an object which can acquire multiple input tables.

Since:

2 Jul 2010

Author:

Mark Taylor

Method Summary

Modifier and Type	Method and Description
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.
AbstractInputTableParameter<?>	getInputTableParameter(int i) Returns a parameter used for acquiring one of the numbered input tables.
Parameter<?>[]	getParameters() Returns the parameters associated with this object.

Method Detail

getParameters

Parameter<?>[] getParameters()

Returns the parameters associated with this object.

Returns:

parameters

getInputSpecs

InputTableSpec[] getInputSpecs(Environment env)
                        throws TaskException

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

Parameters:

env - execution environment

Returns:

input table specifiers

Throws:

TaskException

getInputTableParameter

AbstractInputTableParameter<?> getInputTableParameter(int i)

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.

Parameters:

i - table index (0-based)

Returns:

table input parameter

getFilterParameter

FilterParameter getFilterParameter(int i)

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.

Parameters:

i - table index (0-based)

Returns:

input filter parameter