Package uk.ac.starlink.ttools.task
Class HomogeneousTablesInput
java.lang.Object
uk.ac.starlink.ttools.task.HomogeneousTablesInput
- All Implemented Interfaces:
TablesInput
TablesInput which has a variable number of input tables,
treating them all the same as each other.
A single, possibly repeated, parameter is used to specify any
number of input tables, and a single (not repeated) filter
parameter is used to specify a processing pipeline which operates
identically on all the inputs.
- Since:
- 1 Jul 2010
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetFilterParameter
(int i) Returns a parameter used for acquiring an input filter for one of the numbered input tables.getInputSpecs
(uk.ac.starlink.task.Environment env) Returns an array of InputTableSpec objects describing the input tables used by this task.getInputTableParameter
(int i) Returns a parameter used for acquiring one of the numbered input tables.uk.ac.starlink.task.Parameter<?>[]
Returns the parameters associated with this object.
-
Constructor Details
-
HomogeneousTablesInput
public HomogeneousTablesInput(boolean useInFilter) Constructor.- Parameters:
useInFilter
- whether preprocessing filters are permitted
-
-
Method Details
-
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
-
getInputTableParameter
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 interfaceTablesInput
- Parameters:
i
- table index (0-based)- Returns:
- table input parameter
-
getFilterParameter
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 interfaceTablesInput
- Parameters:
i
- table index (0-based)- Returns:
- input filter parameter
-