opennlp.tools.cmdline.namefind

Class TokenNameFinderTrainerTool

java.lang.Object

opennlp.tools.cmdline.CmdLineTool

opennlp.tools.cmdline.TypedCmdLineTool<T>

opennlp.tools.cmdline.AbstractTypedParamTool<T,P>

opennlp.tools.cmdline.AbstractTrainerTool<NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>

opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool

public final class TokenNameFinderTrainerTool
extends AbstractTrainerTool<NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>

Field Summary

Fields inherited from class opennlp.tools.cmdline.AbstractTrainerTool

factory, mlParams, params, sampleStream

Fields inherited from class opennlp.tools.cmdline.AbstractTypedParamTool

paramsClass

Fields inherited from class opennlp.tools.cmdline.TypedCmdLineTool

type

Constructor Summary

Constructors

Constructor and Description
TokenNameFinderTrainerTool()

Method Summary

Methods

Modifier and Type	Method and Description
String	getShortDescription() Retrieves a short description of what the tool does.
static Map<String,Object>	loadResources(File resourcePath, File featureGenDescriptor) Load the resources, such as dictionaries, by reading the feature xml descriptor and looking into the directory passed as argument.
void	run(String format, String[] args) Executes the tool with the given parameters.

Methods inherited from class opennlp.tools.cmdline.AbstractTypedParamTool

getHelp

Methods inherited from class opennlp.tools.cmdline.TypedCmdLineTool

getBasicHelp, getHelp, getStreamFactory, validateAllArgs, validateFactoryArgs

Methods inherited from class opennlp.tools.cmdline.CmdLineTool

getBasicHelp, getName, hasParams, validateAndParseParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TokenNameFinderTrainerTool

public TokenNameFinderTrainerTool()

Method Detail

getShortDescription

public String getShortDescription()

Description copied from class: CmdLineTool

Retrieves a short description of what the tool does.

Overrides:

getShortDescription in class CmdLineTool

Returns:

a short description of what the tool does

loadResources

public static Map<String,Object> loadResources(File resourcePath,
                               File featureGenDescriptor)

Load the resources, such as dictionaries, by reading the feature xml descriptor and looking into the directory passed as argument.

Parameters:

resourcePath - the directory in which the resources are to be found

featureGenDescriptor - the feature xml descriptor

Returns:

a map consisting of the file name of the resource and its corresponding Object

run

public void run(String format,
       String[] args)

Description copied from class: TypedCmdLineTool

Executes the tool with the given parameters.

Overrides:

run in class AbstractTrainerTool<NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>

Parameters:

format - format to work with

args - command line arguments