gate.event
Class DocumentEvent

java.lang.Object
  extended byjava.util.EventObject
      extended bygate.event.GateEvent
          extended bygate.event.DocumentEvent
All Implemented Interfaces:
Serializable

public class DocumentEvent
extends GateEvent

This class models events fired by an Document.

See Also:
Serialized Form

Field Summary
static int ANNOTATION_SET_ADDED
          Event type used to mark the addition of an AnnotationSet
static int ANNOTATION_SET_REMOVED
          Event type used to mark the removal of an AnnotationSet
 
Fields inherited from class gate.event.GateEvent
FEATURES_UPDATED
 
Constructor Summary
DocumentEvent(Document source, int type, String setName)
          Constructor.
 
Method Summary
 String getAnnotationSetName()
          Gets the name of the AnnotationSet that has been added or removed.
 
Methods inherited from class gate.event.GateEvent
getType
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ANNOTATION_SET_ADDED

public static final int ANNOTATION_SET_ADDED
Event type used to mark the addition of an AnnotationSet

See Also:
Constant Field Values

ANNOTATION_SET_REMOVED

public static final int ANNOTATION_SET_REMOVED
Event type used to mark the removal of an AnnotationSet

See Also:
Constant Field Values
Constructor Detail

DocumentEvent

public DocumentEvent(Document source,
                     int type,
                     String setName)
Constructor.

Parameters:
source - the document that has been changed
type - the type of the event
setName - the name of the AnnotationSet that has been added or removed.
Method Detail

getAnnotationSetName

public String getAnnotationSetName()
Gets the name of the AnnotationSet that has been added or removed.