org.jgrapht.io

Class GraphMLExporter<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

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

Exports a graph as GraphML.

For a description of the format see http://en.wikipedia.org/wiki/ GraphML.

Author:

Trevor Harmon, Dimitrios Michail

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphMLExporter.AttributeCategory Denotes the category of a GraphML-Attribute.

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
GraphMLExporter() Constructs a new GraphMLExporter with integer name providers for the vertex and edge identifiers.
GraphMLExporter(ComponentNameProvider<V> vertexIDProvider, ComponentNameProvider<V> vertexLabelProvider, ComponentAttributeProvider<V> vertexAttributeProvider, ComponentNameProvider<E> edgeIDProvider, ComponentNameProvider<E> edgeLabelProvider, ComponentAttributeProvider<E> edgeAttributeProvider) Constructs a new GraphMLExporter.
GraphMLExporter(ComponentNameProvider<V> vertexIDProvider, ComponentNameProvider<V> vertexLabelProvider, ComponentNameProvider<E> edgeIDProvider, ComponentNameProvider<E> edgeLabelProvider) Constructs a new GraphMLExporter.

Method Summary

Modifier and Type	Method and Description
void	exportGraph(Graph<V,E> g, Writer writer) Exports a graph in GraphML format.
ComponentAttributeProvider<E>	getEdgeAttributeProvider() Get the edge attribute provider
ComponentNameProvider<E>	getEdgeIDProvider() Get the edge id provider
String	getEdgeLabelAttributeName() Get the attribute name for edge labels
ComponentNameProvider<E>	getEdgeLabelProvider() Get the edge label provider
String	getEdgeWeightAttributeName() Get the attribute name for edge weights
ComponentAttributeProvider<V>	getVertexAttributeProvider() Get the vertex attribute provider
ComponentNameProvider<V>	getVertexIDProvider() Get the vertex id provider
String	getVertexLabelAttributeName() Get the attribute name for vertex labels
ComponentNameProvider<V>	getVertexLabelProvider() Get the vertex label provider
boolean	isExportEdgeWeights() Whether the exporter will print edge weights.
void	registerAttribute(String name, GraphMLExporter.AttributeCategory category, AttributeType type) Register a GraphML-Attribute
void	registerAttribute(String name, GraphMLExporter.AttributeCategory category, AttributeType type, String defaultValue) Register a GraphML-Attribute
void	setEdgeAttributeProvider(ComponentAttributeProvider<E> edgeAttributeProvider) Set the edge attribute provider.
void	setEdgeIDProvider(ComponentNameProvider<E> edgeIDProvider) Set the edge id provider.
void	setEdgeLabelAttributeName(String edgeLabelAttributeName) Set the attribute name to use for edge labels.
void	setEdgeLabelProvider(ComponentNameProvider<E> edgeLabelProvider) Set the edge label provider.
void	setEdgeWeightAttributeName(String edgeWeightAttributeName) Set the attribute name to use for edge weights.
void	setExportEdgeWeights(boolean exportEdgeWeights) Set whether the exporter will print edge weights.
void	setVertexAttributeProvider(ComponentAttributeProvider<V> vertexAttributeProvider) Set the vertex attribute provider.
void	setVertexIDProvider(ComponentNameProvider<V> vertexIDProvider) Set the vertex id provider
void	setVertexLabelAttributeName(String vertexLabelAttributeName) Set the attribute name to use for vertex labels.
void	setVertexLabelProvider(ComponentNameProvider<V> vertexLabelProvider) Set the vertex label provider.
void	unregisterAttribute(String name) Unregister a GraphML-Attribute

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

GraphMLExporter

public GraphMLExporter()

Constructs a new GraphMLExporter with integer name providers for the vertex and edge identifiers.

GraphMLExporter

public GraphMLExporter(ComponentNameProvider<V> vertexIDProvider,
                       ComponentNameProvider<V> vertexLabelProvider,
                       ComponentNameProvider<E> edgeIDProvider,
                       ComponentNameProvider<E> edgeLabelProvider)

Constructs a new GraphMLExporter.

Parameters:

vertexIDProvider - for generating vertex identifiers. Must not be null.

vertexLabelProvider - for generating vertex labels. If null, vertex labels will not exported.

edgeIDProvider - for generating edge identifiers. Must not be null.

edgeLabelProvider - for generating edge labels. If null, edge labels will not be exported.

GraphMLExporter

public GraphMLExporter(ComponentNameProvider<V> vertexIDProvider,
                       ComponentNameProvider<V> vertexLabelProvider,
                       ComponentAttributeProvider<V> vertexAttributeProvider,
                       ComponentNameProvider<E> edgeIDProvider,
                       ComponentNameProvider<E> edgeLabelProvider,
                       ComponentAttributeProvider<E> edgeAttributeProvider)

Constructs a new GraphMLExporter.

Parameters:

vertexIDProvider - for generating vertex identifiers. Must not be null.

vertexLabelProvider - for generating vertex labels. If null, vertex labels will not exported.

vertexAttributeProvider - for generating vertex attributes. If null, no additional attributes will be exported.

edgeIDProvider - for generating edge identifiers. Must not be null.

edgeLabelProvider - for generating edge labels. If null, edge labels will not be exported.

edgeAttributeProvider - for generating edge attributes. If null, no additional attributes will be exported.

Method Detail

registerAttribute

public void registerAttribute(String name,
                              GraphMLExporter.AttributeCategory category,
                              AttributeType type)

Register a GraphML-Attribute

Parameters:

name - the attribute name

category - the attribute category

type - the attribute type

registerAttribute

public void registerAttribute(String name,
                              GraphMLExporter.AttributeCategory category,
                              AttributeType type,
                              String defaultValue)

Register a GraphML-Attribute

Parameters:

name - the attribute name

category - the attribute category

type - the attribute type

defaultValue - default value

unregisterAttribute

public void unregisterAttribute(String name)

Unregister a GraphML-Attribute

Parameters:

name - the attribute name

isExportEdgeWeights

public boolean isExportEdgeWeights()

Whether the exporter will print edge weights.

Returns:

true if the exporter prints edge weights, false otherwise

setExportEdgeWeights

public void setExportEdgeWeights(boolean exportEdgeWeights)

Set whether the exporter will print edge weights.

Parameters:

exportEdgeWeights - value to set

getVertexLabelAttributeName

public String getVertexLabelAttributeName()

Get the attribute name for vertex labels

Returns:

the attribute name

setVertexLabelAttributeName

public void setVertexLabelAttributeName(String vertexLabelAttributeName)

Set the attribute name to use for vertex labels.

Parameters:

vertexLabelAttributeName - the attribute name

getEdgeLabelAttributeName

public String getEdgeLabelAttributeName()

Get the attribute name for edge labels

Returns:

the attribute name

setEdgeLabelAttributeName

public void setEdgeLabelAttributeName(String edgeLabelAttributeName)

Set the attribute name to use for edge labels.

Parameters:

edgeLabelAttributeName - the attribute name

getEdgeWeightAttributeName

public String getEdgeWeightAttributeName()

Get the attribute name for edge weights

Returns:

the attribute name

setEdgeWeightAttributeName

public void setEdgeWeightAttributeName(String edgeWeightAttributeName)

Set the attribute name to use for edge weights.

Parameters:

edgeWeightAttributeName - the attribute name

getVertexLabelProvider

public ComponentNameProvider<V> getVertexLabelProvider()

Get the vertex label provider

Returns:

the vertex label provider

setVertexLabelProvider

public void setVertexLabelProvider(ComponentNameProvider<V> vertexLabelProvider)

Set the vertex label provider.

Parameters:

vertexLabelProvider - the vertex label provider to set

getEdgeLabelProvider

public ComponentNameProvider<E> getEdgeLabelProvider()

Get the edge label provider

Returns:

the edge label provider

setEdgeLabelProvider

public void setEdgeLabelProvider(ComponentNameProvider<E> edgeLabelProvider)

Set the edge label provider.

Parameters:

edgeLabelProvider - the edge label provider to set

getVertexAttributeProvider

public ComponentAttributeProvider<V> getVertexAttributeProvider()

Get the vertex attribute provider

Returns:

the vertex attribute provider

setVertexAttributeProvider

public void setVertexAttributeProvider(ComponentAttributeProvider<V> vertexAttributeProvider)

Set the vertex attribute provider.

Parameters:

vertexAttributeProvider - the vertex attribute provider to set

getEdgeAttributeProvider

public ComponentAttributeProvider<E> getEdgeAttributeProvider()

Get the edge attribute provider

Returns:

the edge attribute provider

setEdgeAttributeProvider

public void setEdgeAttributeProvider(ComponentAttributeProvider<E> edgeAttributeProvider)

Set the edge attribute provider.

Parameters:

edgeAttributeProvider - the edge attribute provider to set

exportGraph

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

Exports a graph in GraphML format.

Specified by:

exportGraph in interface GraphExporter<V,E>

Parameters:

g - the graph

writer - the writer to export the graph

Throws:

ExportException - in case any error occurs during export

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.