Package opennlp.tools.formats.masc

Class MascTokenSampleStream

java.lang.Object

opennlp.tools.util.FilterObjectStream<MascDocument,TokenSample>

opennlp.tools.formats.masc.MascTokenSampleStream

All Implemented Interfaces:

AutoCloseable, ObjectStream<TokenSample>

public class MascTokenSampleStream
extends FilterObjectStream<MascDocument,TokenSample>

Constructor Summary

Constructors

Constructor	Description
MascTokenSampleStream(ObjectStream<MascDocument> samples)	Initializes a MascTokenSampleStream.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the ObjectStream and releases all allocated resources.
TokenSample	read()	Returns the next ObjectStream object.
void	reset()	Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MascTokenSampleStream

public MascTokenSampleStream(ObjectStream<MascDocument> samples)
                      throws IOException

Initializes a MascTokenSampleStream.

Parameters:

samples - The ObjectStream samples to process.

Throws:

IOException - Thrown if non of the documents had Penn tokenization.

Method Detail

read

public TokenSample read()
                 throws IOException

Description copied from interface: ObjectStream

Returns the next ObjectStream object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.

Returns:

The next object or null to signal that the stream is exhausted.

Throws:

IOException - Thrown if there is an error during reading.

close

public void close()
           throws IOException

Description copied from interface: ObjectStream

Closes the ObjectStream and releases all allocated resources. After close was called, it's not allowed to call ObjectStream.read() or ObjectStream.reset().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ObjectStream<TokenSample>

Overrides:

close in class FilterObjectStream<MascDocument,TokenSample>

Throws:

IOException - Thrown if there is an error during closing the stream.

reset

public void reset()
           throws IOException,
                  UnsupportedOperationException

Description copied from interface: ObjectStream

Repositions 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:

reset in interface ObjectStream<TokenSample>

Overrides:

reset in class FilterObjectStream<MascDocument,TokenSample>

Throws:

IOException - Thrown if there is an error during resetting the stream.

UnsupportedOperationException - Thrown if the reset() is not supported. By default, this is the case.