uk.ac.starlink.ttools.task
Class JoinFixActionParameter

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

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

Parameter which can control how column names are renamed if they would otherwise be duplicated in an output table.

Since:
20 Nov 2007
Author:
Mark Taylor

Constructor Summary
JoinFixActionParameter(String name)
          Constructor.
 
Method Summary
 uk.ac.starlink.task.Parameter createSuffixParameter(String numLabel)
          Returns a new parameter, identified by a numeric-like label, by which per-table suffix strings can be specified.
 uk.ac.starlink.task.Parameter createSuffixParameter(String name, String descrip, String dflt)
          Returns a new parameter by which per-table suffix strings can be specified.
 uk.ac.starlink.table.JoinFixAction getJoinFixAction(uk.ac.starlink.task.Environment env, uk.ac.starlink.task.Parameter suffixParam)
          Returns the action specified by this parameter for a given label.
 uk.ac.starlink.table.JoinFixAction[] getJoinFixActions(uk.ac.starlink.task.Environment env, int nin)
          Returns an array of fix actions, one for each of a list of numbered input tables.
 
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

JoinFixActionParameter

public JoinFixActionParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

getJoinFixAction

public uk.ac.starlink.table.JoinFixAction getJoinFixAction(uk.ac.starlink.task.Environment env,
                                                           uk.ac.starlink.task.Parameter suffixParam)
                                                    throws uk.ac.starlink.task.TaskException
Returns the action specified by this parameter for a given label.

Parameters:
env - execution environment
suffixParam - parameter supplying suffix value (got from a createSuffixParameter method)
Throws:
uk.ac.starlink.task.TaskException

getJoinFixActions

public uk.ac.starlink.table.JoinFixAction[] getJoinFixActions(uk.ac.starlink.task.Environment env,
                                                              int nin)
                                                       throws uk.ac.starlink.task.TaskException
Returns an array of fix actions, one for each of a list of numbered input tables. This is a convenience method that relies on conventional naming of suffix parameters.

Parameters:
env - execution environment
nin - size of fix action array
Returns:
nin-element array of fix actions ("1", "2", ...)
Throws:
uk.ac.starlink.task.TaskException

createSuffixParameter

public uk.ac.starlink.task.Parameter createSuffixParameter(String numLabel)
Returns a new parameter, identified by a numeric-like label, by which per-table suffix strings can be specified.

Parameters:
numLabel - table identifier such as "1"

createSuffixParameter

public uk.ac.starlink.task.Parameter createSuffixParameter(String name,
                                                           String descrip,
                                                           String dflt)
Returns a new parameter by which per-table suffix strings can be specified.

Parameters:
name - parameter name
descrip - phrase identifying table that this parameter controls (such as "table 3")
dflt - default value


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