Package opennlp.tools.util

Class ParagraphStream

java.lang.Object

opennlp.tools.util.FilterObjectStream<String,String>

opennlp.tools.util.ParagraphStream

All Implemented Interfaces:

AutoCloseable, ObjectStream<String>

public class ParagraphStream
extends FilterObjectStream<String,String>

A FilterObjectStream which merges text lines into paragraphs.

The boundary of paragraph is defined by an empty text line. If the last paragraph in the stream is not terminated by an empty line the left over is assumed to be a paragraph.

Constructor Summary

Constructors

Constructor	Description
ParagraphStream(ObjectStream<String> lineStream)	Initializes an FilterObjectStream.

Method Summary

Modifier and Type	Method	Description
String	read()	Returns the next ObjectStream object.

Methods inherited from class opennlp.tools.util.FilterObjectStream

close, reset

Methods inherited from class java.lang.Object

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

Constructor Details

ParagraphStream

public ParagraphStream(ObjectStream<String> lineStream)

Initializes an FilterObjectStream.

Parameters:

lineStream - The stream of samples.

Method Details

read

public String 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.