Package opennlp.tools.ml.model
Class FileEventStream
java.lang.Object
opennlp.tools.ml.model.FileEventStream
- All Implemented Interfaces:
AutoCloseable,ObjectStream<Event>
- Direct Known Subclasses:
RealValueFileEventStream
Class for using a file of
events as an event stream.
The format of the file is one event per line with
each line consisting of outcome followed by contexts (space delimited).- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionFileEventStream(File file) Instantiates aFileEventStreamvia aFile.FileEventStream(Reader reader) Instantiates aFileEventStreamvia aReader.FileEventStream(String fileName) Instantiates aFileEventStreamfrom the specified file name.FileEventStream(String fileName, String encoding) Instantiates aFileEventStreamfrom the specified file name. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes theObjectStreamand releases all allocated resources.read()Returns the nextObjectStreamobject.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.static StringGenerates a string representing the specified event.
-
Constructor Details
-
FileEventStream
Instantiates aFileEventStreamfrom the specified file name.- Parameters:
fileName- The name fo the file containing the events.encoding- The name of thecharacter encoding.- Throws:
IOException- Thrown if the specified file can not be read.
-
FileEventStream
Instantiates aFileEventStreamfrom the specified file name.- Parameters:
fileName- The name fo the file containing the events.- Throws:
IOException- Thrown if the specified file can not be read.
-
FileEventStream
Instantiates aFileEventStreamvia aReader.- Parameters:
reader- TheReaderthat holds events.- Throws:
IOException- Thrown if the specified file can not be read.
-
FileEventStream
Instantiates aFileEventStreamvia aFile.- Parameters:
file- TheFilethat holds events.- Throws:
IOException- Thrown if the specified file can not be read.
-
-
Method Details
-
read
Description copied from interface:ObjectStreamReturns the nextObjectStreamobject. Calling this method repeatedly until it returnsnullwill return each object from the underlying source exactly once.- Specified by:
readin interfaceObjectStream<Event>- Returns:
- The next object or
nullto signal that the stream is exhausted. - Throws:
IOException- Thrown if there is an error during reading.
-
close
Description copied from interface:ObjectStreamCloses theObjectStreamand releases all allocated resources. After close was called, it's not allowed to callObjectStream.read()orObjectStream.reset().- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceObjectStream<Event>- Throws:
IOException- Thrown if there is an error during closing the stream.
-
toLine
Generates a string representing the specified event.- Parameters:
event- TheEventfor which a string representation is needed.- Returns:
- A string representing the specified event.
-
reset
Description copied from interface:ObjectStreamRepositions 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:
resetin interfaceObjectStream<Event>- Throws:
IOException- Thrown if there is an error during resetting the stream.UnsupportedOperationException- Thrown if thereset()is not supported. By default, this is the case.
-