|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<T>
uk.ac.starlink.task.ChoiceParameter<JoinFixActionParameter.Fixer>
uk.ac.starlink.ttools.task.JoinFixActionParameter
public class JoinFixActionParameter
Parameter which can control how column names are renamed if they would otherwise be duplicated in an output table.
Nested Class Summary | |
---|---|
class |
JoinFixActionParameter.Fixer
Helper class which defines how suffixes are turned into JoinFixActions. |
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
JoinFixActionParameter(String name)
Constructor. |
Method Summary | |
---|---|
StringParameter |
createSuffixParameter(String numLabel)
Returns a new parameter, identified by a numeric-like label, by which per-table suffix strings can be specified. |
StringParameter |
createSuffixParameter(String name,
String descrip,
String dflt)
Returns a new parameter by which per-table suffix strings can be specified. |
JoinFixAction |
getJoinFixAction(Environment env,
StringParameter suffixParam)
Returns the action specified by this parameter for a given label. |
JoinFixAction[] |
getJoinFixActions(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, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, getUsage, objectToString, setDefaultOption, setUsage, stringifyOption, 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 |
---|
public JoinFixActionParameter(String name)
name
- parameter nameMethod Detail |
---|
public JoinFixAction getJoinFixAction(Environment env, StringParameter suffixParam) throws TaskException
env
- execution environmentsuffixParam
- parameter supplying suffix value
(got from a createSuffixParameter
method)
TaskException
public JoinFixAction[] getJoinFixActions(Environment env, int nin) throws TaskException
env
- execution environmentnin
- size of fix action array
nin
-element array of fix actions ("1", "2", ...)
TaskException
public StringParameter createSuffixParameter(String numLabel)
numLabel
- table identifier such as "1"public StringParameter createSuffixParameter(String name, String descrip, String dflt)
name
- parameter namedescrip
- phrase identifying table that this parameter controls
(such as "table 3")dflt
- default value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |