Package opennlp.tools.formats.brat

Klasse BratDocumentStream

java.lang.Object

opennlp.tools.formats.brat.BratDocumentStream

Alle implementierten Schnittstellen:

AutoCloseable, ObjectStream<BratDocument>

public class BratDocumentStream
extends Object
implements ObjectStream<BratDocument>

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
BratDocumentStream(AnnotationConfiguration config, File bratCorpusDirectory, boolean searchRecursive, FileFilter fileFilter)	Creates a BratDocumentStream which reads the documents from the given input directory.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	close()	Closes the ObjectStream and releases all allocated resources.
BratDocument	read()	Returns the next ObjectStream object.
void	reset()	Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

BratDocumentStream

public BratDocumentStream(AnnotationConfiguration config,
 File bratCorpusDirectory,
 boolean searchRecursive,
 FileFilter fileFilter)
                   throws IOException

Creates a BratDocumentStream which reads the documents from the given input directory.

Parameter:

config - the annotation.conf from the brat project as an Annotation Configuration object

bratCorpusDirectory - the directory containing all the brat training data files

searchRecursive - specifies if the corpus directory should be traversed recursively to find training data files.

fileFilter - a custom file filter to filter out certain files or null to accept all files

Löst aus:

IOException - if reading from the brat directory fails in anyway

Methodendetails

read

public BratDocument read()
                  throws IOException

Beschreibung aus Schnittstelle kopiert: ObjectStream

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

Angegeben von:

read in Schnittstelle ObjectStream<BratDocument>

Gibt zurück:

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

Löst aus:

IOException - Thrown if there is an error during reading.

reset

public void reset()

Beschreibung aus Schnittstelle kopiert: 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.

Angegeben von:

reset in Schnittstelle ObjectStream<BratDocument>

close

public void close()

Beschreibung aus Schnittstelle kopiert: ObjectStream

Closes the ObjectStream and releases all allocated resources. After close was called, it's not allowed to call ObjectStream.read() or ObjectStream.reset().

Angegeben von:

close in Schnittstelle AutoCloseable

Angegeben von:

close in Schnittstelle ObjectStream<BratDocument>