edu.stanford.nlp.sequences

Interface DocumentReaderAndWriter<IN extends CoreMap>

All Superinterfaces:

IteratorFromReaderFactory<List<IN>>, Serializable

All Known Implementing Classes:

ArabicDocumentReaderAndWriter, ColumnDocumentReaderAndWriter, CoNLLDocumentReaderAndWriter, PlainTextDocumentReaderAndWriter, Sighan2005DocumentReaderAndWriter, TrueCasingForNISTDocumentReaderAndWriter

public interface DocumentReaderAndWriter<IN extends CoreMap>
extends IteratorFromReaderFactory<List<IN>>, Serializable

This interface is used for reading data and writing output into and out of sequence classifiers. If you subclass this interface, all of the other mechanisms necessary for getting your data into a sequence classifier will be taken care of for you. Subclasses MUST have an empty constructor as they can be instantiated by reflection, and there is a promise that the init method will be called immediately after construction.

Author:

Jenny Finkel

Method Summary

Modifier and Type	Method and Description
void	init(SeqClassifierFlags flags) This will be called immediately after construction.
void	printAnswers(List<IN> doc, PrintWriter out) This method prints the output of the classifier to a PrintWriter.

Methods inherited from interface edu.stanford.nlp.objectbank.IteratorFromReaderFactory

getIterator

Method Detail

init

void init(SeqClassifierFlags flags)

This will be called immediately after construction. It's easier having an init() method because DocumentReaderAndWriter objects are usually created using reflection.

Parameters:

flags - Flags specifying behavior

printAnswers

void printAnswers(List<IN> doc,
                  PrintWriter out)

This method prints the output of the classifier to a PrintWriter.

Parameters:

doc - The document which has answers (it has been classified)

out - Where to send the output