org.jgrapht.ext

Class GmlExporter<V,E>

java.lang.Object

org.jgrapht.ext.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 Object
implements GraphExporter<V,E>

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

For a description of the format see http://www. infosun.fmi.uni-passau.de/Graphlet/GML/.

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.

Author:

Dimitrios Michail

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	PRINT_EDGE_LABELS Deprecated.
static Integer	PRINT_EDGE_VERTEX_LABELS Deprecated.
static Integer	PRINT_NO_LABELS Deprecated.
static Integer	PRINT_VERTEX_LABELS Deprecated.

Constructor Summary

Constructors

Constructor and Description
GmlExporter() Creates a new GmlExporter object with integer name providers for the vertex and edge IDs and null providers for the vertex and edge labels.
GmlExporter(VertexNameProvider<V> vertexIDProvider, VertexNameProvider<V> vertexLabelProvider, EdgeNameProvider<E> edgeIDProvider, EdgeNameProvider<E> edgeLabelProvider) Constructs a new GmlExporter object with the given ID and label providers.

Method Summary

Modifier and Type	Method and Description
void	export(Writer writer, DirectedGraph<V,E> g) Deprecated.
void	export(Writer writer, UndirectedGraph<V,E> g) Deprecated.
void	exportGraph(Graph<V,E> g, Writer writer) Exports an graph into a plain text GML format.
Integer	getPrintLabels() Deprecated.
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	setPrintLabels(Integer i) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapht.ext.GraphExporter

exportGraph, exportGraph

Field Detail

PRINT_NO_LABELS

@Deprecated
public static final Integer PRINT_NO_LABELS

Deprecated.

Option to export no vertex or edge labels.

PRINT_EDGE_LABELS

@Deprecated
public static final Integer PRINT_EDGE_LABELS

Deprecated.

Option to export only the edge labels.

PRINT_EDGE_VERTEX_LABELS

@Deprecated
public static final Integer PRINT_EDGE_VERTEX_LABELS

Deprecated.

Option to export both edge and vertex labels.

PRINT_VERTEX_LABELS

@Deprecated
public static final Integer PRINT_VERTEX_LABELS

Deprecated.

Option to export only the vertex labels.

Constructor Detail

GmlExporter

public GmlExporter()

Creates a new GmlExporter object with integer name providers for the vertex and edge IDs and null providers for the vertex and edge labels.

GmlExporter

public GmlExporter(VertexNameProvider<V> vertexIDProvider,
                   VertexNameProvider<V> vertexLabelProvider,
                   EdgeNameProvider<E> edgeIDProvider,
                   EdgeNameProvider<E> edgeLabelProvider)

Constructs a new GmlExporter object with the given ID and label providers.

Parameters:

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

vertexLabelProvider - for generating vertex labels. If null, vertex labels will be generated using the toString() method of the vertex object.

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

edgeLabelProvider - for generating edge labels. If null, edge labels will be generated using the toString() method of the edge object.

Method Detail

export

@Deprecated
public void export(Writer writer,
                               UndirectedGraph<V,E> g)

Deprecated.

Exports an undirected graph into a plain text file in GML format.

Parameters:

writer - the writer to which the graph to be exported

g - the undirected graph to be exported

export

@Deprecated
public void export(Writer writer,
                               DirectedGraph<V,E> g)

Deprecated.

Exports a directed graph into a plain text file in GML format.

Parameters:

writer - the writer to which the graph to be exported

g - the directed graph to be exported

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

setPrintLabels

@Deprecated
public void setPrintLabels(Integer i)

Deprecated.

Set whether to export the vertex and edge labels. The default behavior is to export no vertex or edge labels.

Parameters:

i - What labels to export. Valid options are PRINT_NO_LABELS, PRINT_EDGE_LABELS, PRINT_EDGE_VERTEX_LABELS, and PRINT_VERTEX_LABELS.

Throws:

IllegalArgumentException - if a non-supported value is used

See Also:

PRINT_NO_LABELS, PRINT_EDGE_LABELS, PRINT_EDGE_VERTEX_LABELS, PRINT_VERTEX_LABELS

getPrintLabels

@Deprecated
public Integer getPrintLabels()

Deprecated.

Get whether to export the vertex and edge labels.

Returns:

One of the PRINT_NO_LABELS, PRINT_EDGE_LABELS, PRINT_EDGE_VERTEX_LABELS, or PRINT_VERTEX_LABELS.

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