DocumentToLineStream (Apache OpenNLP :: Core :: Formats 3.0.0-M4 API)
Description: declaration: package: opennlp.tools.formats.ontonotes, class: DocumentToLineStream

Package opennlp.tools.formats.ontonotes

# Class DocumentToLineStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<String,String>
opennlp.tools.formats.brat.SegmenterObjectStream<String,String>
opennlp.tools.formats.ontonotes.DocumentToLineStream

All Implemented Interfaces:
  `AutoCloseable`, `opennlp.tools.util.ObjectStream<String>`

public class DocumentToLineStream extends SegmenterObjectStream<String,String>
Reads a plain text file and return each line as a `String` object.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DocumentToLineStream(opennlp.tools.util.ObjectStream<String> samples)`
  Initializes a `DocumentToLineStream`.

- ## Method Summary

  ### Methods inherited from class opennlp.tools.formats.brat.SegmenterObjectStream

  `read`

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

  - ### DocumentToLineStream

    public DocumentToLineStream(opennlp.tools.util.ObjectStream<String> samples)
    Initializes a `DocumentToLineStream`.
    Parameters:
      `samples` - The `samples` as input. Must not be `null`.
    Throws:
      `IllegalArgumentException` - Thrown if parameters are invalid.