|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter
uk.ac.starlink.task.ChoiceParameter
uk.ac.starlink.ttools.join.FindModeParameter
public class FindModeParameter
Parameter for choosing table match mode. Either BEST or ALL may be chosen.
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 |
---|
public static final String BEST
public static final String ALL
Constructor Detail |
---|
public FindModeParameter(String name)
name
- parameter nameMethod Detail |
---|
public boolean bestOnlyValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
env
- execution environment
uk.ac.starlink.task.TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |