ConlluSentenceSampleStream (Apache OpenNLP Tools 2.5.9 API)
Description: declaration: package: opennlp.tools.formats.conllu, class: ConlluSentenceSampleStream

# Class ConlluSentenceSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<ConlluSentence, SentenceSample>
opennlp.tools.formats.conllu.ConlluSentenceSampleStream

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

public class ConlluSentenceSampleStream extends FilterObjectStream<ConlluSentence, SentenceSample>

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ConlluSentenceSampleStream(ObjectStream<ConlluSentence> samples, int sentencesPerSample)`
  Initializes a `ConlluSentenceSampleStream`.

- ## Method Summary

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

  - ### ConlluSentenceSampleStream

    public ConlluSentenceSampleStream(ObjectStream<ConlluSentence> samples, int sentencesPerSample)
    Initializes a `ConlluSentenceSampleStream`.
    Parameters:
      `samples` - The `samples` used as input.
      `sentencesPerSample` - The number of sentences per sample. Must not be negative.

- ## Method Details

  - ### read

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