opennlp.tools.namefind

Class NameSampleDataStream

java.lang.Object

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

opennlp.tools.namefind.NameSampleDataStream

All Implemented Interfaces:

java.lang.AutoCloseable, ObjectStream<NameSample>

public class NameSampleDataStream
extends FilterObjectStream<java.lang.String,NameSample>

The NameSampleDataStream class converts tagged Strings provided by a DataStream to NameSample objects. It uses text that is is one-sentence per line and tokenized with names identified by <START> and <END> tags.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	END_TAG
static java.lang.String	START_TAG
static java.lang.String	START_TAG_PREFIX

Constructor Summary

Constructors

Constructor and Description
NameSampleDataStream(ObjectStream<java.lang.String> in)

Method Summary

Modifier and Type	Method and Description
NameSample	read() Returns the next 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

Field Detail

START_TAG_PREFIX

public static final java.lang.String START_TAG_PREFIX

See Also:

Constant Field Values

START_TAG

public static final java.lang.String START_TAG

See Also:

Constant Field Values

END_TAG

public static final java.lang.String END_TAG

See Also:

Constant Field Values

Constructor Detail

NameSampleDataStream

public NameSampleDataStream(ObjectStream<java.lang.String> in)

Method Detail

read

public NameSample read()
                throws java.io.IOException

Description copied from interface: ObjectStream

Returns the next 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:

java.io.IOException - if there is an error during reading