LanguageAnalyser.java
01 /*
02  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
03  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
04  *
05  *  This file is part of GATE (see http://gate.ac.uk/), and is free
06  *  software, licenced under the GNU Library General Public License,
07  *  Version 2, June 1991 (in the distribution as file licence.html,
08  *  and also available at http://gate.ac.uk/gate/licence.html).
09  *
10  *  Valentin Tablan 05/10/2001
11  *
12  *  $Id: LanguageAnalyser.java 16175 2012-10-29 14:01:55Z markagreenwood $
13  *
14  */
15 
16 
17 package gate;
18 
19 import gate.creole.metadata.CreoleParameter;
20 import gate.creole.metadata.CreoleResource;
21 import gate.creole.metadata.Optional;
22 import gate.creole.metadata.RunTime;
23 
24 /**
25  * A special type of {@link ProcessingResource} that processes {@link Document}s
26  */
27 @CreoleResource(name = "Language analyser",
28         comment = "A processing resource that takes document and corpus parameters")
29 public interface LanguageAnalyser extends ProcessingResource {
30 
31   /** Set the document property for this analyser. */
32   @RunTime
33   @CreoleParameter(comment = "The document to process")
34   public void setDocument(Document document);
35 
36   /** Get the document property for this analyser. */
37   public Document getDocument();
38 
39   /** Set the corpus property for this analyser. */
40   @Optional
41   @RunTime
42   @CreoleParameter(comment = "The corpus containing the document to process")
43   public void setCorpus(Corpus corpus);
44 
45   /** Get the corpus property for this analyser. */
46   public Corpus getCorpus();
47 }