Class FindModeParameter


  • public class FindModeParameter
    extends uk.ac.starlink.task.ChoiceParameter<uk.ac.starlink.table.join.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

      Constructors 
      Constructor Description
      FindModeParameter​(java.lang.String name)
      Constructor.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getModeDescription​(uk.ac.starlink.table.join.PairMode mode)
      Returns additional description for each given pair matching mode.
      java.lang.String stringifyOption​(uk.ac.starlink.table.join.PairMode option)  
      • 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​(java.lang.String name)
        Constructor.
        Parameters:
        name - parameter name
    • Method Detail

      • stringifyOption

        public java.lang.String stringifyOption​(uk.ac.starlink.table.join.PairMode option)
        Overrides:
        stringifyOption in class uk.ac.starlink.task.ChoiceParameter<uk.ac.starlink.table.join.PairMode>
      • getModeDescription

        public static java.lang.String getModeDescription​(uk.ac.starlink.table.join.PairMode mode)
        Returns additional description for each given pair matching mode.
        Parameters:
        mode - mode to describe
        Returns:
        XML-friendly description