uk.ac.starlink.ttools.task

Class AbstractInputTableParameter<T>

java.lang.Object

uk.ac.starlink.task.Parameter<T>

uk.ac.starlink.ttools.task.AbstractInputTableParameter<T>

Direct Known Subclasses:

InputTableParameter, InputTablesParameter

public abstract class AbstractInputTableParameter<T>
extends Parameter<T>

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

Field Summary

Fields inherited from class uk.ac.starlink.task.Parameter

BY_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInputTableParameter(String name, Class<T> clazz) Constructor.

Method Summary

Modifier and Type	Method and Description
InputFormatParameter	getFormatParameter() Returns the parameter which deals with input format.
static String	getLocationFormList(InputFormatParameter fmtParam) Returns an XML list element enumerating the forms in which a single table may be specified.
BooleanParameter	getStreamParameter() Returns the stream toggle parameter associated with this one.
protected StarTable	makeTable(Environment env, String loc) Constructs a StarTable from a location string given the current state of this parameter and its associated parameter values.
StarTable	makeTable(String loc, String fmt, boolean stream, StarTableFactory tfact) Reads a table given fixed values for the various parameters.
protected StarTable[]	makeTables(Environment env, String loc) Constructs an array of tables from a location string given the current state of this parameter and its associated parameter values.
void	setTableDescription(String inDescrip) Sets the wording used to refer to the input table in parameter descriptions.

Methods inherited from class uk.ac.starlink.task.Parameter

clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringToObject, stringValue, toArray, 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,
                                      Class<T> clazz)

Constructor.

Parameters:

name - parameter name

Method Detail

getFormatParameter

public InputFormatParameter getFormatParameter()

Returns the parameter which deals with input format.

Returns:

format parameter

getStreamParameter

public BooleanParameter getStreamParameter()

Returns the stream toggle parameter associated with this one.

Returns:

stream parameter

setTableDescription

public final void setTableDescription(String inDescrip)

Sets the wording used to refer to the input table in parameter descriptions. This parameter and the associated parameters (format and stream) are affected. If not set, the wording "the input table" is used.

Parameters:

inDescrip - text to replace "the input table"

makeTable

protected StarTable makeTable(Environment env,
                              String loc)
                       throws 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:

TaskException

makeTable

public StarTable makeTable(String loc,
                           String fmt,
                           boolean stream,
                           StarTableFactory tfact)
                    throws IOException,
                           TaskException

Reads a table given fixed values for the various parameters.

Parameters:

loc - table location

fmt - input format string

stream - true for streamed input

tfact - table factory

Returns:

table loaded

Throws:

IOException

TaskException

makeTables

protected StarTable[] makeTables(Environment env,
                                 String loc)
                          throws TaskException

Constructs an array of tables from a location string given the current state of this parameter and its associated parameter values. The returned number of tables may only be plural if the table format is capable of supplying multiple tables.

Parameters:

env - execution environment

loc - table location string

Returns:

tables at loc

Throws:

TaskException

getLocationFormList

public static String getLocationFormList(InputFormatParameter fmtParam)

Returns an XML list element enumerating the forms in which a single table may be specified.

Parameters:

fmtParam - associated input format parameter

Returns:

ul element