org.graphstream.ui.view

Class ViewerPipe

java.lang.Object

org.graphstream.stream.SourceBase

org.graphstream.ui.view.ViewerPipe

All Implemented Interfaces:

AttributeSink, ElementSink, Pipe, ProxyPipe, Sink, Source

public class ViewerPipe
extends SourceBase
implements ProxyPipe

Shell around a proxy pipe coming from the viewer allowing to put viewer listeners on a viewer that runs in a distinct thread.

This pipe is a probe that you can place in the event loop between the viewer and the graph. It will transmit all events coming from the viewer to the graph (or any sink you connect to it). But in addition it will monitor standard attribute changes to redistribute them to specify "viewer listeners".

As any proxy pipe, a viewer pipe must be "pumped" to receive events coming from other threads.

Nested Class Summary

Nested classes/interfaces inherited from class org.graphstream.stream.SourceBase

SourceBase.ElementType

Method Summary

Methods

Modifier and Type	Method and Description
void	addViewerListener(ViewerListener listener)
void	blockingPump() Same as ProxyPipe.pump() but try to block until new events were available.
void	blockingPump(long timeout) Same as ProxyPipe.blockingPump() but including a timeout delay.
void	edgeAdded(String sourceId, long timeId, String edgeId, String fromNodeId, String toNodeId, boolean directed) An edge was inserted in graph.
void	edgeAttributeAdded(String sourceId, long timeId, String edgeId, String attribute, Object value) A edge attribute was added.
void	edgeAttributeChanged(String sourceId, long timeId, String edgeId, String attribute, Object oldValue, Object newValue) A edge attribute was changed.
void	edgeAttributeRemoved(String sourceId, long timeId, String edgeId, String attribute) A edge attribute was removed.
void	edgeRemoved(String sourceId, long timeId, String edgeId) An edge of graph was removed.The nodes the edge connects may already have been removed from the graph.
String	getId()
void	graphAttributeAdded(String sourceId, long timeId, String attribute, Object value) A graph attribute was added.
void	graphAttributeChanged(String sourceId, long timeId, String attribute, Object oldValue, Object newValue) A graph attribute was changed.
void	graphAttributeRemoved(String sourceId, long timeId, String attribute) A graph attribute was removed.
void	graphCleared(String sourceId, long timeId) The whole graph was cleared.
void	nodeAdded(String sourceId, long timeId, String nodeId) A node was inserted in the given graph.
void	nodeAttributeAdded(String sourceId, long timeId, String nodeId, String attribute, Object value) A node attribute was added.
void	nodeAttributeChanged(String sourceId, long timeId, String nodeId, String attribute, Object oldValue, Object newValue) A node attribute was changed.
void	nodeAttributeRemoved(String sourceId, long timeId, String nodeId, String attribute) A node attribute was removed.
void	nodeRemoved(String sourceId, long timeId, String nodeId) A node was removed from the graph.
void	pump() Check if some events are pending and dispatch them to the registered outputs.
void	removeViewerListener(ViewerListener listener)
void	stepBegins(String sourceId, long timeId, double step) Since dynamic graphs are based on discrete event modifications, the notion of step is defined to simulate elapsed time between events.

Methods inherited from class org.graphstream.stream.SourceBase

addAttributeSink, addElementSink, addSink, attributeSinks, clearAttributeSinks, clearElementSinks, clearSinks, elementSinks, removeAttributeSink, removeElementSink, removeSink, sendAttributeChangedEvent, sendAttributeChangedEvent, sendEdgeAdded, sendEdgeAdded, sendEdgeAttributeAdded, sendEdgeAttributeAdded, sendEdgeAttributeChanged, sendEdgeAttributeChanged, sendEdgeAttributeRemoved, sendEdgeAttributeRemoved, sendEdgeRemoved, sendEdgeRemoved, sendGraphAttributeAdded, sendGraphAttributeAdded, sendGraphAttributeChanged, sendGraphAttributeChanged, sendGraphAttributeRemoved, sendGraphAttributeRemoved, sendGraphCleared, sendGraphCleared, sendNodeAdded, sendNodeAdded, sendNodeAttributeAdded, sendNodeAttributeAdded, sendNodeAttributeChanged, sendNodeAttributeChanged, sendNodeAttributeRemoved, sendNodeAttributeRemoved, sendNodeRemoved, sendNodeRemoved, sendStepBegins, sendStepBegins

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graphstream.stream.Source

addAttributeSink, addElementSink, addSink, clearAttributeSinks, clearElementSinks, clearSinks, removeAttributeSink, removeElementSink, removeSink

Method Detail

getId

public String getId()

pump

public void pump()

Description copied from interface: ProxyPipe

Check if some events are pending and dispatch them to the registered outputs.

Specified by:

pump in interface ProxyPipe

blockingPump

public void blockingPump()
                  throws InterruptedException

Description copied from interface: ProxyPipe

Same as ProxyPipe.pump() but try to block until new events were available. Note that this feature will not be available on all proxy pipe implementation and may throws an UnsupportedOperationException. It can throw an InterruptedException if the current thread is interrupted while proxy is waiting for events.

Specified by:

blockingPump in interface ProxyPipe

Throws:

InterruptedException

blockingPump

public void blockingPump(long timeout)
                  throws InterruptedException

Description copied from interface: ProxyPipe

Same as ProxyPipe.blockingPump() but including a timeout delay.

Specified by:

blockingPump in interface ProxyPipe

Throws:

InterruptedException

addViewerListener

public void addViewerListener(ViewerListener listener)

removeViewerListener

public void removeViewerListener(ViewerListener listener)

edgeAttributeAdded

public void edgeAttributeAdded(String sourceId,
                      long timeId,
                      String edgeId,
                      String attribute,
                      Object value)

