uk.ac.starlink.ttools.join
Class FindModeParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.task.ChoiceParameter
          extended by uk.ac.starlink.ttools.join.FindModeParameter

public class FindModeParameter
extends uk.ac.starlink.task.ChoiceParameter

Parameter for choosing table match mode. Either BEST or ALL may be chosen.

Since:
2 Nov 2007
Author:
Mark Taylor

Field Summary
static String ALL
          Value for all metches mode.
static String BEST
          Value for best match only mode.
 
Constructor Summary
FindModeParameter(String name)
          Constructor.
 
Method Summary
 boolean bestOnlyValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a flag indicating whether it's only the best matches or all that are required.
 
Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, getName, getOption, getOptionNames, getOptions, getUsage, objectValue, setDefaultOption, setUsage, setValueFromString
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, stringValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BEST

public static final String BEST
Value for best match only mode.

See Also:
Constant Field Values

ALL

public static final String ALL
Value for all metches mode.

See Also:
Constant Field Values
Constructor Detail

FindModeParameter

public FindModeParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

bestOnlyValue

public boolean bestOnlyValue(uk.ac.starlink.task.Environment env)
                      throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a flag indicating whether it's only the best matches or all that are required.

Parameters:
env - execution environment
Returns:
true for best matches only, false for all matches
Throws:
uk.ac.starlink.task.TaskException


Copyright © 2009 Central Laboratory of the Research Councils. All Rights Reserved.