edu.stanford.nlp.process.DocumentProcessor Maven / Gradle / Ivy

package edu.stanford.nlp.process;
import edu.stanford.nlp.ling.Document;

/**
 * Top-level interface for transforming Documents.
 *
 * @author Sepandar Kamvar ([email protected])
 * @see #processDocument
 * @author Sarah Spikes ([email protected]) (Templatization)
 *
 * @param  The type of the labels 
 */
public interface DocumentProcessor {

  /**
   * Converts a Document to a different Document, by transforming
   * or filtering the original Document. The general contract of this method
   * is to not modify the in Document in any way, and to
   * preserve the metadata of the in Document in the
   * returned Document.
   *
   * @see FunctionProcessor
   */
  public Document processDocument(Document in);

}