org.graphstream.stream.file

Class FileSinkDOT

java.lang.Object

org.graphstream.stream.file.FileSinkBase

org.graphstream.stream.file.FileSinkDOT

All Implemented Interfaces:

AttributeSink, ElementSink, FileSink, Sink

public class FileSinkDOT
extends FileSinkBase

Graph writer for the GraphViz DOT format.

Constructor Summary

Constructors

Constructor and Description
FileSinkDOT() Build a new DOT sink to export undirected graph.
FileSinkDOT(boolean digraph) Build a new DOT sink specifying if the graph is directed or not.

Method Summary

Methods

Modifier and Type	Method and Description
void	edgeAdded(String graphId, long timeId, String edgeId, String fromNodeId, String toNodeId, boolean directed) An edge was inserted in graph.
void	edgeAttributeAdded(String graphId, long timeId, String edgeId, String attribute, Object value) A edge attribute was added.
void	edgeAttributeChanged(String graphId, long timeId, String edgeId, String attribute, Object oldValue, Object newValue) A edge attribute was changed.
void	edgeAttributeRemoved(String graphId, long timeId, String edgeId, String attribute) A edge attribute was removed.
void	edgeRemoved(String graphId, long timeId, String edgeId) An edge of graph was removed.The nodes the edge connects may already have been removed from the graph.
void	graphAttributeAdded(String graphId, long timeId, String attribute, Object value) A graph attribute was added.
void	graphAttributeChanged(String graphId, long timeId, String attribute, Object oldValue, Object newValue) A graph attribute was changed.
void	graphAttributeRemoved(String graphId, long timeId, String attribute) A graph attribute was removed.
void	graphCleared(String graphId, long timeId) The whole graph was cleared.
boolean	isDirected() Get the flag indicating if exported graph is directed or not.
void	nodeAdded(String graphId, long timeId, String nodeId) A node was inserted in the given graph.
void	nodeAttributeAdded(String graphId, long timeId, String nodeId, String attribute, Object value) A node attribute was added.
void	nodeAttributeChanged(String graphId, long timeId, String nodeId, String attribute, Object oldValue, Object newValue) A node attribute was changed.
void	nodeAttributeRemoved(String graphId, long timeId, String nodeId, String attribute) A node attribute was removed.
void	nodeRemoved(String graphId, long timeId, String nodeId) A node was removed from the graph.
void	setDirected(boolean digraph) Set flag indicating if exported graph is directed or not.
void	stepBegins(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.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

FileSinkDOT

public FileSinkDOT()

Build a new DOT sink to export undirected graph.

FileSinkDOT

public FileSinkDOT(boolean digraph)

Build a new DOT sink specifying if the graph is directed or not.

Parameters:

digraph - true if the graph is directed

Method Detail

setDirected

public void setDirected(boolean digraph)

Set flag indicating if exported graph is directed or not.

Parameters:

digraph - true is exported graph is directed

isDirected

public boolean isDirected()

Get the flag indicating if exported graph is directed or not.

Returns:

true if exported graph is directed

edgeAttributeAdded

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

Parameters:

graphId - The graph where the edge will be removed.

edgeId - The edge that will be removed.

graphCleared

public void graphCleared(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(String graphId,
             long timeId,
             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(String graphId,
               long timeId,
               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(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.