opennlp.tools.util
Class FilterObjectStream<S,T>

java.lang.Object
  opennlp.tools.util.FilterObjectStream<S,T>

Type Parameters:

S - the type of the source/input stream

T - the type of this stream

All Implemented Interfaces:

ObjectStream<T>

Direct Known Subclasses:

AbstractToSentenceSampleStream, ChunkSampleStream, ChunkSampleStream, ConllXPOSSampleStream, DocumentSampleStream, NameSampleDataStream, NameToTokenSampleStream, ParagraphStream, ParseSampleStream, PosSampleStream, POSToTokenSampleStream, SentenceSampleStream, TokenSampleStream, WhitespaceTokenStream, WordTagSampleStream

public abstract class FilterObjectStream<S,T>
extends Object
implements ObjectStream<T>

Abstract base class for filtering ObjectStreams.

Filtering streams take an existing stream and convert its output to something else.

Field Summary

protected ObjectStream<S>

samples

Constructor Summary

protected

FilterObjectStream(ObjectStream<S> samples)

Method Summary

void	close() Closes the ObjectStream and releases all allocated resources.
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

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

Methods inherited from interface opennlp.tools.util.ObjectStream

read

Field Detail

samples

protected final ObjectStream<S> samples

Constructor Detail

FilterObjectStream

protected FilterObjectStream(ObjectStream<S> samples)

Method Detail

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<T>

Throws:

IOException

UnsupportedOperationException

close

public void close()
           throws IOException

Description copied from interface: ObjectStream

Closes the ObjectStream and releases all allocated resources. After close was called its not allowed to call read or reset.

Specified by:

close in interface ObjectStream<T>

Throws:

IOException