uk.ac.starlink.ttools.task
Class VariableMapperTask

java.lang.Object
  extended by uk.ac.starlink.ttools.task.ConsumerTask
      extended by uk.ac.starlink.ttools.task.MapperTask
          extended by uk.ac.starlink.ttools.task.VariableMapperTask
All Implemented Interfaces:
uk.ac.starlink.task.Task
Direct Known Subclasses:
TableCatN, TableJoinN, TableMatchN

public class VariableMapperTask
extends MapperTask

MapperTask 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 task constructs its list of parameters on the fly within its ConsumerTask.createExecutable(uk.ac.starlink.task.Environment) method. The ConsumerTask.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:
5 Oct 2006
Author:
Mark Taylor

Constructor Summary
VariableMapperTask(String purpose, ProcessingMode outMode, boolean useOutFilter, TableMapper mapper, boolean useInFilters)
          Constructor.
 
Method Summary
protected  InputTableSpec[] getInputSpecs(uk.ac.starlink.task.Environment env)
          Returns an array of InputTableSpec objects describing the input tables used by this task.
 
Methods inherited from class uk.ac.starlink.ttools.task.MapperTask
createProducer, getMapper
 
Methods inherited from class uk.ac.starlink.ttools.task.ConsumerTask
createExecutable, createProducer, getOutputMode, getParameterList, getParameters, getPurpose
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VariableMapperTask

public VariableMapperTask(String purpose,
                          ProcessingMode outMode,
                          boolean useOutFilter,
                          TableMapper mapper,
                          boolean useInFilters)
Constructor.

Parameters:
purpose - one-line description of the purpose of the task
outMode - processing mode which determines the destination of the processed table
useOutFilter - allow specification of filters for output table
mapper - object which defines mapping transformation
useInFilters - whether to use input filter parameters
Method Detail

getInputSpecs

protected InputTableSpec[] getInputSpecs(uk.ac.starlink.task.Environment env)
                                  throws uk.ac.starlink.task.TaskException
Description copied from class: MapperTask
Returns an array of InputTableSpec objects describing the input tables used by this task.

Specified by:
getInputSpecs in class MapperTask
Parameters:
env - execution environment
Returns:
input table specifiers
Throws:
uk.ac.starlink.task.TaskException


Copyright © 2009 Central Laboratory of the Research Councils. All Rights Reserved.