graphana.graphs

Interface GraphListener<VertexType,EdgeType>

Type Parameters:

VertexType - Must be the same as the VertexType of the graph

EdgeType - Must be the same as the EdgeType of the graph

public interface GraphListener<VertexType,EdgeType>

Instances of classes which implement this interface can be added to a GraphLibrary instance using GraphLibrary .addGraphListener to get notified when the respective graph is modified.

Method Summary

Modifier and Type	Method and Description
void	beginUpdate() Called before multiple operations will be done consecutively.
boolean	callEdgeRemovedWhenRemovingVertex() When a vertex is deleted, every incident edge is deleted, too.
void	edgeAdded(EdgeType edge, java.lang.Object message) Called whenever an edge was added to the graph.
void	edgeRemoved(EdgeType edge) Called whenever an edge was removed from the graph.
void	edgeWeightSet(EdgeType edge) Called whenever an edge weight was changed.
void	endUpdate() Called after multiple operations have been done consecutively.
GraphLibrary<VertexType,EdgeType>	getGraph() Returns the graph in which this listener was added.
java.lang.Object	getSyncObject() Returns the object to synchronize with when invoking the listener and the graph elements in parallel.
void	graphCreated() Called whenever the graph was created (e.g.
void	graphRecreated() Called whenever the graph was created with the same settings.
void	vertexAdded(VertexType vertex, java.lang.Object message) Called whenever a vertex was added to the graph.
void	vertexRemoved(VertexType vertex) Called whenever a vertex was removed from the graph.

Method Detail

graphCreated

void graphCreated()

Called whenever the graph was created (e.g. with createGraph, loadGraph etc.).

graphRecreated

void graphRecreated()

Called whenever the graph was created with the same settings. In general, the graph is not empty when calling this method.

vertexAdded

void vertexAdded(VertexType vertex,
                 java.lang.Object message)

Called whenever a vertex was added to the graph.

Parameters:

vertex - the vertex which was just added.

message - an optional message to the listener. Might be null.

edgeAdded

void edgeAdded(EdgeType edge,
               java.lang.Object message)

Called whenever an edge was added to the graph.

Parameters:

edge - the edge which was just added.

message - an optional message to the listener. Might be null.

vertexRemoved

void vertexRemoved(VertexType vertex)

Called whenever a vertex was removed from the graph.

Parameters:

vertex - the vertex which was just removed.

edgeRemoved

void edgeRemoved(EdgeType edge)

Called whenever an edge was removed from the graph.

Parameters:

edge - the edge which was just removed.

edgeWeightSet

void edgeWeightSet(EdgeType edge)

Called whenever an edge weight was changed.

Parameters:

edge - the edge of which the edge weight was just set.

beginUpdate

void beginUpdate()

Called before multiple operations will be done consecutively.

endUpdate

void endUpdate()

Called after multiple operations have been done consecutively.

getGraph

GraphLibrary<VertexType,EdgeType> getGraph()

Returns the graph in which this listener was added.

Returns:

the graph in which this listener was added.

getSyncObject

java.lang.Object getSyncObject()

Returns the object to synchronize with when invoking the listener and the graph elements in parallel.

Returns:

the object to synchronize with.

callEdgeRemovedWhenRemovingVertex

boolean callEdgeRemovedWhenRemovingVertex()

When a vertex is deleted, every incident edge is deleted, too. If this method returns true, then edgeRemoved will be called for every edge in addition to vertexRemoved.