CreoleEvent.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 08/03/2001
11  *
12  *  $Id: CreoleEvent.java 17595 2014-03-08 13:05:32Z markagreenwood $
13  */
14 
15 package gate.event;
16 
17 import gate.*;
18 
19 /**
20  * Events related to the gate.creole package. This kind of events will
21  * be fired when resources are loaded or unloaded in the Gate system.
22  */
23 public class CreoleEvent extends GateEvent {
24 
25   private static final long serialVersionUID = -6834347398037784548L;
26 
27   /**
28    * Constructor
29    @param res the {@link gate.Resource} that has been (un)loaded
30    @param type the type of the event
31    */
32   public CreoleEvent(Resource res, int type){
33     //the source will always be the Creole register
34     super(Gate.getCreoleRegister(), type);
35     this.resource = res;
36     datastore = null;
37   }
38 
39   /**
40    * Constructor
41    @param datastore the {@link gate.DataStore} that has been
42    * created/loaded/closed.
43    @param type the type of the event
44    */
45   public CreoleEvent(DataStore datastore, int type){
46     //the source will always be the Creole register
47     super(Gate.getCreoleRegister(), type);
48     this.resource = null;
49     this.datastore = datastore;
50   }
51 
52   /**
53    * Gets the resource that has been (un)loaded.
54    */
55   public gate.Resource getResource() {
56     return resource;
57   }
58 
59   /**
60    * Gets the {@link gate.DataStore} that has been created/loaded/closed.
61    */
62   public DataStore getDatastore(){
63     return datastore;
64   }
65 
66   /**Event type that marks the loading of a new resource into the Gate system*/
67   public static final int RESOURCE_LOADED = 1;
68 
69   /**Event type that marks the unloading of a resource from the Gate system*/
70   public static final int RESOURCE_UNLOADED = 2;
71 
72   /**Event type that marks the creation of a new datastore*/
73   public static final int DATASTORE_CREATED = 3;
74 
75   /**Event type that mark the opening of a datastore*/
76   public static final int DATASTORE_OPENED = 4;
77 
78   /**Event type that mark the closing of a datastore*/
79   public static final int DATASTORE_CLOSED = 5;
80 
81   private gate.Resource resource;
82   private DataStore datastore;
83 
84 }