RhsAction.java
01 /*
02  *  RhsAction.java
03  *
04  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
05  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
06  *
07  *  This file is part of GATE (see http://gate.ac.uk/), and is free
08  *  software, licenced under the GNU Library General Public License,
09  *  Version 2, June 1991 (in the distribution as file licence.html,
10  *  and also available at http://gate.ac.uk/gate/licence.html).
11  *
12  *  Hamish, 30/7/98
13  *
14  *  $Id: RhsAction.java 17425 2014-02-26 11:58:22Z markagreenwood $
15  */
16 
17 package gate.jape;
18 import java.io.Serializable;
19 import java.util.Map;
20 
21 import gate.AnnotationSet;
22 import gate.Document;
23 import gate.creole.ontology.Ontology;
24 
25 /** An interface that defines what the action classes created
26   * for RightHandSides look like.
27   */
28 public interface RhsAction extends Serializable {
29 
30   /**
31    * Fires the RHS action for a particular LHS match.
32    @param doc the document the RHS action will be run on
33    @param bindings A map containing the matching results from the LHS in 
34    * the form label(String) -> matched annotations (AnnotationSet)
35    @param inputAS the input annotation set
36    @param outputAS the output annotation set
37    @param ontology
38    @throws JapeException
39    */
40   public void doit(Document doc, Map<String, AnnotationSet> bindings,
41                    AnnotationSet inputAS, AnnotationSet outputAS,
42                    Ontology ontology)
43               throws JapeException;
44 
45   public void setActionContext(ActionContext actionContext);
46   public ActionContext getActionContext();
47 
48 // RhsAction