Package opennlp.tools.doccat

# Class DocumentSampleStream

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

All Implemented Interfaces:
  `AutoCloseable`, `ObjectStream<DocumentSample>`

public class DocumentSampleStream extends FilterObjectStream<String,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(ObjectStream<String> samples)`
  Initializes a `instance`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `DocumentSample`
  `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

  - ### DocumentSampleStream

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

- ## Method Details

  - ### read

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