Package opennlp.tools.cmdline.namefind
Class CensusDictionaryCreatorTool
java.lang.Object
opennlp.tools.cmdline.CmdLineTool
opennlp.tools.cmdline.BasicCmdLineTool
opennlp.tools.cmdline.namefind.CensusDictionaryCreatorTool
public class CensusDictionaryCreatorTool
extends opennlp.tools.cmdline.BasicCmdLineTool
This tool helps create a loadable dictionary for the
NameFinder
,
from data collected from US Census data.
Data for the US Census and names can be found here for the 1990 Census:
www.census.gov
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Dictionary
createDictionary
(ObjectStream<StringList> sampleStream) Creates a dictionary.getHelp()
void
Executes the tool with the given parameters.Methods inherited from class opennlp.tools.cmdline.CmdLineTool
getName, hasParams
-
Constructor Details
-
CensusDictionaryCreatorTool
public CensusDictionaryCreatorTool()
-
-
Method Details
-
getShortDescription
- Overrides:
getShortDescription
in classopennlp.tools.cmdline.CmdLineTool
- Returns:
- Retrieves a short description of what the tool does
-
getHelp
- Specified by:
getHelp
in classopennlp.tools.cmdline.CmdLineTool
- Returns:
- Retrieves a description on how to use the tool
-
createDictionary
Creates a dictionary.- Parameters:
sampleStream
- stream of samples.- Returns:
- a
Dictionary
class containing the name dictionary built from the input file. - Throws:
IOException
- IOException
-
run
Description copied from class:opennlp.tools.cmdline.BasicCmdLineTool
Executes the tool with the given parameters.- Specified by:
run
in classopennlp.tools.cmdline.BasicCmdLineTool
- Parameters:
args
- arguments
-