Module org.jgrapht.io

Package org.jgrapht.nio.gml

Class GmlExporter<V,E>

java.lang.Object

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

org.jgrapht.nio.gml.GmlExporter<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

public class GmlExporter<V,E>
extends BaseExporter<V,E>
implements GraphExporter<V,E>

Exports a graph into a GML file (Graph Modeling Language).

For a description of the format see https://github.com/GunterMueller/UNI_PASSAU_FMI_Graph_Drawing/blob/master/GML/gml-technical-report.pdf.

The behavior of the exporter such as whether to print vertex labels, edge labels, and/or edge weights can be adjusted using the setParameter method. When exporting labels, the exporter escapes them as Java strings.

Author:

Dimitrios Michail

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GmlExporter.Parameter	Parameters that affect the behavior of the GmlExporter exporter.

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<Function<V,Map<String,Attribute>>>	vertexGraphicsAttributeProvider

Fields inherited from class org.jgrapht.nio.BaseExporter

edgeAttributeProvider, edgeIdProvider, graphAttributeProvider, graphIdProvider, vertexAttributeProvider, vertexIdProvider

Constructor Summary

Constructors

Constructor	Description
GmlExporter()	Creates a new GmlExporter object with integer id providers for the vertex identifiers.
GmlExporter(Function<V,String> vertexIdProvider)	Constructs a new GmlExporter object with the given id providers.

Method Summary

Modifier and Type	Method	Description
void	exportGraph(Graph<V,E> g, Writer writer)	Exports an graph into a plain text GML format.
protected Optional<Map<String,Attribute>>	getVertexGraphicsAttributes(V v)
boolean	isParameter(GmlExporter.Parameter p)	Return if a particular parameter of the exporter is enabled
void	setParameter(GmlExporter.Parameter p, boolean value)	Set the value of a parameter of the exporter
void	setVertexGraphicsAttributeProvider(Function<V,Map<String,Attribute>> vertexGraphicsAttributeProvider)	Set node craphics section provider

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

Field Detail

vertexGraphicsAttributeProvider

protected Optional<Function<V,Map<String,Attribute>>> vertexGraphicsAttributeProvider

Constructor Detail

GmlExporter

public GmlExporter()

Creates a new GmlExporter object with integer id providers for the vertex identifiers.

GmlExporter

public GmlExporter(Function<V,String> vertexIdProvider)

Constructs a new GmlExporter object with the given id providers.

Parameters:

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

Method Detail

exportGraph

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

Exports an graph into a plain text GML format.

Specified by:

exportGraph in interface GraphExporter<V,E>

Parameters:

writer - the writer

g - the graph

isParameter

public boolean isParameter(GmlExporter.Parameter p)

Return if a particular parameter of the exporter is enabled

Parameters:

p - the parameter

Returns:

true if the parameter is set, false otherwise

setParameter

public void setParameter(GmlExporter.Parameter p,
                         boolean value)

Set the value of a parameter of the exporter

Parameters:

p - the parameter

value - the value to set

setVertexGraphicsAttributeProvider

public void setVertexGraphicsAttributeProvider(Function<V,Map<String,Attribute>> vertexGraphicsAttributeProvider)

Set node craphics section provider

Parameters:

vertexGraphicsAttributeProvider - the graphics section attributes provider

getVertexGraphicsAttributes

protected Optional<Map<String,Attribute>> getVertexGraphicsAttributes(V v)