uk.ac.starlink.ttools.join
Class FindModeParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<T>
      extended by uk.ac.starlink.task.ChoiceParameter<PairMode>
          extended by uk.ac.starlink.ttools.join.FindModeParameter

public class FindModeParameter
extends ChoiceParameter<PairMode>

Parameter for choosing table pair match mode.

Since:
2 Nov 2007
Author:
Mark Taylor

Field Summary
 
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
 
Constructor Summary
FindModeParameter(String name)
          Constructor.
 
Method Summary
static String getModeDescription(PairMode mode)
          Returns additional description for each given pair matching mode.
 String stringifyOption(PairMode option)
          Determines how an option will be represented as a string value of this parameter if no name has explicitly been supplied.
 
Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, getUsage, objectToString, setDefaultOption, setUsage, stringToObject
 
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
 

Constructor Detail

FindModeParameter

public FindModeParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

stringifyOption

public String stringifyOption(PairMode option)
Description copied from class: ChoiceParameter
Determines how an option will be represented as a string value of this parameter if no name has explicitly been supplied. The default implementation is String.valueOf(option), but this may be overrridden.

Overrides:
stringifyOption in class ChoiceParameter<PairMode>
Parameters:
option - option value
Returns:
string representation of option

getModeDescription

public static String getModeDescription(PairMode mode)
Returns additional description for each given pair matching mode.

Parameters:
mode - mode to describe
Returns:
XML-friendly description


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