org.jgrapht.io

Class VisioExporter<V,E>

java.lang.Object

org.jgrapht.io.VisioExporter<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

public class VisioExporter<V,E>
extends Object
implements GraphExporter<V,E>

Exports a graph to a CSV format that can be imported into MS Visio.

Tip: By default, the exported graph doesn't show link directions. To show link directions:

1. Select All (Ctrl-A)
2. Right Click the selected items
3. Format/Line...
4. Line ends: End: (choose an arrow)

Author:

Avner Linder

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentNameProvider<E>	edgeIDProvider Provides an identifier for an edge.
protected ComponentNameProvider<V>	vertexIDProvider Provides an identifier for a vertex.

Constructor Summary

Constructors

Constructor and Description
VisioExporter() Creates a new VisioExporter.
VisioExporter(ComponentNameProvider<V> vertexIDProvider) Creates a new VisioExporter with the specified naming policy.

Method Summary

Modifier and Type	Method and Description
void	exportGraph(Graph<V,E> g, Writer writer) Exports the specified graph into a Visio CSV file format.
ComponentNameProvider<E>	getEdgeIDProvider() Get the edge id provider
ComponentNameProvider<V>	getVertexIDProvider() Get the vertex id provider
void	setEdgeIDProvider(ComponentNameProvider<E> edgeIDProvider) Set the edge id provider.
void	setVertexIDProvider(ComponentNameProvider<V> vertexIDProvider) Set the vertex id provider

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapht.io.GraphExporter

exportGraph, exportGraph

Field Detail

vertexIDProvider

protected ComponentNameProvider<V> vertexIDProvider

Provides an identifier for a vertex.

edgeIDProvider

protected ComponentNameProvider<E> edgeIDProvider

Provides an identifier for an edge.

Constructor Detail

VisioExporter

public VisioExporter(ComponentNameProvider<V> vertexIDProvider)

Creates a new VisioExporter with the specified naming policy.

Parameters:

vertexIDProvider - the vertex id provider to be used for naming the Visio shapes

VisioExporter

public VisioExporter()

Creates a new VisioExporter.

Method Detail

exportGraph

public void exportGraph(Graph<V,E> g,
                        Writer writer)

Exports the specified graph into a Visio CSV file format.

Specified by:

exportGraph in interface GraphExporter<V,E>

Parameters:

g - the graph to be exported.

writer - the writer to which the graph to be exported.

getVertexIDProvider

public ComponentNameProvider<V> getVertexIDProvider()

Get the vertex id provider

Returns:

the vertex id provider

setVertexIDProvider

public void setVertexIDProvider(ComponentNameProvider<V> vertexIDProvider)

Set the vertex id provider

Parameters:

vertexIDProvider - the new vertex id provider. Must not be null.

getEdgeIDProvider

public ComponentNameProvider<E> getEdgeIDProvider()

Get the edge id provider

Returns:

The edge provider

setEdgeIDProvider

public void setEdgeIDProvider(ComponentNameProvider<E> edgeIDProvider)

Set the edge id provider.

Parameters:

edgeIDProvider - the new edge id provider. Must not be null.