Package opennlp.tools.formats.ad
Class ADSentenceSampleStream
java.lang.Object
opennlp.tools.formats.ad.ADSentenceSampleStream
- All Implemented Interfaces:
AutoCloseable,ObjectStream<SentenceSample>
@Internal
public class ADSentenceSampleStream
extends Object
implements ObjectStream<SentenceSample>
Note:
Do not use this class, internal use only!
-
Constructor Summary
ConstructorsConstructorDescriptionADSentenceSampleStream(InputStreamFactory in, String charsetName, boolean includeHeadlines) Initializes a newADSentenceSampleStream.ADSentenceSampleStream(ObjectStream<String> lineStream, boolean includeHeadlines) Initializes a newADSentenceSampleStreamfrom aObjectStream<String>, that could be aPlainTextByLineStreamobject. -
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
-
ADSentenceSampleStream
Initializes a newADSentenceSampleStreamfrom aObjectStream<String>, that could be aPlainTextByLineStreamobject.- Parameters:
lineStream- A stream of lines asString.includeHeadlines- Iftruewill output the sentences marked as news headlines.
-
ADSentenceSampleStream
public ADSentenceSampleStream(InputStreamFactory in, String charsetName, boolean includeHeadlines) throws IOException Initializes a newADSentenceSampleStream.- Parameters:
in- TheInputStreamFactoryfor the corpus.charsetName- Thecharsetto use for reading of the corpus.includeHeadlines- Iftruewill output the sentences marked as news headlines.- 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<SentenceSample>- 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<SentenceSample>- 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<SentenceSample>- Throws:
IOException- Thrown if there is an error during closing the stream.
-