public abstract class AbstractInputTableParameter<T>
extends uk.ac.starlink.task.Parameter<T>
Modifier | Constructor and Description |
---|---|
protected |
AbstractInputTableParameter(java.lang.String name,
java.lang.Class<T> clazz)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
InputFormatParameter |
getFormatParameter()
Returns the parameter which deals with input format.
|
static java.lang.String |
getLocationFormList(InputFormatParameter fmtParam)
Returns an XML list element enumerating the forms in which a
single table may be specified.
|
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,
java.lang.String loc)
Constructs a StarTable from a location string given the current
state of this parameter and its associated parameter values.
|
protected uk.ac.starlink.table.StarTable[] |
makeTables(uk.ac.starlink.task.Environment env,
java.lang.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(java.lang.String inDescrip)
Sets the wording used to refer to the input table in parameter
descriptions.
|
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
protected AbstractInputTableParameter(java.lang.String name, java.lang.Class<T> clazz)
name
- parameter namepublic InputFormatParameter getFormatParameter()
public uk.ac.starlink.task.BooleanParameter getStreamParameter()
public final void setTableDescription(java.lang.String inDescrip)
inDescrip
- text to replace "the input table"protected uk.ac.starlink.table.StarTable makeTable(uk.ac.starlink.task.Environment env, java.lang.String loc) throws uk.ac.starlink.task.TaskException
env
- execution environmentloc
- table location stringuk.ac.starlink.task.TaskException
protected uk.ac.starlink.table.StarTable[] makeTables(uk.ac.starlink.task.Environment env, java.lang.String loc) throws uk.ac.starlink.task.TaskException
env
- execution environmentloc
- table location stringuk.ac.starlink.task.TaskException
public static java.lang.String getLocationFormList(InputFormatParameter fmtParam)
fmtParam
- associated input format parameterCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.