uk.ac.starlink.ttools.task

Class HomogeneousTablesInput

java.lang.Object

uk.ac.starlink.ttools.task.HomogeneousTablesInput

All Implemented Interfaces:

TablesInput

public class HomogeneousTablesInput
extends Object
implements 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

Constructor and Description
HomogeneousTablesInput(boolean useInFilter) Constructor.

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.
InputTablesParameter	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

Constructor Detail

HomogeneousTablesInput

public HomogeneousTablesInput(boolean useInFilter)

Constructor.

Parameters:

useInFilter - whether preprocessing filters are permitted

Method Detail

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 InputTablesParameter 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