TokenNameFinderTrainerTool (Apache OpenNLP :: Core :: CLI 3.0.0-M4 API)
Description: declaration: package: opennlp.tools.cmdline.namefind, class: TokenNameFinderTrainerTool

Package opennlp.tools.cmdline.namefind

# Class TokenNameFinderTrainerTool

java.lang.Object
opennlp.tools.cmdline.CmdLineTool
opennlp.tools.cmdline.TypedCmdLineTool<opennlp.tools.namefind.NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>
opennlp.tools.cmdline.AbstractTypedParamTool<opennlp.tools.namefind.NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>
opennlp.tools.cmdline.AbstractEvaluatorTool<opennlp.tools.namefind.NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>
opennlp.tools.cmdline.AbstractTrainerTool<opennlp.tools.namefind.NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>
opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool

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

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `TokenNameFinderTrainerTool()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getShortDescription()`
  `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.
  `static byte[]`
  `openFeatureGeneratorBytes(File featureGenDescriptorFile)`
  `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

  `getHelp`

  ### Methods inherited from class opennlp.tools.cmdline.CmdLineTool

  `getName, hasParams`

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### TokenNameFinderTrainerTool

    public TokenNameFinderTrainerTool()

- ## Method Details

  - ### getShortDescription

    public String getShortDescription()
    Overrides:
      `getShortDescription` in class `opennlp.tools.cmdline.CmdLineTool`
    Returns:
      Retrieves a short description of what the tool does

  - ### openFeatureGeneratorBytes

    public static byte[] openFeatureGeneratorBytes(File featureGenDescriptorFile)

  - ### loadResources

    public static Map<String,Object> loadResources(File resourcePath, File featureGenDescriptor) throws IOException
    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.
    Throws:
      `IOException`

  - ### run

    public void run(String format, String[] args)
    Description copied from class: `opennlp.tools.cmdline.TypedCmdLineTool`
    Executes the tool with the given parameters.
    Overrides:
      `run` in class `opennlp.tools.cmdline.AbstractEvaluatorTool<opennlp.tools.namefind.NameSample,opennlp.tools.cmdline.namefind.TokenNameFinderTrainerTool.TrainerToolParams>`
    Parameters:
      `format` - format to work with
      `args` - command line arguments