Package opennlp.tools.util
Class AbstractEventStream<T>
- java.lang.Object
-
- opennlp.tools.util.AbstractEventStream<T>
-
- Type Parameters:
T- The generic type representing samples.
- All Implemented Interfaces:
AutoCloseable,ObjectStream<Event>
- Direct Known Subclasses:
AbstractParserEventStream,ChunkerEventStream,DocumentCategorizerEventStream,LanguageDetectorEventStream,LemmaSampleEventStream,NameFinderEventStream,POSSampleEventStream,SDEventStream,TokSpanEventStream
public abstract class AbstractEventStream<T> extends Object implements ObjectStream<Event>
A baseObjectStreamimplementation for events.
-
-
Constructor Summary
Constructors Constructor Description AbstractEventStream(ObjectStream<T> samples)Initializes anAbstractEventStreamwith a sampleIterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes theObjectStreamand releases all allocated resources.Eventread()Returns the nextObjectStreamobject.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
-
-
-
Constructor Detail
-
AbstractEventStream
public AbstractEventStream(ObjectStream<T> samples)
Initializes anAbstractEventStreamwith a sampleIterator.- Parameters:
samples- TheIteratorthat provides theAbstractEventStreamsamples.
-
-
Method Detail
-
read
public final Event read() throws IOException
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<T>- Returns:
- The next object or
nullto signal that the stream is exhausted. - Throws:
IOException- Thrown 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<T>- 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
public void close() throws IOExceptionDescription 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<T>- Throws:
IOException- Thrown if there is an error during closing the stream.
-
-