DocumentSampleStream (Apache OpenNLP :: Core :: Runtime 3.0.0-M4 API)
Description: declaration: package: opennlp.tools.doccat, class: DocumentSampleStream

Package opennlp.tools.doccat

# Class DocumentSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<String,opennlp.tools.doccat.DocumentSample>
opennlp.tools.doccat.DocumentSampleStream

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

public class DocumentSampleStream extends FilterObjectStream<String,opennlp.tools.doccat.DocumentSample>
Reads in string encoded training samples, parses them and outputs `DocumentSample` objects.

Format:
Each line contains one sample document.
The category is the first string in the line followed by a tab and whitespace separated document tokens.

Sample line: `category-string tab-char whitespace-separated-tokens line-break-char(s)`

See Also:
  - `DocumentSample`

- ## Constructor Summary

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

- ## Method Summary

  Modifier and Type
  Method
  Description
  `opennlp.tools.doccat.DocumentSample`
  `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

  - ### DocumentSampleStream

    public DocumentSampleStream(opennlp.tools.util.ObjectStream<String> samples)
    Initializes a `instance`.
    Parameters:
      `samples` - A plain text `line stream`.

- ## Method Details

  - ### read

    public opennlp.tools.doccat.DocumentSample read() throws IOException
    Throws:
      `IOException`