Description copied from interface: AttributeSink

A edge attribute was added.

Specified by:

edgeAttributeAdded in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the change occurred.

edgeId - Identifier of the edge whose attribute changed.

attribute - The attribute name.

value - The attribute new value.

edgeAttributeChanged

public void edgeAttributeChanged(String sourceId,
                        long timeId,
                        String edgeId,
                        String attribute,
                        Object oldValue,
                        Object newValue)

Description copied from interface: AttributeSink

A edge attribute was changed.

Specified by:

edgeAttributeChanged in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the change occurred.

edgeId - Identifier of the edge whose attribute changed.

attribute - The attribute name.

oldValue - The attribute old value.

newValue - The attribute new value.

edgeAttributeRemoved

public void edgeAttributeRemoved(String sourceId,
                        long timeId,
                        String edgeId,
                        String attribute)

Description copied from interface: AttributeSink

A edge attribute was removed.

Specified by:

edgeAttributeRemoved in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the attribute was removed.

edgeId - Identifier of the edge whose attribute was removed.

attribute - The removed attribute name.

graphAttributeAdded

public void graphAttributeAdded(String sourceId,
                       long timeId,
                       String attribute,
                       Object value)

Description copied from interface: AttributeSink

A graph attribute was added.

Specified by:

graphAttributeAdded in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the attribute changed.

attribute - The attribute name.

value - The attribute new value.

graphAttributeChanged

public void graphAttributeChanged(String sourceId,
                         long timeId,
                         String attribute,
                         Object oldValue,
                         Object newValue)

Description copied from interface: AttributeSink

A graph attribute was changed.

Specified by:

graphAttributeChanged in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the attribute changed.

attribute - The attribute name.

oldValue - The attribute old value.

newValue - The attribute new value.

graphAttributeRemoved

public void graphAttributeRemoved(String sourceId,
                         long timeId,
                         String attribute)

Description copied from interface: AttributeSink

A graph attribute was removed.

Specified by:

graphAttributeRemoved in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the attribute was removed.

attribute - The removed attribute name.

nodeAttributeAdded

public void nodeAttributeAdded(String sourceId,
                      long timeId,
                      String nodeId,
                      String attribute,
                      Object value)

Description copied from interface: AttributeSink

A node attribute was added.

Specified by:

nodeAttributeAdded in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the change occurred.

nodeId - Identifier of the node whose attribute changed.

attribute - The attribute name.

value - The attribute new value.

nodeAttributeChanged

public void nodeAttributeChanged(String sourceId,
                        long timeId,
                        String nodeId,
                        String attribute,
                        Object oldValue,
                        Object newValue)

Description copied from interface: AttributeSink

A node attribute was changed.

Specified by:

nodeAttributeChanged in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the change occurred.

nodeId - Identifier of the node whose attribute changed.

attribute - The attribute name.

oldValue - The attribute old value.

newValue - The attribute new value.

nodeAttributeRemoved

public void nodeAttributeRemoved(String sourceId,
                        long timeId,
                        String nodeId,
                        String attribute)

Description copied from interface: AttributeSink

A node attribute was removed.

Specified by:

nodeAttributeRemoved in interface AttributeSink

Parameters:

sourceId - Identifier of the graph where the attribute was removed.

nodeId - Identifier of the node whose attribute was removed.

attribute - The removed attribute name.

edgeAdded

public void edgeAdded(String sourceId,
             long timeId,
             String edgeId,
             String fromNodeId,
             String toNodeId,
             boolean directed)

Description copied from interface: ElementSink

An edge was inserted in graph.

Specified by:

edgeAdded in interface ElementSink

Parameters:

sourceId - Identifier of the graph where the edge was added.

edgeId - Identifier of the added edge.

fromNodeId - Identifier of the first node of the edge.

toNodeId - Identifier of the second node of the edge.

directed - If true, the edge is directed.

edgeRemoved

public void edgeRemoved(String sourceId,
               long timeId,
               String edgeId)

Description copied from interface: ElementSink

An edge of graph was removed.The nodes the edge connects may already have been removed from the graph.

Specified by:

edgeRemoved in interface ElementSink

Parameters:

sourceId - The graph where the edge will be removed.

edgeId - The edge that will be removed.

graphCleared

public void graphCleared(String sourceId,
                long timeId)

Description copied from interface: ElementSink

The whole graph was cleared. All the nodes, edges and attributes of the graph are removed.

Specified by:

graphCleared in interface ElementSink

Parameters:

sourceId - The graph cleared.

nodeAdded

public void nodeAdded(String sourceId,
             long timeId,
             String nodeId)

Description copied from interface: ElementSink

A node was inserted in the given graph.

Specified by:

nodeAdded in interface ElementSink

Parameters:

sourceId - Identifier of the graph where the node was added.

nodeId - Identifier of the added node.

nodeRemoved

public void nodeRemoved(String sourceId,
               long timeId,
               String nodeId)

Description copied from interface: ElementSink

A node was removed from the graph.

Specified by:

nodeRemoved in interface ElementSink

Parameters:

sourceId - Identifier of the graph where the node will be removed.

nodeId - Identifier of the removed node.

stepBegins

public void stepBegins(String sourceId,
              long timeId,
              double step)

Description copied from interface: ElementSink

Since dynamic graphs are based on discrete event modifications, the notion of step is defined to simulate elapsed time between events. So a step is a event that occurs in the graph, it does not modify it but it gives a kind of timestamp that allow the tracking of the progress of the graph over the time.

This kind of event is useful for dynamic algorithms that listen to the dynamic graph and need to measure the time in the graph's evolution.

Specified by:

stepBegins in interface ElementSink

Parameters:

sourceId - Identifier of the graph where the step starts.

timeId - A numerical value that may give a timestamp to track the evolution of the graph over the time.