com.tensegrity.graph.event
Class EdgeEvent

java.lang.Object
  com.tensegrity.graph.event.AbstractGraphEvent
      com.tensegrity.graph.event.EdgeEvent

All Implemented Interfaces:

GraphRootEvent

public class EdgeEvent

extends com.tensegrity.graph.event.AbstractGraphEvent

The edge event class.

Version:

$Id: EdgeEvent.java,v 1.10 2004/06/29 09:23:37 sr Exp $

Author:

Stepan Rutz

See Also:

Graph, Edge

Field Summary

static int	EDGE_ADDED Constants that define the type of the event.
static int	EDGE_REMOVED Constants that define the type of the event.

Constructor Summary

EdgeEvent(int id, Graph graph, Edge edge)
Constructs a new EdgeEvent.

EdgeEvent(int id, Subgraph subgraph, Edge edge)
Constructs a new EdgeEvent.

Method Summary

java.lang.String	getDescription() Returns a textual description for the event.
Edge	getEdge() Returns the Edge that caused the event.
Graph	getGraph() Returns the Graph that caused the event.
int	getID() Returns the event id of this event.
Subgraph	getSubgraph() Returns the Subgraph that caused the event.

Methods inherited from class java.lang.Object

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

Field Detail

EDGE_ADDED

public static final int EDGE_ADDED

Constants that define the type of the event.

See Also:

Constant Field Values

EDGE_REMOVED

public static final int EDGE_REMOVED

Constants that define the type of the event.

See Also:

Constant Field Values

Constructor Detail

EdgeEvent

public EdgeEvent(int id,
                 Graph graph,
                 Edge edge)

Constructs a new EdgeEvent.

Parameters:

id - the id of the event, must be one of the Constants defined in this class.

graph - the Graph that is associated with the event.

edge - the Edge that is associated with the event.

EdgeEvent

public EdgeEvent(int id,
                 Subgraph subgraph,
                 Edge edge)

Constructs a new EdgeEvent.

Parameters:

id - the id of the event, must be one of the Constants defined in this class.

subgraph - the Subgraph that is associated with the event.

edge - the Edge that is associated with the event.

Method Detail

getID

public int getID()

Returns the event id of this event.

Returns:

the event id of this event.

getEdge

public Edge getEdge()

Returns the Edge that caused the event.

Returns:

the Edge that caused the event.

getDescription

public java.lang.String getDescription()

Returns a textual description for the event.

Specified by:

getDescription in interface GraphRootEvent

Returns:

a textual description for the event.

getGraph

public Graph getGraph()

Returns the Graph that caused the event.

Specified by:

getGraph in interface GraphRootEvent

Returns:

the Graph that caused the event.

getSubgraph

public Subgraph getSubgraph()

Returns the Subgraph that caused the event.

Returns:

the Subgraph that caused the event.