public class JoinFixActionParameter extends uk.ac.starlink.task.ChoiceParameter<JoinFixActionParameter.Fixer>
Modifier and Type | Class and Description |
---|---|
class |
JoinFixActionParameter.Fixer
Helper class which defines how suffixes are turned into JoinFixActions.
|
Constructor and Description |
---|
JoinFixActionParameter(java.lang.String name)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
uk.ac.starlink.task.StringParameter |
createSuffixParameter(java.lang.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.StringParameter |
createSuffixParameter(java.lang.String name,
java.lang.String descrip,
java.lang.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.StringParameter 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.
|
addOption, addOption, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, getUsage, objectToString, setDefaultOption, setUsage, stringifyOption, stringToObject
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
public JoinFixActionParameter(java.lang.String name)
name
- parameter namepublic uk.ac.starlink.table.JoinFixAction getJoinFixAction(uk.ac.starlink.task.Environment env, uk.ac.starlink.task.StringParameter suffixParam) throws uk.ac.starlink.task.TaskException
env
- execution environmentsuffixParam
- parameter supplying suffix value
(got from a createSuffixParameter
method)uk.ac.starlink.task.TaskException
public uk.ac.starlink.table.JoinFixAction[] getJoinFixActions(uk.ac.starlink.task.Environment env, int nin) throws uk.ac.starlink.task.TaskException
env
- execution environmentnin
- size of fix action arraynin
-element array of fix actions ("1", "2", ...)uk.ac.starlink.task.TaskException
public uk.ac.starlink.task.StringParameter createSuffixParameter(java.lang.String numLabel)
numLabel
- table identifier such as "1"public uk.ac.starlink.task.StringParameter createSuffixParameter(java.lang.String name, java.lang.String descrip, java.lang.String dflt)
name
- parameter namedescrip
- phrase identifying table that this parameter controls
(such as "table 3")dflt
- default valueCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.