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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ATTRIBUTE_KEY_PREFIX
private static final String	EDGE_LABEL_DEFAULT_ATTRIBUTE_NAME
private static final String	EDGE_WEIGHT_DEFAULT_ATTRIBUTE_NAME
private String	edgeLabelAttributeName
private String	edgeWeightAttributeName
private boolean	exportEdgeLabels	Whether to try to print edge labels.
private boolean	exportEdgeWeights	Whether to print edge weights in case the graph is weighted.
private boolean	exportVertexLabels	Whether to try to print vertex labels.
private Map<String, GraphMLExporter<V,E>.AttributeDetails>	registeredAttributes
private int	totalAttributes
private static final String	VERTEX_LABEL_DEFAULT_ATTRIBUTE_NAME
private String	vertexLabelAttributeName

Fields inherited from class 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
private void	writeAttribute(TransformerHandler handler, String name, GraphMLExporter<V,E>.AttributeDetails details)
private void	writeData(TransformerHandler handler, String key, String value)
private void	writeEdges(TransformerHandler handler, Graph<V,E> g)
private void	writeFooter(TransformerHandler handler)
private void	writeGraphEnd(TransformerHandler handler)
private void	writeGraphStart(TransformerHandler handler, Graph<V,E> g)
private void	writeHeader(TransformerHandler handler)
private void	writeKeys(TransformerHandler handler)
private void	writeNodes(TransformerHandler handler, Graph<V,E> g)

Methods inherited from class 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 Object

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

Methods inherited from interface GraphExporter

exportGraph, exportGraph

Field Details

registeredAttributes

private Map<String, GraphMLExporter<V,E>.AttributeDetails> registeredAttributes

ATTRIBUTE_KEY_PREFIX

private static final String ATTRIBUTE_KEY_PREFIX

See Also:

• Constant Field Values

totalAttributes

private int totalAttributes

VERTEX_LABEL_DEFAULT_ATTRIBUTE_NAME

private static final String VERTEX_LABEL_DEFAULT_ATTRIBUTE_NAME

See Also:

• Constant Field Values

EDGE_WEIGHT_DEFAULT_ATTRIBUTE_NAME

private static final String EDGE_WEIGHT_DEFAULT_ATTRIBUTE_NAME

See Also:

• Constant Field Values

EDGE_LABEL_DEFAULT_ATTRIBUTE_NAME

private static final String EDGE_LABEL_DEFAULT_ATTRIBUTE_NAME

See Also:

• Constant Field Values

vertexLabelAttributeName

private String vertexLabelAttributeName

edgeWeightAttributeName

private String edgeWeightAttributeName

edgeLabelAttributeName

private String edgeLabelAttributeName

exportEdgeWeights

private boolean exportEdgeWeights

Whether to print edge weights in case the graph is weighted.

exportVertexLabels

private boolean exportVertexLabels

Whether to try to print vertex labels. They must be found in the corresponding attribute provider.

exportEdgeLabels

private boolean exportEdgeLabels

Whether to try to print edge labels. They must be found in the corresponding attribute provider.

Constructor Details

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 Details

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

writeHeader

private void writeHeader(TransformerHandler handler)
                  throws SAXException

Throws:

SAXException

writeGraphStart

private void writeGraphStart(TransformerHandler handler,
 Graph<V,E> g)
                      throws SAXException

Throws:

SAXException

writeGraphEnd

private void writeGraphEnd(TransformerHandler handler)
                    throws SAXException

Throws:

SAXException

writeFooter

private void writeFooter(TransformerHandler handler)
                  throws SAXException

Throws:

SAXException

writeKeys

private void writeKeys(TransformerHandler handler)
                throws SAXException

Throws:

SAXException

writeData

private void writeData(TransformerHandler handler,
 String key,
 String value)
                throws SAXException

Throws:

SAXException

writeAttribute

private void writeAttribute(TransformerHandler handler,
 String name,
 GraphMLExporter<V,E>.AttributeDetails details)
                     throws SAXException

Throws:

SAXException

writeNodes

private void writeNodes(TransformerHandler handler,
 Graph<V,E> g)
                 throws SAXException

Throws:

SAXException

writeEdges

private void writeEdges(TransformerHandler handler,
 Graph<V,E> g)
                 throws SAXException

Throws:

SAXException