GraphLab Project

graphlab.library.event
Class EdgeEvent<VertexType extends BaseVertex,EdgeType extends BaseEdge<VertexType>>

java.lang.Object
  extended by graphlab.library.event.EdgeEvent<VertexType,EdgeType>
All Implemented Interfaces:
Event
Direct Known Subclasses:
BaseEdgeEvent

public class EdgeEvent<VertexType extends BaseVertex,EdgeType extends BaseEdge<VertexType>>
extends java.lang.Object
implements Event

Happens when an edge's color or weight changes or a new edge is added to the graph.

Author:
Omid Aladini

Nested Class Summary
static class EdgeEvent.EventType
           
 
Field Summary
 EdgeType edge
           
 EdgeEvent.EventType eventType
           
 BaseGraph<VertexType,EdgeType> graph
           
 
Constructor Summary
EdgeEvent(BaseGraph<VertexType,EdgeType> graph, EdgeType edge)
          Constructs an event that means a new edge is added to the graph.
EdgeEvent(BaseGraph<VertexType,EdgeType> graph, EdgeType edge, EdgeEvent.EventType et)
          Constructs an event that means an event is occured on a specified edge.
 
Method Summary
 java.lang.String getDescription()
           
 java.lang.String getID()
           
 java.lang.String getMessage()
           
 void setMessage(java.lang.String message)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

edge

public final EdgeType extends BaseEdge<VertexType> edge

graph

public final BaseGraph<VertexType extends BaseVertex,EdgeType extends BaseEdge<VertexType>> graph

eventType

public final EdgeEvent.EventType eventType
Constructor Detail

EdgeEvent

public EdgeEvent(BaseGraph<VertexType,EdgeType> graph,
                 EdgeType edge,
                 EdgeEvent.EventType et)
Constructs an event that means an event is occured on a specified edge.

Parameters:
edge - The edge which the event occurs on it.
et - Type of the event occured on the first parameter edge;
Throws:
java.lang.NullPointerException - if edge is null.

EdgeEvent

public EdgeEvent(BaseGraph<VertexType,EdgeType> graph,
                 EdgeType edge)
Constructs an event that means a new edge is added to the graph.

Parameters:
edge - The edge which the event occurs on it.
Throws:
java.lang.NullPointerException - if edge is null.
Method Detail

getID

public java.lang.String getID()
Specified by:
getID in interface Event

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface Event

getMessage

public java.lang.String getMessage()
Specified by:
getMessage in interface Event
Returns:
a message if the algorithm want to send any of them. this message will be loged and shown to the user

setMessage

public void setMessage(java.lang.String message)

GraphLab Project