org.jgrapht.ext

Class GraphMLExporter<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

Deprecated.

Use GraphMLExporter instead.

@Deprecated
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 Deprecated. Use attribute support from GraphMLExporter instead.
static class	GraphMLExporter.AttributeType Deprecated. Use attribute support from GraphMLExporter instead.

Constructor Summary

Constructors

Constructor and Description
GraphMLExporter() Deprecated. 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) Deprecated. Constructs a new GraphMLExporter.
GraphMLExporter(ComponentNameProvider<V> vertexIDProvider, ComponentNameProvider<V> vertexLabelProvider, ComponentNameProvider<E> edgeIDProvider, ComponentNameProvider<E> edgeLabelProvider) Deprecated. Constructs a new GraphMLExporter.

Method Summary

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

exportGraph, exportGraph

Constructor Detail

GraphMLExporter

public GraphMLExporter()

Deprecated.

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)

Deprecated.

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)

Deprecated.

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,
                              GraphMLExporter.AttributeType type)

Deprecated.

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,
                              GraphMLExporter.AttributeType type,
                              String defaultValue)

Deprecated.

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)

Deprecated.

Unregister a GraphML-Attribute

Parameters:

name - the attribute name

isExportEdgeWeights

public boolean isExportEdgeWeights()

Deprecated.

Whether the exporter will print edge weights.

Returns:

true if the exporter prints edge weights, false otherwise

setExportEdgeWeights

public void setExportEdgeWeights(boolean exportEdgeWeights)

Deprecated.

Set whether the exporter will print edge weights.

Parameters:

exportEdgeWeights - value to set

getVertexLabelAttributeName

public String getVertexLabelAttributeName()

Deprecated.

Get the attribute name for vertex labels

Returns:

the attribute name

setVertexLabelAttributeName

public void setVertexLabelAttributeName(String vertexLabelAttributeName)

Deprecated.

Set the attribute name to use for vertex labels.

Parameters:

vertexLabelAttributeName - the attribute name

getEdgeLabelAttributeName

public String getEdgeLabelAttributeName()

Deprecated.

Get the attribute name for edge labels

Returns:

the attribute name

setEdgeLabelAttributeName

public void setEdgeLabelAttributeName(String edgeLabelAttributeName)

Deprecated.

Set the attribute name to use for edge labels.

Parameters:

edgeLabelAttributeName - the attribute name

getEdgeWeightAttributeName

public String getEdgeWeightAttributeName()

Deprecated.

Get the attribute name for edge weights

Returns:

the attribute name

setEdgeWeightAttributeName

public void setEdgeWeightAttributeName(String edgeWeightAttributeName)

Deprecated.

Set the attribute name to use for edge weights.

Parameters:

edgeWeightAttributeName - the attribute name

getVertexLabelProvider

public ComponentNameProvider<V> getVertexLabelProvider()

Deprecated.

Get the vertex label provider

Returns:

the vertex label provider

setVertexLabelProvider

public void setVertexLabelProvider(ComponentNameProvider<V> vertexLabelProvider)

Deprecated.

Set the vertex label provider.

Parameters:

vertexLabelProvider - the vertex label provider to set

getEdgeLabelProvider

public ComponentNameProvider<E> getEdgeLabelProvider()

Deprecated.

Get the edge label provider

Returns:

the edge label provider

setEdgeLabelProvider

public void setEdgeLabelProvider(ComponentNameProvider<E> edgeLabelProvider)

Deprecated.

Set the edge label provider.

Parameters:

edgeLabelProvider - the edge label provider to set

getVertexAttributeProvider

public ComponentAttributeProvider<V> getVertexAttributeProvider()

Deprecated.

Get the vertex attribute provider

Returns:

the vertex attribute provider

setVertexAttributeProvider

public void setVertexAttributeProvider(ComponentAttributeProvider<V> vertexAttributeProvider)

Deprecated.

Set the vertex attribute provider.

Parameters:

vertexAttributeProvider - the vertex attribute provider to set

getEdgeAttributeProvider

public ComponentAttributeProvider<E> getEdgeAttributeProvider()

Deprecated.

Get the edge attribute provider

Returns:

the edge attribute provider

setEdgeAttributeProvider

public void setEdgeAttributeProvider(ComponentAttributeProvider<E> edgeAttributeProvider)

Deprecated.

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

Deprecated.

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