opennlp.tools.ml.model

Class FileEventStream

java.lang.Object

opennlp.tools.ml.model.FileEventStream

All Implemented Interfaces:

java.lang.AutoCloseable, ObjectStream<Event>

Direct Known Subclasses:

RealValueFileEventStream

public class FileEventStream
extends java.lang.Object
implements ObjectStream<Event>

Class for using a file of events as an event stream. The format of the file is one event perline with each line consisting of outcome followed by contexts (space delimited).

Constructor Summary

Constructors

Constructor and Description
FileEventStream(java.io.File file) Creates a new file event stream from the specified file.
FileEventStream(java.lang.String fileName)
FileEventStream(java.lang.String fileName, java.lang.String encoding) Creates a new file event stream from the specified file name.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the ObjectStream and releases all allocated resources.
Event	read() Returns the next object.
void	reset() Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
static java.lang.String	toLine(Event event) Generates a string representing the specified event.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileEventStream

public FileEventStream(java.lang.String fileName,
                       java.lang.String encoding)
                throws java.io.IOException

Creates a new file event stream from the specified file name.

Parameters:

fileName - the name fo the file containing the events.

Throws:

java.io.IOException - When the specified file can not be read.

FileEventStream

public FileEventStream(java.lang.String fileName)
                throws java.io.IOException

Throws:

java.io.IOException

FileEventStream

public FileEventStream(java.io.File file)
                throws java.io.IOException

Creates a new file event stream from the specified file.

Parameters:

file - the file containing the events.

Throws:

java.io.IOException - When the specified file can not be read.

Method Detail

read

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

Specified by:

read in interface ObjectStream<Event>

Returns:

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

Throws:

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

close

public void close()
           throws java.io.IOException

Description copied from interface: ObjectStream

Closes the ObjectStream and releases all allocated resources. After close was called its not allowed to call read or reset.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ObjectStream<Event>

Throws:

java.io.IOException - if there is an error during closing the stream

toLine

public static java.lang.String toLine(Event event)

Generates a string representing the specified event.

Parameters:

event - The event for which a string representation is needed.

Returns:

A string representing the specified event.

reset

public void reset()
           throws java.io.IOException,
                  java.lang.UnsupportedOperationException

Description copied from interface: ObjectStream

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.

Specified by:

reset in interface ObjectStream<Event>

Throws:

java.io.IOException - if there is an error during reseting the stream

java.lang.UnsupportedOperationException