Class AbstractEventStream<T>

Namespace

NOpenNLP.Tools.Util

Assembly

NOpenNLP.Tools.dll

Base class for IObjectStream<T>s which turn samples into training Events.

public abstract class AbstractEventStream<T> : ObjectStreamBase<Event?>, IObjectStream<Event?>, IDisposable where T : class

Type Parameters

T

the type of the samples the events are created from

Inheritance

object

ObjectStreamBase<Event>

AbstractEventStream<T>

Implements

IObjectStream<Event>

IDisposable

Derived

ChunkerEventStream

DocumentCategorizerEventStream

LanguageDetectorEventStream

LemmaSampleEventStream

NameFinderEventStream

AbstractParserEventStream

POSSampleEventStream

SDEventStream

TokSpanEventStream

Inherited Members

ObjectStreamBase<Event>.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AbstractEventStream(IObjectStream<T?>)

Initializes the current instance with a sample stream.

protected AbstractEventStream(IObjectStream<T?> samples)

Parameters

samples IObjectStream<T>

the sample stream.

Methods

CreateEvents(T)

Creates events for the provided sample.

protected abstract IEnumerable<Event> CreateEvents(T sample)

Parameters

sample T

the sample for which training Events are be created.

Returns

IEnumerable<Event>

a sequence of training events, or an empty sequence.

Remarks

NOpenNLP: upstream returns an Iterator<Event>. This returns IEnumerable<T> instead, which is the more usual .NET shape and spares implementers from handing back an enumerator the caller must dispose. Read() enumerates it manually, since it yields one event per call.

Dispose(bool)

Releases the resources from this object stream.

protected override void Dispose(bool disposing)

Parameters

disposing bool

Read()

Returns the next object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.

public override sealed Event? Read()

Returns

Event

the next object or null to signal that the stream is exhausted

Exceptions

IOException

if there is an error during reading

IOException

if there is an error during reading

Reset()

Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly. This method can be used to re-read the stream if multiple passes over the objects are required.

The implementation of this method is optional.

public override void Reset()

Exceptions

IOException

if there is an error during resetting the stream

NotSupportedException

if reset is not supported on this stream