gate.event

Class RelationSetEvent

java.lang.Object

java.util.EventObject

gate.event.GateEvent

gate.event.RelationSetEvent

All Implemented Interfaces:

Serializable

public class RelationSetEvent
extends GateEvent

This class models events fired by an RelationSet.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	RELATION_ADDED Event type used for situations when a new annotation has been added
static int	RELATION_REMOVED Event type used for situations when an annotation has been removed

Fields inherited from class gate.event.GateEvent

FEATURES_UPDATED, type

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RelationSetEvent(RelationSet source, int type, Relation relation) Constructor.

Method Summary

Modifier and Type	Method and Description
Relation	getRelation() Gets the relation that has been added or removed
Document	getSourceDocument() Gets the document that has had an annotation 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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RELATION_ADDED

public static final int RELATION_ADDED

Event type used for situations when a new annotation has been added

See Also:

Constant Field Values

RELATION_REMOVED

public static final int RELATION_REMOVED

Event type used for situations when an annotation has been removed

See Also:

Constant Field Values

Constructor Detail

RelationSetEvent

public RelationSetEvent(RelationSet source,
                        int type,
                        Relation relation)

Constructor.

Parameters:

source - the RelationSet that fired the event

type - the type of the event

relation - the Relation that was added or removed.

Method Detail

getSourceDocument

public Document getSourceDocument()

Gets the document that has had an annotation added or removed.

Returns:

a Document

getRelation

public Relation getRelation()

Gets the relation that has been added or removed

Returns:

a Relation