GraphEventMediator (Tensegrity API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.tensegrity.graph.event
Class GraphEventMediator

java.lang.Object
  com.tensegrity.graph.event.GraphEventMediator

All Implemented Interfaces:: EdgeListener, EventListenerTag, GraphListener, NodeListener

public class GraphEventMediator
extends java.lang.Object
implements GraphListener, NodeListener, EdgeListener

The GraphEventMediator facilitates to gain access to all Graph events, Node events and Edge events.

To be informed about all occuring events an object has to implement the GraphEventMediatorListener interface and then registered at a Graph instance as event mediator listener.

The GraphEventMediator is allways an instance variable of a Graph and hasn't to be implemented nor registered to any instance of a GraphObject. This is a mandatory commandment!
An implementation of a Graph allways comes with its own GraphEventMediator implementation, which is a major part of the architecture.

Version:: $Id: GraphEventMediator.java,v 1.10 2005/04/04 07:15:26 MichaelKegel Exp $
Author:: MichaelKegel
See Also:: Graph, GraphEventMediatorListener

Constructor Summary
`GraphEventMediator()` Constructor for GraphEventMediator.

Method Summary
`void`	`addMediatorListener(GraphEventMediatorListener listener)` Adds the `GraphEventMediatorListener` given by `listener` to the `GraphEventMediator` instance such that the listener will be notified about every event that occurs.
`void`	`edgeAdded(GraphEvent graphevent)` Invoked after an edge was added to the graph.
`void`	`edgeAddedToGraph(EdgeEvent edgeevent)` This method is invoked on the listener if an `Edge` was added to the graph.
`void`	`edgeAttachRejected(GraphEvent graphevent)` An attachment of an edge was rejected by the graph.
`void`	`edgePreAdd(GraphEvent graphevent)` Invoked when an edge is about to be added to a graph.
`void`	`edgePreRemove(GraphEvent graphevent)` Invoked when an edge is about to be removed from a graph.
`void`	`edgePreSplit(GraphEvent graphevent)` An edge is about to be split split and then would be replaced by two new edges.
`void`	`edgeRemoved(GraphEvent graphevent)` Invoked after an edge was removed from the graph.
`void`	`edgeRemovedFromGraph(EdgeEvent edgeevent)` This method is invoked on the listener if an `Edge` was removed from the graph.
`void`	`edgeSplit(GraphEvent graphevent)` An edge was split and replaced by two new edges.
`java.util.List`	`getListeners()` Returns a `List` of the `GraphEventMediatorListener`s currently registered.
`void`	`nodeAdded(GraphEvent graphevent)` Invoked after a node was added to the graph.
`void`	`nodeAddedToGraph(NodeEvent nodeevent)` This method is invoked on the listener if a `Node` was added to the graph.
`void`	`nodeDeleteEdgeCascade(GraphEvent graphevent)` A node with indegree = outdegree = 1 was deleted and the adjacent edges are deleted as well.
`void`	`nodePreAdd(GraphEvent graphevent)` Invoked when a node is about to be added to a graph.
`void`	`nodePreDeleteEdgeCascade(GraphEvent graphevent)` A node with indegree = outdegree = 1 is about to be deleted and the adjacent edges will be deleted as well.
`void`	`nodePreRemove(GraphEvent graphevent)` Invoked when a node is about to be removed from a graph.
`void`	`nodeRemoved(GraphEvent graphevent)` Invoked after a node was removed from the graph.
`void`	`nodeRemovedFromGraph(NodeEvent nodeevent)` This method is invoked on the listener if a `Node` was removed from the graph #
`void`	`portAddedToNode(NodeEvent nodeevent)` This method is invoked on the listener if a `Port` is added to a `Node`.
`void`	`portRemovedFromNode(NodeEvent nodeevent)` This method is invoked on the listener if a `Port` is removed from a `Node`.
`void`	`removeMediatorListener(GraphEventMediatorListener listener)` Removes the `GraphEventMediatorListener` given by `listener` from the `GraphEventMediator` instance such that the listener will no longer be notified about occuring events.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphEventMediator

public GraphEventMediator()

Constructor for GraphEventMediator.

Method Detail

addMediatorListener

public void addMediatorListener(GraphEventMediatorListener listener)

Adds the GraphEventMediatorListener given by listener to the GraphEventMediator instance such that the listener will be notified about every event that occurs.

Parameters:: listener - the GraphEventMediatorListener to add

removeMediatorListener

public void removeMediatorListener(GraphEventMediatorListener listener)

Removes the GraphEventMediatorListener given by listener from the GraphEventMediator instance such that the listener will no longer be notified about occuring events.

Parameters:: listener - the GraphEventMediatorListener to remove

getListeners

public java.util.List getListeners()

Returns a List of the GraphEventMediatorListeners currently registered.

Returns:: List the list of the listeners currently registered