uk.ac.starlink.ttools.join

Class Match1TypeParameter

java.lang.Object

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

uk.ac.starlink.ttools.join.Match1TypeParameter

public class Match1TypeParameter
extends Parameter<Match1Type>

Parameter subclass whose value is a Match1Type object.

Since:

16 Nov 2007

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELIMINATE_0 Parameter value for keep0 action.
static String	ELIMINATE_1 Parameter value for keep1 action.
static String	IDENTIFY Parameter value for identify action.
static String	WIDE_PREFIX Parameter value prefix for n-fold table output.

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

BY_NAME

Constructor Summary

Constructors

Constructor and Description
Match1TypeParameter(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
Match1Type	stringToObject(Environment env, String sval) Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter.
Match1Type	typeValue(Environment env) Returns the value of this parameter as a Match1Type object.

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, stringValue, toArray, toString

Methods inherited from class java.lang.Object

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

Field Detail

IDENTIFY

public static final String IDENTIFY

Parameter value for identify action.

See Also:

Constant Field Values

ELIMINATE_0

public static final String ELIMINATE_0

Parameter value for keep0 action.

See Also:

Constant Field Values

ELIMINATE_1

public static final String ELIMINATE_1

Parameter value for keep1 action.

See Also:

Constant Field Values

WIDE_PREFIX

public static final String WIDE_PREFIX

Parameter value prefix for n-fold table output.

See Also:

Constant Field Values

Constructor Detail

Match1TypeParameter

public Match1TypeParameter(String name)

Constructor.

Parameters:

name - parameter name

Method Detail

typeValue

public Match1Type typeValue(Environment env)
                     throws TaskException

Returns the value of this parameter as a Match1Type object.

Parameters:

env - execution environment

Throws:

TaskException

stringToObject

public Match1Type stringToObject(Environment env,
                                 String sval)
                          throws ParameterValueException

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.

Specified by:

stringToObject in class Parameter<Match1Type>

Parameters:

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

sval - non-null, non-empty string value

Returns:

typed value

Throws:

ParameterValueException