uk.ac.starlink.ttools.task

Class RowRunnerParameter

java.lang.Object

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

uk.ac.starlink.task.AbstractChoiceParameter<T,T>

uk.ac.starlink.task.ChoiceParameter<RowRunner>

uk.ac.starlink.ttools.task.RowRunnerParameter

public class RowRunnerParameter
extends ChoiceParameter<RowRunner>

Parameter for acquiring a RowRunner.

The details of documentation differ according to what the runner is to be used for, so factory methods are provided instead of a public constructor.

Since:

3 Oct 2022

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static RowRunner	DFLT_MATCH_RUNNER Default runner instance for cross-matching purposes.

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

BY_NAME

Method Summary

Modifier and Type	Method and Description
static RowRunnerParameter	createMatchRunnerParameter(String name) Creates a runner parameter suitable for use with crossmatching tasks.
static RowRunnerParameter	createScanRunnerParameter(String name) Creates a runner parameter suitable for use when scanning large tables.
RowRunner	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.

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

getUsage, objectToString, setDefaultOption, setUsage

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

addOption, addOption, choiceToString, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, stringifyOption, stringToChoice

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

clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, 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

DFLT_MATCH_RUNNER

public static final RowRunner DFLT_MATCH_RUNNER

Default runner instance for cross-matching purposes.

Method Detail

stringToObject

public RowRunner stringToObject(Environment env,
                                String sval)
                         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 ChoiceParameter<RowRunner>

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:

TaskException

createScanRunnerParameter

public static RowRunnerParameter createScanRunnerParameter(String name)

Creates a runner parameter suitable for use when scanning large tables.

Parameters:

name - parameter name

Returns:

new parameter

createMatchRunnerParameter

public static RowRunnerParameter createMatchRunnerParameter(String name)

Creates a runner parameter suitable for use with crossmatching tasks. The parameter value may be null, which corresponds to legacy (non-threaded) operation.

Parameters:

name - parameter name

Returns:

new parameter