gate.LanguageAnalyser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  Copyright (c) 1995-2012, The University of Sheffield. See the file
 *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 *
 *  This file is part of GATE (see http://gate.ac.uk/), and is free
 *  software, licenced under the GNU Library General Public License,
 *  Version 2, June 1991 (in the distribution as file licence.html,
 *  and also available at http://gate.ac.uk/gate/licence.html).
 *
 *  Valentin Tablan 05/10/2001
 *
 *  $Id: LanguageAnalyser.java 16175 2012-10-29 14:01:55Z markagreenwood $
 *
 */


package gate;

import gate.creole.metadata.CreoleParameter;
import gate.creole.metadata.CreoleResource;
import gate.creole.metadata.Optional;
import gate.creole.metadata.RunTime;

/**
 * A special type of {@link ProcessingResource} that processes {@link Document}s
 */
@CreoleResource(name = "Language analyser",
        comment = "A processing resource that takes document and corpus parameters")
public interface LanguageAnalyser extends ProcessingResource {

  /** Set the document property for this analyser. */
  @RunTime
  @CreoleParameter(comment = "The document to process")
  public void setDocument(Document document);

  /** Get the document property for this analyser. */
  public Document getDocument();

  /** Set the corpus property for this analyser. */
  @Optional
  @RunTime
  @CreoleParameter(comment = "The corpus containing the document to process")
  public void setCorpus(Corpus corpus);

  /** Get the corpus property for this analyser. */
  public Corpus getCorpus();
}