opennlp.model

Class FileEventStream

java.lang.Object

opennlp.model.AbstractEventStream

opennlp.model.FileEventStream

All Implemented Interfaces:

Closeable, AutoCloseable, EventStream

Direct Known Subclasses:

RealValueFileEventStream

public class FileEventStream
extends AbstractEventStream
implements Closeable

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(File file) Creates a new file event stream from the specified file.
FileEventStream(String fileName)
FileEventStream(String fileName, String encoding) Creates a new file event stream from the specified file name.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	hasNext() Test whether there are any Events remaining in this EventStream.
static void	main(String[] args) Trains and writes a model based on the events in the specified event file.
Event	next() Returns the next Event object held in this EventStream.
static String	toLine(Event event) Generates a string representing the specified event.

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

FileEventStream

public FileEventStream(String fileName,
                       String encoding)
                throws IOException

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

Parameters:

fileName - the name fo the file containing the events.

Throws:

IOException - When the specified file can not be read.

FileEventStream

public FileEventStream(String fileName)
                throws IOException

Throws:

IOException

FileEventStream

public FileEventStream(File file)
                throws IOException

Creates a new file event stream from the specified file.

Parameters:

file - the file containing the events.

Throws:

IOException - When the specified file can not be read.

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: EventStream

Test whether there are any Events remaining in this EventStream.

Specified by:

hasNext in interface EventStream

Returns:

true if this EventStream has more Events

next

public Event next()

Description copied from interface: EventStream

Returns the next Event object held in this EventStream.

Specified by:

next in interface EventStream

Returns:

the Event object which is next in this EventStream

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toLine

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

main

public static void main(String[] args)
                 throws IOException

Trains and writes a model based on the events in the specified event file. the name of the model created is based on the event file name.

Parameters:

args - eventfile [iterations cuttoff]

Throws:

IOException - when the eventfile can not be read or the model file can not be written.