edu.ucla.sspace.graph.io

Class DotIO

java.lang.Object

edu.ucla.sspace.graph.io.DotIO

public class DotIO
extends Object

A class for reading graph instances from DOT graph files.

Constructor Summary

Constructors

Constructor and Description
DotIO()
DotIO(Indexer<String> indexer)

Method Summary

Methods

Modifier and Type	Method and Description
DirectedGraph<DirectedEdge>	readDirectedGraph(File dotFile)
DirectedMultigraph	readDirectedMultigraph(File dotFile)
Graph	readGraph(File dotFile)
<E extends DirectedEdge> void	writeDirectedGraph(DirectedGraph<E> g, File f)
<T,E extends DirectedTypedEdge<T>> void	writeDirectedMultigraph(Multigraph<T,E> g, File f) Writes the provided multigraph to the specified DOT file, using random colors to visualize each edge type.
<T,E extends DirectedTypedEdge<T>> void	writeDirectedMultigraph(Multigraph<T,E> g, File f, Map<T,Color> edgeColors)
<E extends Edge> void	writeUndirectedGraph(Graph<E> g, File f)
<E extends Edge> void	writeUndirectedGraph(Graph<E> g, File f, Indexer<String> vertexLabels)
<T,E extends TypedEdge<T>> void	writeUndirectedMultigraph(Multigraph<T,E> g, File f) Writes the provided multigraph to the specified DOT file, using random colors to visualize each edge type.
<T,E extends TypedEdge<T>> void	writeUndirectedMultigraph(Multigraph<T,E> g, File f, Map<T,Color> edgeColors) Writes the provided multigraph to the specified DOT file, using edgeColors as a guide for how to display parallel edges of different types.
<T,E extends TypedEdge<T>> void	writeUndirectedMultigraph(Multigraph<T,E> g, File f, Map<T,Color> edgeColors, Indexer<String> vertexLabels) Writes the provided multigraph to the specified DOT file, using edgeColors as a guide for how to display parallel edges of different types.
<T,E extends TypedEdge<T>> void	writeUndirectedMultigraph(Multigraph<T,E> g, File f, Map<T,Color> edgeColors, MultiMap<Integer,String> vertexMetadata) The internal method that writes the undirect multigraph according to all various visualation configuration properties

Methods inherited from class java.lang.Object

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

Constructor Detail

DotIO

public DotIO()

DotIO

public DotIO(Indexer<String> indexer)

Method Detail

readGraph

public Graph readGraph(File dotFile)

readDirectedGraph

public DirectedGraph<DirectedEdge> readDirectedGraph(File dotFile)

readDirectedMultigraph

public DirectedMultigraph readDirectedMultigraph(File dotFile)

writeUndirectedGraph

public <E extends Edge> void writeUndirectedGraph(Graph<E> g,
                                         File f)
                          throws IOException

Throws:

IOException

writeUndirectedGraph

public <E extends Edge> void writeUndirectedGraph(Graph<E> g,
                                         File f,
                                         Indexer<String> vertexLabels)
                          throws IOException

Throws:

IOException

writeDirectedGraph

public <E extends DirectedEdge> void writeDirectedGraph(DirectedGraph<E> g,
                                               File f)
                        throws IOException

Throws:

IOException

writeUndirectedMultigraph

public <T,E extends TypedEdge<T>> void writeUndirectedMultigraph(Multigraph<T,E> g,
                                                        File f)
                               throws IOException

Writes the provided multigraph to the specified DOT file, using random colors to visualize each edge type.

Parameters:

f - the file where the DOT graph will be written. Any existing file contents will be overwritten

Throws:

IOException

writeUndirectedMultigraph

public <T,E extends TypedEdge<T>> void writeUndirectedMultigraph(Multigraph<T,E> g,
                                                        File f,
                                                        Map<T,Color> edgeColors)
                               throws IOException

Writes the provided multigraph to the specified DOT file, using edgeColors as a guide for how to display parallel edges of different types.

Parameters:

f - the file where the DOT graph will be written. Any existing file contents will be overwritten

edgeColor - a mapping from an edge type to a color. Types that do not have colors will be randomly assigned one and the edgeColors map will be updated appropriately.

Throws:

IOException

writeUndirectedMultigraph

public <T,E extends TypedEdge<T>> void writeUndirectedMultigraph(Multigraph<T,E> g,
                                                        File f,
                                                        Map<T,Color> edgeColors,
                                                        Indexer<String> vertexLabels)
                               throws IOException

Writes the provided multigraph to the specified DOT file, using edgeColors as a guide for how to display parallel edges of different types.

Parameters:

f - the file where the DOT graph will be written. Any existing file contents will be overwritten

edgeColor - a mapping from an edge type to a color. Types that do not have colors will be randomly assigned one and the edgeColors map will be updated appropriately.

Throws:

IOException

writeUndirectedMultigraph

public <T,E extends TypedEdge<T>> void writeUndirectedMultigraph(Multigraph<T,E> g,
                                                        File f,
                                                        Map<T,Color> edgeColors,
                                                        MultiMap<Integer,String> vertexMetadata)
                               throws IOException

The internal method that writes the undirect multigraph according to all various visualation configuration properties

Parameters:

useLabels - whether to use vertexLabels in naming the vertices. If false, vertices are labeled by number

Throws:

IOException

writeDirectedMultigraph

public <T,E extends DirectedTypedEdge<T>> void writeDirectedMultigraph(Multigraph<T,E> g,
                                                              File f)
                             throws IOException

Writes the provided multigraph to the specified DOT file, using random colors to visualize each edge type.

Parameters:

f - the file where the DOT graph will be written. Any existing file contents will be overwritten

Throws:

IOException

writeDirectedMultigraph

public <T,E extends DirectedTypedEdge<T>> void writeDirectedMultigraph(Multigraph<T,E> g,
                                                              File f,
                                                              Map<T,Color> edgeColors)
                             throws IOException

Throws:

IOException