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

Package opennlp.tools.namefind

# Class NameSampleDataStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<String,opennlp.tools.namefind.NameSample>
opennlp.tools.namefind.NameSampleDataStream

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

public class NameSampleDataStream extends FilterObjectStream<String,opennlp.tools.namefind.NameSample>
The `NameSampleDataStream` class converts tagged tokens provided by a DataStream to `NameSample` objects.

It uses text that is one-sentence per line and tokenized with names identified by:
<`START`> and <`END`>tags.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `NameSampleDataStream(opennlp.tools.util.ObjectStream<String> in)`
  Initializes a `NameSampleDataStream` with given `psi` samples.

- ## Method Summary

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

  - ### NameSampleDataStream

    public NameSampleDataStream(opennlp.tools.util.ObjectStream<String> in)
    Initializes a `NameSampleDataStream` with given `psi` samples.
    Parameters:
      `in` - The `stream` of data samples.

- ## Method Details

  - ### read

    public opennlp.tools.namefind.NameSample read() throws IOException
    Throws:
      `IOException`