org.graphstream.stream.file

Class FileSinkDGSFiltered

java.lang.Object

org.graphstream.stream.file.FileSinkBase

org.graphstream.stream.file.FileSinkBaseFiltered

org.graphstream.stream.file.FileSinkDGSFiltered

All Implemented Interfaces:

AttributeSink, ElementSink, FileSink, Sink

public class FileSinkDGSFiltered
extends FileSinkBaseFiltered

File output for the DGS (Dynamic Graph Stream) file format. It includes also the possibility to filter dynamic events such as :

• Addition or deletion of nodes or edges.
• Addition/deletion/modification of attributes of nodes, edges or the graph itself.
• A step event.

For instance :

 Graph graph = new SingleGraph("My_Graph");
 FileSinkDGSFiltered fileSink = new FileSinkDGSFiltered();
 graph.addSink(fileSink);
 
 // No need to save the attribute "attr1" of any edges
 fileSink.addEdgeAttributeFiltered("attr1");
 // No need to save graph attributes
 fileSink.setNoFilterGraphAttributeAdded(false);
 
 // Start to listen event
 fileSink.begin("./my_graph.dgs");
 
 // Make some modifications on the graph and generate events
 graph.stepBegins(0); // this event will be saved
 graph.setAttribute("attr2", 2); // this event will not be saved
 Node a = graph.addNode("A"); // this event will be saved
 a.setAttribute("attr3", 3); // this event will be saved
 
 // and now, no more need to save modification on nodes attributes
 fileSink.setNoFilterNodeAttributeChanged(false);
 
 Node b = graph.addNode("B"); // this event will be saved
 b.setAttribute("attr4", 4); // this event will not be saved
 
 Edge ab = graph.addEdge("AB", a, b); // this event will be saved
 ab.setAttribute("attr1", 1); // this event will not be saved
 ab.setAttribute("attr5", 5); // this event will be saved
 
 fileSink.end();
 

Constructor Summary

Constructors

Constructor and Description
FileSinkDGSFiltered()

Method Summary

Modifier and Type	Method and Description
void	edgeAdded(java.lang.String graphId, 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 graphId, long timeId, java.lang.String edgeId, java.lang.String attribute, java.lang.Object value) A edge attribute was added.
void	edgeAttributeChanged(java.lang.String graphId, 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 graphId, long timeId, java.lang.String edgeId, java.lang.String attribute) A edge attribute was removed.
void	edgeRemoved(java.lang.String graphId, 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 graphId, long timeId, java.lang.String attribute, java.lang.Object value) A graph attribute was added.
void	graphAttributeChanged(java.lang.String graphId, long timeId, java.lang.String attribute, java.lang.Object oldValue, java.lang.Object newValue) A graph attribute was changed.
void	graphAttributeRemoved(java.lang.String graphId, long timeId, java.lang.String attribute) A graph attribute was removed.
void	graphCleared(java.lang.String graphId, long timeId) The whole graph was cleared.
void	nodeAdded(java.lang.String graphId, long timeId, java.lang.String nodeId) A node was inserted in the given graph.
void	nodeAttributeAdded(java.lang.String graphId, long timeId, java.lang.String nodeId, java.lang.String attribute, java.lang.Object value) A node attribute was added.
void	nodeAttributeChanged(java.lang.String graphId, 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 graphId, long timeId, java.lang.String nodeId, java.lang.String attribute) A node attribute was removed.
void	nodeRemoved(java.lang.String graphId, long timeId, java.lang.String nodeId) A node was removed from the graph.
void	stepBegins(java.lang.String graphId, 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.file.FileSinkBaseFiltered

addEdgeAttributeFiltered, addGraphAttributeFiltered, addNodeAttributeFiltered, getEdgeAttributesFiltered, getGraphAttributesFiltered, getNodeAttributesFiltered, isNoFilterEdgeAdded, isNoFilterEdgeAttributeAdded, isNoFilterEdgeAttributeChanged, isNoFilterEdgeAttributeRemoved, isNoFilterEdgeRemoved, isNoFilterGraphAttributeAdded, isNoFilterGraphAttributeChanged, isNoFilterGraphAttributeRemoved, isNoFilterGraphCleared, isNoFilterNodeAdded, isNoFilterNodeAttributeAdded, isNoFilterNodeAttributeChanged, isNoFilterNodeAttributeRemoved, isNoFilterNodeRemoved, isNoFilterStepBegins, removeEdgeAttributeFilter, removeGraphAttributeFilter, removeNodeAttributeFilter, setEdgeAttributesFiltered, setGraphAttributesFiltered, setNodeAttributesFiltered, setNoFilterEdgeAdded, setNoFilterEdgeAttributeAdded, setNoFilterEdgeAttributeChanged, setNoFilterEdgeAttributeRemoved, setNoFilterEdgeRemoved, setNoFilterGraphAttributeAdded, setNoFilterGraphAttributeChanged, setNoFilterGraphAttributeRemoved, setNoFilterGraphCleared, setNoFilterNodeAdded, setNoFilterNodeAttributeAdded, setNoFilterNodeAttributeChanged, setNoFilterNodeAttributeRemoved, setNoFilterNodeRemoved, setNoFilterStepBegins

Methods inherited from class org.graphstream.stream.file.FileSinkBase

begin, begin, begin, end, flush, writeAll, writeAll, writeAll

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSinkDGSFiltered

public FileSinkDGSFiltered()

Method Detail

edgeAttributeAdded

public void edgeAttributeAdded(java.lang.String graphId,
                               long timeId,
                               java.lang.String edgeId,
                               java.lang.String attribute,
                               java.lang.Object value)

Description copied from interface: AttributeSink

A edge attribute was added.

Parameters:

graphId - 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 graphId,
                                 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.

Parameters:

graphId - 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 graphId,
                                 long timeId,
                                 java.lang.String edgeId,
                                 java.lang.String attribute)

