uk.ac.starlink.ttools.task
Class AbstractInputTableParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.ttools.task.AbstractInputTableParameter
Direct Known Subclasses:
InputTableParameter, InputTablesParameter

public abstract class AbstractInputTableParameter
extends uk.ac.starlink.task.Parameter

Parameter used to select a table for input. This abstract superclass provides general facilities for input tables; there are concrete subclasses for single and multiple input table values.

Since:
15 Sep 2006
Author:
Mark Taylor

Constructor Summary
protected AbstractInputTableParameter(String name)
          Constructor.
 
Method Summary
 InputFormatParameter getFormatParameter()
          Returns the parameter which deals with input format.
 uk.ac.starlink.task.BooleanParameter getStreamParameter()
          Returns the stream toggle parameter associated with this one.
protected  uk.ac.starlink.table.StarTable makeTable(uk.ac.starlink.task.Environment env, String loc)
          Constructs a StarTable from a location string given the current state of this parameter and its associated parameter values.
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, setValueFromString, stringValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractInputTableParameter

protected AbstractInputTableParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

getFormatParameter

public InputFormatParameter getFormatParameter()
Returns the parameter which deals with input format.

Returns:
format parameter

getStreamParameter

public uk.ac.starlink.task.BooleanParameter getStreamParameter()
Returns the stream toggle parameter associated with this one.

Returns:
stream parameter

makeTable

protected uk.ac.starlink.table.StarTable makeTable(uk.ac.starlink.task.Environment env,
                                                   String loc)
                                            throws uk.ac.starlink.task.TaskException
Constructs a StarTable from a location string given the current state of this parameter and its associated parameter values.

Parameters:
env - execution environment
loc - table location string
Returns:
table at loc
Throws:
uk.ac.starlink.task.TaskException


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