|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<MatchEngine>
uk.ac.starlink.ttools.join.MatchEngineParameter
public class MatchEngineParameter
Parameter for acquiring a MatchEngine
.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
MatchEngineParameter(String name)
|
Method Summary | |
---|---|
static void |
configureTupleParameter(WordsParameter tupleParam,
MatchEngine matcher)
Configures a tuple parameter for use with a given MatchEngine. |
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. |
String |
getConfigUsage(MatchEngine engine,
Parameter wordsParam,
DescribedValue[] configs)
Returns a string giving the usage for a parameter with configuration subparameters. |
static String[] |
getExampleValues()
Returns strings naming a set of example match engine parameter values. |
String |
getExtraUsage(TableEnvironment env)
Returns an extended usage message. |
static String |
getInfoUsage(ValueInfo info)
Returns a usage fragment appropriate to specifying a value on the command line in accordance with the metadata given in a ValueInfo object. |
Parameter |
getMatchParametersParameter()
Returns the associated parameter which is used for specifying the fixed value parameters for the engine supplied by this parameter. |
ValueInfo |
getScoreInfo(Environment env)
Returns the match score metadata associated with this parameter. |
Parameter |
getScoreParameter()
Returns the associated parameter which is used for specifying the match score column metadata. |
Parameter |
getTuningParametersParameter()
Returns the associated parameter which is used for specifying optional tuning parameters for the engine supplied by this parameter. |
String |
getValuesUsage(MatchEngine engine,
int startLeng)
Returns a string giving the usage for the values parameter part of the matching command line. |
MatchEngine |
matchEngineValue(Environment env)
Returns the value of this parameter as a MatchEngine. |
MatchEngine |
stringToObject(Environment env,
String stringVal)
Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. |
Methods inherited from class uk.ac.starlink.task.Parameter |
---|
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, 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 MatchEngineParameter(String name)
Method Detail |
---|
public String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionment
public Parameter getMatchParametersParameter()
public Parameter getTuningParametersParameter()
public Parameter getScoreParameter()
getScoreInfo(uk.ac.starlink.task.Environment)
.
public ValueInfo getScoreInfo(Environment env) throws TaskException
env
- execution environment
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, 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 MatchEngine matchEngineValue(Environment env) throws TaskException
env
- execution environment
TaskException
public MatchEngine stringToObject(Environment env, String stringVal) throws TaskException
Parameter
It is an error to supply a null or empty string value.
If this method fails (throws a ParameterValueException)
and if allowClassnameValue
is set, then a subsequent
attempt will be made to interpret the stringVal
as the classname of a suitable class with a no-arg constructor.
stringToObject
in class Parameter<MatchEngine>
env
- execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultstringVal
- non-null, non-empty string value
TaskException
public MatchEngine createEngine(String name) throws UsageException
name
- label to select match engine type
UsageException
public String getValuesUsage(MatchEngine engine, int startLeng)
engine
- match enginestartLeng
- running line length at which the values part
begins on the output
public String getConfigUsage(MatchEngine engine, Parameter wordsParam, DescribedValue[] configs)
engine
- match enginewordsParam
- parameter providing values for the subparametersconfigs
- modifiable subparameters
public static String getInfoUsage(ValueInfo info)
info
- value metadata specification
public static String[] getExampleValues()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |