|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter
uk.ac.starlink.ttools.join.MatchEngineParameter
public class MatchEngineParameter
Parameter for acquiring a MatchEngine
.
Constructor Summary | |
---|---|
MatchEngineParameter(String name)
|
Method Summary | |
---|---|
static void |
configureTupleParameter(WordsParameter tupleParam,
uk.ac.starlink.table.join.MatchEngine matcher)
Configures a tuple parameter for use with a given MatchEngine. |
uk.ac.starlink.table.join.MatchEngine |
createEngine(String name)
Returns a new, unconfigured match engine given a short naming string. |
WordsParameter |
createMatchTupleParameter(String numLabel)
Creates a new parameter for specifying value tuples for a table, suitable for use with this one. |
static String[] |
getExampleValues()
Returns strings naming a set of example match engine parameter values. |
String |
getExtraUsage(TableEnvironment env)
Returns an extended usage message. |
uk.ac.starlink.task.Parameter |
getMatchParametersParameter()
Returns the associated parameter which is used for specifying the fixed value parameters for the engine supplied by this parameter. |
String |
getParamsUsage(uk.ac.starlink.table.join.MatchEngine engine)
Returns a string giving the usage for the match parameters part of the matching command line. |
uk.ac.starlink.table.ValueInfo |
getScoreInfo(uk.ac.starlink.task.Environment env)
Returns the match score metadata associated with this parameter. |
uk.ac.starlink.task.Parameter |
getScoreParameter()
Returns the associated parameter which is used for specifying the match score column metadata. |
String |
getValuesUsage(uk.ac.starlink.table.join.MatchEngine engine)
Returns a string giving the usage for the values parameter part of the matching command line. |
uk.ac.starlink.table.join.MatchEngine |
matchEngineValue(uk.ac.starlink.task.Environment env)
Returns the value of this parameter as a MatchEngine. |
void |
setValueFromString(uk.ac.starlink.task.Environment env,
String stringVal)
|
Methods inherited from class uk.ac.starlink.task.Parameter |
---|
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, stringValue, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MatchEngineParameter(String name)
Method Detail |
---|
public String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionment
public uk.ac.starlink.task.Parameter getMatchParametersParameter()
public uk.ac.starlink.task.Parameter getScoreParameter()
getScoreInfo(uk.ac.starlink.task.Environment)
.
public uk.ac.starlink.table.ValueInfo getScoreInfo(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
env
- execution environment
uk.ac.starlink.task.TaskException
public WordsParameter createMatchTupleParameter(String numLabel)
The supplied numLabel
parameter distinguishes the
parameter name if there are several; it is usually "1", "2", ...
or "N" for a generic number or "" if there is only one.
The autogenerated documentation will be adjusted accordingly.
numLabel
- identifier for the new parameterpublic static void configureTupleParameter(WordsParameter tupleParam, uk.ac.starlink.table.join.MatchEngine matcher)
WordsParameter.wordsValue(uk.ac.starlink.task.Environment)
will
return an array of the correct size for the match engine.
tupleParam
- tuple parameter to interrogate, probably generated
earlier by createMatchTupleParameter(java.lang.String)
matcher
- match engine which will be usedpublic uk.ac.starlink.table.join.MatchEngine matchEngineValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
env
- execution environment
uk.ac.starlink.task.TaskException
public void setValueFromString(uk.ac.starlink.task.Environment env, String stringVal) throws uk.ac.starlink.task.TaskException
setValueFromString
in class uk.ac.starlink.task.Parameter
uk.ac.starlink.task.TaskException
public uk.ac.starlink.table.join.MatchEngine createEngine(String name) throws uk.ac.starlink.task.UsageException
name
- label to select match engine type
uk.ac.starlink.task.UsageException
public String getValuesUsage(uk.ac.starlink.table.join.MatchEngine engine)
engine
- match engine
public String getParamsUsage(uk.ac.starlink.table.join.MatchEngine engine)
engine
- match engine
public static String[] getExampleValues()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |