opennlp.tools.util

Class AbstractEventStream<T>

java.lang.Object

opennlp.model.AbstractEventStream

opennlp.tools.util.AbstractEventStream<T>

All Implemented Interfaces:

EventStream

Direct Known Subclasses:

AbstractParserEventStream, DocumentCategorizerEventStream, NameFinderEventStream, POSSampleEventStream, SDEventStream, TokSpanEventStream

public abstract class AbstractEventStream<T>
extends AbstractEventStream

This is a base class for EventStream classes. It takes an Iterator of sample objects as input and outputs the events creates by a subclass.

Constructor Summary

Constructors

Constructor and Description
AbstractEventStream(ObjectStream<T> samples) Initializes the current instance with a sample Iterator.

Method Summary

Modifier and Type	Method and Description
protected abstract Iterator<Event>	createEvents(T sample) Creates events for the provided sample.
boolean	hasNext() Checks if there are more training events available.
Event	next() Returns the next Event object held in this EventStream.

Methods inherited from class opennlp.model.AbstractEventStream

remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractEventStream

public AbstractEventStream(ObjectStream<T> samples)

Initializes the current instance with a sample Iterator.

Parameters:

samples - the sample Iterator.

Method Detail

createEvents

protected abstract Iterator<Event> createEvents(T sample)

Creates events for the provided sample.

Parameters:

sample - the sample for which training Events are be created.

Returns:

an Iterator of training events or an empty Iterator.

hasNext

public final boolean hasNext()
                      throws IOException

Checks if there are more training events available.

Returns:

true if this EventStream has more Events

Throws:

IOException

next

public final Event next()

Description copied from interface: EventStream

Returns the next Event object held in this EventStream.

Returns:

the Event object which is next in this EventStream