Class LeipzigLanguageSampleStream

Namespace

NOpenNLP.Tools.Formats.Leipzig

Assembly

NOpenNLP.Tools.dll

public class LeipzigLanguageSampleStream : ObjectStreamBase<LanguageSample?>, IObjectStream<LanguageSample?>, IDisposable

Inheritance

object

ObjectStreamBase<LanguageSample>

LeipzigLanguageSampleStream

Implements

IObjectStream<LanguageSample>

IDisposable

Inherited Members

ObjectStreamBase<LanguageSample>.Dispose(bool)

ObjectStreamBase<LanguageSample>.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LeipzigLanguageSampleStream(DirectoryInfo, int, int)

public LeipzigLanguageSampleStream(DirectoryInfo leipzigFolder, int sentencesPerSample, int samplesPerLanguage)

Parameters

leipzigFolder DirectoryInfo

sentencesPerSample int

samplesPerLanguage int

Exceptions

IOException

if there is an error during reading

Methods

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 LanguageSample? Read()

Returns

LanguageSample

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

IOException

if there is an error during resetting the stream