uk.ac.starlink.ttools.join
Class JoinTypeParameter

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

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

Parameter which can select a JoinType.

Since:
8 Sep 2005
Author:
Mark Taylor

Constructor Summary
JoinTypeParameter(String name)
           
 
Method Summary
 uk.ac.starlink.table.join.JoinType joinTypeValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a JoinType.
 
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
 

Constructor Detail

JoinTypeParameter

public JoinTypeParameter(String name)
Method Detail

joinTypeValue

public uk.ac.starlink.table.join.JoinType joinTypeValue(uk.ac.starlink.task.Environment env)
                                                 throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a JoinType.

Returns:
join type
Throws:
uk.ac.starlink.task.TaskException


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