uk.ac.starlink.ttools.task

Class InputFormatParameter

java.lang.Object

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

uk.ac.starlink.task.StringParameter

uk.ac.starlink.ttools.task.InputFormatParameter

All Implemented Interfaces:

ExtraParameter

public class InputFormatParameter
extends StringParameter
implements ExtraParameter

Parameter for selecting input table format.

Since:

15 Aug 2005

Author:

Mark Taylor

Field Summary

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

BY_NAME

Constructor Summary

Constructors

Constructor and Description
InputFormatParameter(String name)

Method Summary

Modifier and Type	Method and Description
String	getExtraUsage(TableEnvironment env) Returns an extended usage message.
String	getUsage() Returns the usage string for this parameter.
void	setTableDescription(String inDescrip, AbstractInputTableParameter<?> tableParam) Sets the wording used to refer to the input table in parameter descriptions.
String	stringToObject(Environment env, String stringval) Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter.

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

clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InputFormatParameter

public InputFormatParameter(String name)

Method Detail

setTableDescription

public final void setTableDescription(String inDescrip,
                                      AbstractInputTableParameter<?> tableParam)

Sets the wording used to refer to the input table in parameter descriptions. If not set, the wording "the input table" is used.

Parameters:

inDescrip - text to replace "the input table"

tableParam - if supplied, gives the table parameter on behalf of which this format parameter is operating; may be null

getUsage

public String getUsage()

Description copied from class: Parameter

Returns the usage string for this parameter.

Overrides:

getUsage in class Parameter<String>

Returns:

usage string

See Also:

Parameter.setUsage(java.lang.String)

getExtraUsage

public String getExtraUsage(TableEnvironment env)

Description copied from interface: ExtraParameter

Returns an extended usage message. This should not repeat the content of the normal usage message. It should be preformatted, that is it should contain newlines to keep the line length down to less than 80 characters.

Specified by:

getExtraUsage in interface ExtraParameter

Parameters:

env - execution envrionment

Returns:

extended usage message

stringToObject

public String stringToObject(Environment env,
                             String stringval)
                      throws TaskException

Description copied from class: Parameter

Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. This method also performs validation, so if the string value is unacceptable in any way, a ParameterValueException should be thrown.

It is an error to supply a null or empty string value.

If this method fails (throws a ParameterValueException) and if allowClassnameValue is set, then a subsequent attempt will be made to interpret the stringVal as the classname of a suitable class with a no-arg constructor.

Overrides:

stringToObject in class StringParameter

Parameters:

env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result

stringval - non-null, non-empty string value

Returns:

typed value

Throws:

TaskException