uk.ac.starlink.ttools.join
Class MatchEngineParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.ttools.join.MatchEngineParameter
All Implemented Interfaces:
ExtraParameter

public class MatchEngineParameter
extends uk.ac.starlink.task.Parameter
implements ExtraParameter

Parameter for acquiring a MatchEngine.

Since:
2 Sep 2005
Author:
Mark Taylor

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

MatchEngineParameter

public MatchEngineParameter(String name)
Method Detail

getExtraUsage

public String getExtraUsage(TableEnvironment env)
Description copied from interface: ExtraParameter
Returns an extended usage message. This should not repeat the content of the normal usage message. It should be preformatted, that is it should contain newlines to keep the line length down to less than 80 characters.

Specified by:
getExtraUsage in interface ExtraParameter
Parameters:
env - execution envrionment
Returns:
extended usage message

getMatchParametersParameter

public 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.

Returns:
params parameter

getScoreParameter

public uk.ac.starlink.task.Parameter getScoreParameter()
Returns the associated parameter which is used for specifying the match score column metadata. Do not interrogate this parameter directly - use getScoreInfo(uk.ac.starlink.task.Environment).

Returns:
match score parameter

getScoreInfo

public uk.ac.starlink.table.ValueInfo getScoreInfo(uk.ac.starlink.task.Environment env)
                                            throws uk.ac.starlink.task.TaskException
Returns the match score metadata associated with this parameter.

Parameters:
env - execution environment
Returns:
match score metadata; may be null
Throws:
uk.ac.starlink.task.TaskException

createMatchTupleParameter

public WordsParameter createMatchTupleParameter(String numLabel)
Creates a new parameter for specifying value tuples for a table, suitable for use with this one.

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.

Parameters:
numLabel - identifier for the new parameter

configureTupleParameter

public static void configureTupleParameter(WordsParameter tupleParam,
                                           uk.ac.starlink.table.join.MatchEngine matcher)
Configures a tuple parameter for use with a given MatchEngine. Amongst other things, the required word count will be set, so that its WordsParameter.wordsValue(uk.ac.starlink.task.Environment) will return an array of the correct size for the match engine.

Parameters:
tupleParam - tuple parameter to interrogate, probably generated earlier by createMatchTupleParameter(java.lang.String)
matcher - match engine which will be used

matchEngineValue

public uk.ac.starlink.table.join.MatchEngine matchEngineValue(uk.ac.starlink.task.Environment env)
                                                       throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a MatchEngine.

Parameters:
env - execution environment
Returns:
match engine
Throws:
uk.ac.starlink.task.TaskException

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String stringVal)
                        throws uk.ac.starlink.task.TaskException
Overrides:
setValueFromString in class uk.ac.starlink.task.Parameter
Throws:
uk.ac.starlink.task.TaskException

createEngine

public uk.ac.starlink.table.join.MatchEngine createEngine(String name)
                                                   throws uk.ac.starlink.task.UsageException
Returns a new, unconfigured match engine given a short naming string. Names may be separated by a '+', in which case a combined engine is returned.

Parameters:
name - label to select match engine type
Returns:
new match engine
Throws:
uk.ac.starlink.task.UsageException

getValuesUsage

public 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.

Parameters:
engine - match engine
Returns:
values usage - possibly empty, not null

getParamsUsage

public 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.

Parameters:
engine - match engine
Returns:
params usage - possibly empty, not null

getExampleValues

public static String[] getExampleValues()
Returns strings naming a set of example match engine parameter values. These are used in the documentation.



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