opennlp.tools.cmdline
Interface CmdLineTool

All Known Implementing Classes:

AbstractConverterTool, BuildModelUpdaterTool, CensusDictionaryCreatorTool, CheckModelUpdaterTool, ChunkerMETool, ChunkerTrainerTool, DictionaryDetokenizerTool, DoccatTool, DoccatTrainerTool, ParserTool, ParserTrainerTool, POSTaggerConverter, POSTaggerEvaluatorTool, POSTaggerTool, POSTaggerTrainerTool, SentenceDetectorConverterTool, SentenceDetectorCrossValidatorTool, SentenceDetectorEvaluatorTool, SentenceDetectorTool, SentenceDetectorTrainerTool, SimpleTokenizerTool, TaggerModelReplacerTool, TokenizerConverterTool, TokenizerCrossValidatorTool, TokenizerMEEvaluatorTool, TokenizerMETool, TokenizerTrainerTool, TokenNameFinderConverterTool, TokenNameFinderEvaluatorTool, TokenNameFinderTool, TokenNameFinderTrainerTool

public interface CmdLineTool

A tool which can be executed from the command line.

Note: Do not use this class, internal use only!

Method Summary

String	getHelp() Retrieves a description on how to use the tool.
String	getName() Retrieves the name of the training data tool.
String	getShortDescription() Retrieves a short description of what the tool does.
void	run(String[] args) Executes the tool with the given parameters.

Method Detail

getName

String getName()

Retrieves the name of the training data tool. The name (used as command) must not contain white spaces.

Returns:

the name of the command line tool

getShortDescription

String getShortDescription()

Retrieves a short description of what the tool does.

Returns:

getHelp

String getHelp()

Retrieves a description on how to use the tool.

Returns:

run

void run(String[] args)

Executes the tool with the given parameters.

Parameters:

args -