|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<T>
uk.ac.starlink.ttools.task.AbstractInputTableParameter<T>
public abstract class AbstractInputTableParameter<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.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
protected |
AbstractInputTableParameter(String name,
Class<T> clazz)
Constructor. |
Method Summary | |
---|---|
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. |
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 |
---|
protected AbstractInputTableParameter(String name, Class<T> clazz)
name
- parameter nameMethod Detail |
---|
public InputFormatParameter getFormatParameter()
public BooleanParameter getStreamParameter()
public final void setTableDescription(String inDescrip)
inDescrip
- text to replace "the input table"protected StarTable makeTable(Environment env, String loc) throws TaskException
env
- execution environmentloc
- table location string
TaskException
protected StarTable[] makeTables(Environment env, String loc) throws TaskException
env
- execution environmentloc
- table location string
TaskException
public static String getLocationFormList(InputFormatParameter fmtParam)
fmtParam
- associated input format parameter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |