org.jgrapht.io

Class DOTImporter<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphImporter<V,E>

public class DOTImporter<V,E>
extends Object
implements GraphImporter<V,E>

Import a graph from a DOT file.

For a description of the format see http://en.wikipedia.org/wiki/DOT_language and http://www.graphviz.org/doc/info/lang.html

Author:

Dimitrios Michail

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GRAPH_ID_KEY Default key used in the graph updater (if provided) for the graph ID.
protected EdgeProvider<V,E>	edgeProvider Constructs new edges
protected ComponentUpdater<Graph<V,E>>	graphUpdater Updates graph properties
protected VertexProvider<V>	vertexProvider Constructs new vertices
protected ComponentUpdater<V>	vertexUpdater Updates already constructed vertices

Constructor Summary

Constructors

Constructor and Description
DOTImporter(VertexProvider<V> vertexProvider, EdgeProvider<V,E> edgeProvider) Constructs a new importer.
DOTImporter(VertexProvider<V> vertexProvider, EdgeProvider<V,E> edgeProvider, ComponentUpdater<V> vertexUpdater) Constructs a new importer.
DOTImporter(VertexProvider<V> vertexProvider, EdgeProvider<V,E> edgeProvider, ComponentUpdater<V> vertexUpdater, ComponentUpdater<Graph<V,E>> graphUpdater) Constructs a new importer.

Method Summary

Modifier and Type	Method and Description
EdgeProvider<V,E>	getEdgeProvider() Get the edge provider
ComponentUpdater<Graph<V,E>>	getGraphUpdater() Get the graph updater.
VertexProvider<V>	getVertexProvider() Get the vertex provider
ComponentUpdater<V>	getVertexUpdater() Get the vertex updater
void	importGraph(Graph<V,E> g, Reader in) Import a graph
void	setEdgeProvider(EdgeProvider<V,E> edgeProvider) Set the edge provider.
void	setGraphUpdater(ComponentUpdater<Graph<V,E>> graphUpdater) Set the graph updater.
void	setVertexProvider(VertexProvider<V> vertexProvider) Set the vertex provider
void	setVertexUpdater(ComponentUpdater<V> vertexUpdater) Set the vertex updater.

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

importGraph, importGraph

Field Detail

DEFAULT_GRAPH_ID_KEY

public static final String DEFAULT_GRAPH_ID_KEY

Default key used in the graph updater (if provided) for the graph ID.

See Also:

Constant Field Values

vertexProvider

protected VertexProvider<V> vertexProvider

Constructs new vertices

edgeProvider

protected EdgeProvider<V,E> edgeProvider

Constructs new edges

vertexUpdater

protected ComponentUpdater<V> vertexUpdater

Updates already constructed vertices

graphUpdater

protected ComponentUpdater<Graph<V,E>> graphUpdater

Updates graph properties

Constructor Detail

DOTImporter

public DOTImporter(VertexProvider<V> vertexProvider,
                   EdgeProvider<V,E> edgeProvider)

Constructs a new importer.

Parameters:

vertexProvider - used to create vertices

edgeProvider - used to create edges

DOTImporter

public DOTImporter(VertexProvider<V> vertexProvider,
                   EdgeProvider<V,E> edgeProvider,
                   ComponentUpdater<V> vertexUpdater)

Constructs a new importer.

Parameters:

vertexProvider - used to create vertices

edgeProvider - used to create edges

vertexUpdater - used to further update vertices

DOTImporter

public DOTImporter(VertexProvider<V> vertexProvider,
                   EdgeProvider<V,E> edgeProvider,
                   ComponentUpdater<V> vertexUpdater,
                   ComponentUpdater<Graph<V,E>> graphUpdater)

Constructs a new importer.

Parameters:

vertexProvider - used to create vertices

edgeProvider - used to create edges

vertexUpdater - used to further update vertices

graphUpdater - used to update graph attributes, like the graph identifier

Method Detail

importGraph

public void importGraph(Graph<V,E> g,
                        Reader in)
                 throws ImportException

Import a graph

Specified by:

importGraph in interface GraphImporter<V,E>

Parameters:

g - the graph

in - the input reader

Throws:

ImportException - in case any error occurs, such as I/O or parse error

getVertexProvider

public VertexProvider<V> getVertexProvider()

Get the vertex provider

Returns:

the vertex provider

setVertexProvider

public void setVertexProvider(VertexProvider<V> vertexProvider)

Set the vertex provider

Parameters:

vertexProvider - the new vertex provider. Must not be null.

getEdgeProvider

public EdgeProvider<V,E> getEdgeProvider()

Get the edge provider

Returns:

The edge provider

setEdgeProvider

public void setEdgeProvider(EdgeProvider<V,E> edgeProvider)

Set the edge provider.

Parameters:

edgeProvider - the new edge provider. Must not be null.

getVertexUpdater

public ComponentUpdater<V> getVertexUpdater()

Get the vertex updater

Returns:

the vertex updater

setVertexUpdater

public void setVertexUpdater(ComponentUpdater<V> vertexUpdater)

Set the vertex updater.

Parameters:

vertexUpdater - the new vertex updater. Must not be null.

getGraphUpdater

public ComponentUpdater<Graph<V,E>> getGraphUpdater()

Get the graph updater.

Returns:

the graph updater

setGraphUpdater

public void setGraphUpdater(ComponentUpdater<Graph<V,E>> graphUpdater)

Set the graph updater.

Parameters:

graphUpdater - the new graph updater. Must not be null.