edu.ucla.sspace.graph.io

Class GexfIO

java.lang.Object

edu.ucla.sspace.graph.io.GexfIO

public class GexfIO
extends Object

An implementation for writing Graph instances as gexf-formatted files, which are commonly used with the Gephi graph program.

Constructor Summary

Constructors

Constructor and Description
GexfIO()

Method Summary

Methods

Modifier and Type	Method and Description
<T,E extends TypedEdge<T>> void	write(Multigraph<T,E> g, File f) Writes the provided multigraph to the specified gexf file with all edge colors appearing the same.
<T,E extends TypedEdge<T>> void	write(Multigraph<T,E> g, File f, Indexer<String> vertexLabels) Writes the provided multigraph to the specified gexf file, using vertexLabels to name the vertices.
<T,E extends TypedEdge<T>> void	write(Multigraph<T,E> g, File f, Map<T,Color> edgeColors) Writes the provided multigraph to the specified gexf file, using edgeColors as a guide for how to display parallel edges of different types.
<T,E extends TypedEdge<T>> void	write(Multigraph<T,E> g, File f, Map<T,Color> edgeColors, Indexer<String> vertexLabels) Writes the provided multigraph to the specified gexf file, using edgeColors as a guide for how to display parallel edges of different types, and vertexLabels to name the vertices.
void	write(WeightedGraph<? extends WeightedEdge> g, File gexfFile) Writes the WeightedGraph to file in gexf format.
void	write(WeightedGraph<? extends WeightedEdge> g, File gexfFile, Indexer<String> vertexLabels) Writes the WeightedGraph to file in gexf format.

Methods inherited from class java.lang.Object

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

Constructor Detail

GexfIO

public GexfIO()

Method Detail

write

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

Writes the provided multigraph to the specified gexf file with all edge colors appearing the same.

Parameters:

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

Throws:

IOException

write

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

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

Parameters:

f - the file where the gexf 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

write

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

Writes the provided multigraph to the specified gexf file, using vertexLabels to name the vertices.

Parameters:

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

vertexLabels - a mapping from vertex value to a string name for the vertex

Throws:

IOException

write

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

Writes the provided multigraph to the specified gexf file, using edgeColors as a guide for how to display parallel edges of different types, and vertexLabels to name the vertices.

Parameters:

f - the file where the gexf 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.

vertexLabels - a mapping from vertex value to a string name for the vertex

Throws:

IOException

write

public void write(WeightedGraph<? extends WeightedEdge> g,
         File gexfFile)
           throws IOException

Writes the WeightedGraph to file in gexf format.

Throws:

IOException

write

public void write(WeightedGraph<? extends WeightedEdge> g,
         File gexfFile,
         Indexer<String> vertexLabels)
           throws IOException

Writes the WeightedGraph to file in gexf format.

Throws:

IOException