Package opennlp.tools.formats
Class NameFinderCensus90NameStream
- java.lang.Object
-
- opennlp.tools.formats.NameFinderCensus90NameStream
-
- All Implemented Interfaces:
AutoCloseable,ObjectStream<StringList>
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
Constructors Constructor Description NameFinderCensus90NameStream(InputStreamFactory in, Charset encoding)This constructor takes anInputStreamand aCharsetand opens an associated stream object with the specified encoding specified.NameFinderCensus90NameStream(ObjectStream<String> lineStream)This constructor takes an ObjectStream and initializes the class to handle the stream.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes theObjectStreamand releases all allocated resources.StringListread()Returns the next object.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
-
-
-
Constructor Detail
-
NameFinderCensus90NameStream
public NameFinderCensus90NameStream(ObjectStream<String> lineStream)
This constructor takes an ObjectStream and initializes the class to handle the stream.- Parameters:
lineStream- anObjectSteam<String>that represents the input file to be attached to this class.
-
NameFinderCensus90NameStream
public NameFinderCensus90NameStream(InputStreamFactory in, Charset encoding) throws IOException
This constructor takes anInputStreamand aCharsetand opens an associated stream object with the specified encoding specified.- Parameters:
in- anInputStreamFactoryfor the input file.encoding- theCharsetto apply to the input stream.- Throws:
IOException
-
-
Method Detail
-
read
public StringList read() throws IOException
Description copied from interface:ObjectStreamReturns the next object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.- Specified by:
readin interfaceObjectStream<StringList>- Returns:
- the next object or null to signal that the stream is exhausted
- Throws:
IOException- if there is an error during reading
-
reset
public void reset() throws IOException, UnsupportedOperationExceptionDescription 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- if there is an error during reseting the streamUnsupportedOperationException
-
close
public void close() throws IOExceptionDescription copied from interface:ObjectStreamCloses theObjectStreamand releases all allocated resources. After close was called its not allowed to call read or reset.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceObjectStream<StringList>- Throws:
IOException- if there is an error during closing the stream
-
-