Package opennlp.tools.formats
Class NameFinderCensus90NameStream
java.lang.Object
opennlp.tools.formats.NameFinderCensus90NameStream
- All Implemented Interfaces:
AutoCloseable,ObjectStream<StringList>
@Internal
public class NameFinderCensus90NameStream
extends Object
implements ObjectStream<StringList>
This class helps to read the US Census data from the files to build a
StringList for each dictionary entry in the name-finder dictionary.
The entries in the source file are as follows:
SMITH 1.006 1.006 1
- The first field is the name (in ALL CAPS).
- The next field is a frequency in percent.
- The next is a cumulative frequency in percent.
- The last is a ranking.
Note: Do not use this class, internal use only!
-
Constructor Summary
ConstructorsConstructorDescriptionNameFinderCensus90NameStream(InputStreamFactory in, Charset encoding) NameFinderCensus90NameStream(ObjectStream<String> lineStream) Initializes aNameFinderCensus90NameStreamviaObjectStream<String>. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes theObjectStreamand releases all allocated resources.read()Returns the nextObjectStreamobject.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
-
Constructor Details
-
NameFinderCensus90NameStream
Initializes aNameFinderCensus90NameStreamviaObjectStream<String>.- Parameters:
lineStream- AnObjectStream<String>that represents the input file to be attached to this class.
-
NameFinderCensus90NameStream
Initializes aNameFinderCensus90NameStreamvia anInputStreamFactoryand aCharset. Opens an associated stream object with the specified encoding specified.- Parameters:
in- TheInputStreamFactoryfor the input file.encoding- theCharsetto apply to the input stream.- Throws:
IOException- Thrown if IO errors occurred.
-
-
Method Details
-
read
Description copied from interface:ObjectStreamReturns the nextObjectStreamobject. Calling this method repeatedly until it returnsnullwill return each object from the underlying source exactly once.- Specified by:
readin interfaceObjectStream<StringList>- Returns:
- The next object or
nullto signal that the stream is exhausted. - Throws:
IOException- Thrown if there is an error during reading.
-
reset
Description copied from interface:ObjectStreamRepositions the stream at the beginning and the previously seen object sequence will be repeated exactly. This method can be used to re-read the stream if multiple passes over the objects are required.The implementation of this method is optional.
- Specified by:
resetin interfaceObjectStream<StringList>- Throws:
IOException- Thrown if there is an error during resetting the stream.UnsupportedOperationException- Thrown if thereset()is not supported. By default, this is the case.
-
close
Description copied from interface:ObjectStreamCloses theObjectStreamand releases all allocated resources. After close was called, it's not allowed to callObjectStream.read()orObjectStream.reset().- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceObjectStream<StringList>- Throws:
IOException- Thrown if there is an error during closing the stream.
-