Package opennlp.tools.formats.masc
Class MascNamedEntitySampleStream
java.lang.Object
opennlp.tools.util.FilterObjectStream<MascDocument,NameSample>
opennlp.tools.formats.masc.MascNamedEntitySampleStream
- All Implemented Interfaces:
AutoCloseable,ObjectStream<NameSample>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes theObjectStreamand releases all allocated resources.read()Reads the next sample of named entities.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
-
Constructor Details
-
MascNamedEntitySampleStream
InitializesMascNamedEntitySampleStreamfrom a stream ofdocuments.- Parameters:
samples- AObjectStream<MascDocument>of samples.- Throws:
IOException- Thrown if none of the documents has NE labels.
-
-
Method Details
-
read
Reads the next sample of named entities.- Returns:
- One
sentence together with its named entity annotation. - Throws:
IOException- Thrown if the sample cannot be extracted
-
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<NameSample>- Overrides:
closein classFilterObjectStream<MascDocument,NameSample> - Throws:
IOException- Thrown if there is an error during closing the stream.
-
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<NameSample>- Overrides:
resetin classFilterObjectStream<MascDocument,NameSample> - 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.
-