Module org.jgrapht.io

Package org.jgrapht.nio.graphml

Class GraphMLExporter<V,E>

java.lang.Object

org.jgrapht.nio.BaseExporter<V,E>

org.jgrapht.nio.graphml.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 BaseExporter<V,E>
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	Description
static class	GraphMLExporter.AttributeCategory	Denotes the category of a GraphML-Attribute.

Field Summary

Fields inherited from class org.jgrapht.nio.BaseExporter

edgeAttributeProvider, edgeIdProvider, graphAttributeProvider, graphIdProvider, vertexAttributeProvider, vertexIdProvider

Constructor Summary

Constructors

Constructor	Description
GraphMLExporter()	Constructs a new GraphMLExporter with integer id provider for the vertices.
GraphMLExporter(Function<V,String> vertexIdProvider)	Constructs a new GraphMLExporter.

Method Summary

Modifier and Type	Method	Description
void	exportGraph(Graph<V,E> g, Writer writer)	Exports a graph in GraphML format.
String	getEdgeLabelAttributeName()	Get the attribute name for edge labels
String	getEdgeWeightAttributeName()	Get the attribute name for edge weights
String	getVertexLabelAttributeName()	Get the attribute name for vertex labels
boolean	isExportEdgeLabels()	Whether the exporter will print edge labels.
boolean	isExportEdgeWeights()	Whether the exporter will print edge weights.
boolean	isExportVertexLabels()	Whether the exporter will print vertex labels.
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	setEdgeLabelAttributeName(String edgeLabelAttributeName)	Set the attribute name to use for edge labels.
void	setEdgeWeightAttributeName(String edgeWeightAttributeName)	Set the attribute name to use for edge weights.
void	setExportEdgeLabels(boolean exportEdgeLabels)	Set whether the exporter will print edge labels.
void	setExportEdgeWeights(boolean exportEdgeWeights)	Set whether the exporter will print edge weights.
void	setExportVertexLabels(boolean exportVertexLabels)	Set whether the exporter will print vertex labels.
void	setVertexLabelAttributeName(String vertexLabelAttributeName)	Set the attribute name to use for vertex labels.
void	unregisterAttribute(String name)	Unregister a GraphML-Attribute

Methods inherited from class org.jgrapht.nio.BaseExporter

getEdgeAttribute, getEdgeAttributeProvider, getEdgeAttributes, getEdgeId, getEdgeIdProvider, getGraphAttribute, getGraphAttributeProvider, getGraphId, getGraphIdProvider, getVertexAttribute, getVertexAttributeProvider, getVertexAttributes, getVertexId, getVertexIdProvider, setEdgeAttributeProvider, setEdgeIdProvider, setGraphAttributeProvider, setGraphIdProvider, setVertexAttributeProvider, setVertexIdProvider

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapht.nio.GraphExporter

exportGraph, exportGraph

Constructor Detail

GraphMLExporter

public GraphMLExporter()

Constructs a new GraphMLExporter with integer id provider for the vertices.

GraphMLExporter

public GraphMLExporter(Function<V,String> vertexIdProvider)

Constructs a new GraphMLExporter.

Parameters:

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

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

isExportVertexLabels

public boolean isExportVertexLabels()

Whether the exporter will print vertex labels.

Returns:

true if the exporter prints vertex labels, false otherwise

setExportVertexLabels

public void setExportVertexLabels(boolean exportVertexLabels)

Set whether the exporter will print vertex labels.

Parameters:

exportVertexLabels - value to set

isExportEdgeLabels

public boolean isExportEdgeLabels()

Whether the exporter will print edge labels.

Returns:

true if the exporter prints edge labels, false otherwise

setExportEdgeLabels

public void setExportEdgeLabels(boolean exportEdgeLabels)

Set whether the exporter will print edge labels.

Parameters:

exportEdgeLabels - 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

exportGraph

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

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