Description copied from interface: AttributeSink

A edge attribute was removed.

Parameters:

graphId - 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 graphId,
                                long timeId,
                                java.lang.String attribute,
                                java.lang.Object value)

Description copied from interface: AttributeSink

A graph attribute was added.

Parameters:

graphId - Identifier of the graph where the attribute changed.

attribute - The attribute name.

value - The attribute new value.

graphAttributeChanged

public void graphAttributeChanged(java.lang.String graphId,
                                  long timeId,
                                  java.lang.String attribute,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Description copied from interface: AttributeSink

A graph attribute was changed.

Parameters:

graphId - 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 graphId,
                                  long timeId,
                                  java.lang.String attribute)

Description copied from interface: AttributeSink

A graph attribute was removed.

Parameters:

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

attribute - The removed attribute name.

nodeAttributeAdded

public void nodeAttributeAdded(java.lang.String graphId,
                               long timeId,
                               java.lang.String nodeId,
                               java.lang.String attribute,
                               java.lang.Object value)

Description copied from interface: AttributeSink

A node attribute was added.

Parameters:

graphId - 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 graphId,
                                 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.

Parameters:

graphId - 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 graphId,
                                 long timeId,
                                 java.lang.String nodeId,
                                 java.lang.String attribute)

Description copied from interface: AttributeSink

A node attribute was removed.

Parameters:

graphId - 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 graphId,
                      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.

Parameters:

graphId - 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 graphId,
                        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.

Parameters:

graphId - The graph where the edge will be removed.

edgeId - The edge that will be removed.

graphCleared

public void graphCleared(java.lang.String graphId,
                         long timeId)

Description copied from interface: ElementSink

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

Parameters:

graphId - The graph cleared.

nodeAdded

public void nodeAdded(java.lang.String graphId,
                      long timeId,
                      java.lang.String nodeId)

Description copied from interface: ElementSink

A node was inserted in the given graph.

Parameters:

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

nodeId - Identifier of the added node.

nodeRemoved

public void nodeRemoved(java.lang.String graphId,
                        long timeId,
                        java.lang.String nodeId)

Description copied from interface: ElementSink

A node was removed from the graph.

Parameters:

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

nodeId - Identifier of the removed node.

stepBegins

public void stepBegins(java.lang.String graphId,
                       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.

Parameters:

graphId - 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.