AnnotationSetEvent.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 12/12/2000
11  *
12  *  $Id: AnnotationSetEvent.java 17595 2014-03-08 13:05:32Z markagreenwood $
13  */
14 
15 package gate.event;
16 
17 import gate.*;
18 
19 /**
20  * This class models events fired by an {@link gate.AnnotationSet}.
21  */
22 public class AnnotationSetEvent extends GateEvent{
23 
24   private static final long serialVersionUID = 6618095991726447858L;
25 
26   /**Event type used for situations when a new annotation has been added*/
27   public static final int ANNOTATION_ADDED = 201;
28 
29   /**Event type used for situations when an annotation has been removed*/
30   public static final int ANNOTATION_REMOVED = 202;
31 
32 
33   /**
34    * Constructor.
35    @param source the {@link gate.AnnotationSet} that fired the event
36    @param type the type of the event
37    @param sourceDocument the {@link gate.Document} for wich the annotation
38    * was added or removed.
39    @param annotation the annotation added or removed.
40    */
41   public AnnotationSetEvent(AnnotationSet source,
42                             int type,
43                             Document sourceDocument,
44                             Annotation annotation) {
45     super(source, type);
46     this.sourceDocument = sourceDocument;
47     this.annotation = annotation;
48   }
49 
50   /**
51    * Gets the document that has had an annotation added or removed.
52    @return {@link gate.Document}
53    */
54   public gate.Document getSourceDocument() {
55     return sourceDocument;
56   }
57 
58   /**
59    * Gets the annotation that has been added or removed
60    @return {@link gate.Annotation}
61    */
62   public gate.Annotation getAnnotation() {
63     return annotation;
64   }
65 
66   private gate.Document sourceDocument;
67   private gate.Annotation annotation;
68 }