org.graphstream.stream

Class PipeAdapter

java.lang.Object

org.graphstream.stream.PipeAdapter

All Implemented Interfaces:

AttributeSink, ElementSink, Pipe, Sink, Source

public class PipeAdapter
extends java.lang.Object
implements Pipe

Adapter for the filter interface.

All methods are empty.

Constructor Summary

Constructors

Constructor and Description
PipeAdapter()

Method Summary

Modifier and Type	Method and Description
void	addAttributeSink(AttributeSink listener) Add a sink for attribute events only.
void	addElementSink(ElementSink listener) Add a sink for elements events only.
void	addSink(Sink listener) Add a sink for all graph events (attributes and graph elements) coming from this source.
void	clearAttributeSinks() Remove all listener attribute sinks.
void	clearElementSinks() Remove all listener element sinks.
void	clearSinks() Remove all listener sinks.
void	edgeAdded(java.lang.String sourceId, long timeId, java.lang.String edgeId, java.lang.String fromNodeId, java.lang.String toNodeId, boolean directed) An edge was inserted in graph.
void	edgeAttributeAdded(java.lang.String sourceId, long timeId, java.lang.String edgeId, java.lang.String attribute, java.lang.Object value) A edge attribute was added.
void	edgeAttributeChanged(java.lang.String sourceId, long timeId, java.lang.String edgeId, java.lang.String attribute, java.lang.Object oldValue, java.lang.Object newValue) A edge attribute was changed.
void	edgeAttributeRemoved(java.lang.String sourceId, long timeId, java.lang.String edgeId, java.lang.String attribute) A edge attribute was removed.
void	edgeRemoved(java.lang.String sourceId, long timeId, java.lang.String edgeId) An edge of graph was removed.The nodes the edge connects may already have been removed from the graph.
void	graphAttributeAdded(java.lang.String sourceId, long timeId, java.lang.String attribute, java.lang.Object value) A graph attribute was added.
void	graphAttributeChanged(java.lang.String sourceId, long timeId, java.lang.String attribute, java.lang.Object oldValue, java.lang.Object newValue) A graph attribute was changed.
void	graphAttributeRemoved(java.lang.String sourceId, long timeId, java.lang.String attribute) A graph attribute was removed.
void	graphCleared(java.lang.String sourceId, long timeId) The whole graph was cleared.
void	nodeAdded(java.lang.String sourceId, long timeId, java.lang.String nodeId) A node was inserted in the given graph.
void	nodeAttributeAdded(java.lang.String sourceId, long timeId, java.lang.String nodeId, java.lang.String attribute, java.lang.Object value) A node attribute was added.
void	nodeAttributeChanged(java.lang.String sourceId, long timeId, java.lang.String nodeId, java.lang.String attribute, java.lang.Object oldValue, java.lang.Object newValue) A node attribute was changed.
void	nodeAttributeRemoved(java.lang.String sourceId, long timeId, java.lang.String nodeId, java.lang.String attribute) A node attribute was removed.
void	nodeRemoved(java.lang.String sourceId, long timeId, java.lang.String nodeId) A node was removed from the graph.
void	removeAttributeSink(AttributeSink listener) Remove an attribute sink.
void	removeElementSink(ElementSink listener) Remove an element sink.
void	removeSink(Sink listener) Remove a sink.
void	stepBegins(java.lang.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 java.lang.Object

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

Constructor Detail

PipeAdapter

public PipeAdapter()

Method Detail

addAttributeSink

public void addAttributeSink(AttributeSink listener)

Description copied from interface: Source

Add a sink for attribute events only. Attribute events include attribute addition change and removal.

Specified by:

addAttributeSink in interface Source

Parameters:

listener - The sink to register.

addElementSink

public void addElementSink(ElementSink listener)

Description copied from interface: Source

Add a sink for elements events only. Elements events include, addition and removal of nodes and edges, as well as step events.

Specified by:

addElementSink in interface Source

Parameters:

listener - The sink to register.

addSink

public void addSink(Sink listener)

Description copied from interface: Source

Add a sink for all graph events (attributes and graph elements) coming from this source. This is similar to registering a sink for attributes an another for elements.

Specified by:

addSink in interface Source

Parameters:

listener - The sink to register.

removeAttributeSink

public void removeAttributeSink(AttributeSink listener)

Description copied from interface: Source

Remove an attribute sink.

Specified by:

removeAttributeSink in interface Source

Parameters:

listener - The sink to remove, if it does not exist, this is ignored silently.

removeElementSink

public void removeElementSink(ElementSink listener)

Description copied from interface: Source

Remove an element sink.

Specified by:

removeElementSink in interface Source

Parameters:

listener - The sink to remove, if it does not exist, this is ignored silently.

removeSink

public void removeSink(Sink listener)

Description copied from interface: Source

Remove a sink.

Specified by:

removeSink in interface Source

Parameters:

listener - The sink to remove, if it does not exist, this is ignored silently.

edgeAttributeAdded

public void edgeAttributeAdded(java.lang.String sourceId,
                               long timeId,
                               java.lang.String edgeId,
                               java.lang.String attribute,
                               java.lang.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(java.lang.String sourceId,
                                 long timeId,
                                 java.lang.String edgeId,
                                 java.lang.String attribute,
                                 java.lang.Object oldValue,
                                 java.lang.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(java.lang.String sourceId,
                                 long timeId,
                                 java.lang.String edgeId,
                                 java.lang.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(java.lang.String sourceId,
                                long timeId,
                                java.lang.String attribute,
                                java.lang.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(java.lang.String sourceId,
                                  long timeId,
                                  java.lang.String attribute,
                                  java.lang.Object oldValue,
                                  java.lang.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(java.lang.String sourceId,
                                  long timeId,
                                  java.lang.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(java.lang.String sourceId,
                               long timeId,
                               java.lang.String nodeId,
                               java.lang.String attribute,
                               java.lang.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(java.lang.String sourceId,
                                 long timeId,
                                 java.lang.String nodeId,
                                 java.lang.String attribute,
                                 java.lang.Object oldValue,
                                 java.lang.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(java.lang.String sourceId,
                                 long timeId,
                                 java.lang.String nodeId,
                                 java.lang.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(java.lang.String sourceId,
                      long timeId,
                      java.lang.String edgeId,
                      java.lang.String fromNodeId,
                      java.lang.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(java.lang.String sourceId,
                        long timeId,
                        java.lang.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(java.lang.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(java.lang.String sourceId,
                      long timeId,
                      java.lang.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(java.lang.String sourceId,
                        long timeId,
                        java.lang.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(java.lang.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.

clearAttributeSinks

public void clearAttributeSinks()

Description copied from interface: Source

Remove all listener attribute sinks.

Specified by:

clearAttributeSinks in interface Source

clearElementSinks

public void clearElementSinks()

Description copied from interface: Source

Remove all listener element sinks.

Specified by:

clearElementSinks in interface Source

clearSinks

public void clearSinks()

Description copied from interface: Source

Remove all listener sinks.

Specified by:

clearSinks in interface Source