ChunkSampleStream (Apache OpenNLP Tools 2.5.9 API)
Description: declaration: package: opennlp.tools.chunker, class: ChunkSampleStream

# Class ChunkSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<String, ChunkSample>
opennlp.tools.chunker.ChunkSampleStream

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

public class ChunkSampleStream extends FilterObjectStream<String, ChunkSample>
Parses the conll 2000 shared task shallow parser training data.

Data format is specified on the conll page:
https://www.cnts.ua.ac.be/conll2000/chunking/

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ChunkSampleStream(ObjectStream<String> samples)`
  Initializes a `instance`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `ChunkSample`
  `read()`
  Returns the next `T` object.

  ### Methods inherited from class FilterObjectStream

  `close, reset`

  ### Methods inherited from class Object

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

- ## Constructor Details

  - ### ChunkSampleStream

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

- ## Method Details

  - ### read

    public ChunkSample read() throws IOException
    Description copied from interface: `ObjectStream`
    Returns the next `T` 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.