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

# Class NameSampleDataStream

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

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

public class NameSampleDataStream extends FilterObjectStream<String, 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.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `END_TAG`
  `static final String`
  `START_TAG`
  `static final String`
  `START_TAG_PREFIX`

- ## Constructor Summary

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

- ## Method Summary

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

- ## Field Details

  - ### START_TAG_PREFIX

    public static final String START_TAG_PREFIX
    See Also:
      - Constant Field Values

  - ### START_TAG

    public static final String START_TAG
    See Also:
      - Constant Field Values

  - ### END_TAG

    public static final String END_TAG
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### NameSampleDataStream

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

- ## Method Details

  - ### read

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