1   /*
2    *  RhsAction.java
3    *
4    *  Copyright (c) 1998-2001, The University of Sheffield.
5    *
6    *  This file is part of GATE (see http://gate.ac.uk/), and is free
7    *  software, licenced under the GNU Library General Public License,
8    *  Version 2, June 1991 (in the distribution as file licence.html,
9    *  and also available at http://gate.ac.uk/gate/licence.html).
10   *
11   *  Hamish, 30/7/98
12   *
13   *  $Id: RhsAction.java,v 1.8 2002/05/14 09:43:17 valyt Exp $
14   */
15  
16  package gate.jape;
17  import gate.*;
18  import gate.creole.ontology.Ontology;
19  
20  import java.util.Map;
21  import java.io.*;
22  
23  /** An interface that defines what the action classes created
24    * for RightHandSides look like.
25    */
26  public interface RhsAction extends Serializable {
27  
28    /**
29     * Fires the RHS action for a particular LHS match.
30     * @param doc the document the RHS action will be run on
31     * @param bindings A map containing the matc results from the LHS in the form
32     * label(String) -> matched annotations (AnnotationSet)
33     * @param annotations copy of the outputAS value provided for backward
34     * compatibility
35     * @param inputAS the input annotation set
36     * @param outputAS the output annotation set
37     * @throws JapeException
38     */
39    public void doit(Document doc, Map bindings, AnnotationSet annotations,
40                     AnnotationSet inputAS, AnnotationSet outputAS,
41                     Ontology ontology)
42                throws JapeException;
43  
44  } // RhsAction
45