GraphLab Project

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

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

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

Happens when a vertex's color changes or a new vertex is added to the graph or ...

Author:
Omid Aladini

Nested Class Summary
static class VertexEvent.EventType
           
 
Field Summary
 VertexEvent.EventType eventType
           
 BaseGraph<VertexType,EdgeType> graph
           
 VertexType vertex
           
 
Constructor Summary
VertexEvent(BaseGraph<VertexType,EdgeType> graph, VertexType vertex)
          Constructs an event that means a new vertex is added.
VertexEvent(BaseGraph<VertexType,EdgeType> graph, VertexType vertex, VertexEvent.EventType et)
          Constructs an event that means an event is occured on a specified vertex.
 
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

vertex

public final VertexType extends BaseVertex vertex

graph

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

eventType

public final VertexEvent.EventType eventType
Constructor Detail

VertexEvent

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

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

VertexEvent

public VertexEvent(BaseGraph<VertexType,EdgeType> graph,
                   VertexType vertex)
Constructs an event that means a new vertex is added.

Parameters:
vertex - The vertex which the event occurs on it.
Throws:
java.lang.NullPointerException - if vertex 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