org.jgrapht.io

Class MatrixExporter<V,E>

java.lang.Object

org.jgrapht.io.MatrixExporter<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

public class MatrixExporter<V,E>
extends Object
implements GraphExporter<V,E>

Exports a graph to a plain text matrix format, which can be processed by matrix manipulation software, such as MTJ or MATLAB.

The exporter supports three different formats, see MatrixExporter.Format.

Author:

Charles Fry, Dimitrios Michail

See Also:

MatrixExporter.Format

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatrixExporter.Format Formats supported by the MatrixExporter exporter.

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentNameProvider<E>	edgeIDProvider Provides an identifier for an edge.
protected ComponentNameProvider<V>	vertexIDProvider Provides an identifier for a vertex.

Constructor Summary

Constructors

Constructor and Description
MatrixExporter() Creates a new MatrixExporter with integer name provider for the vertex identifiers and MatrixExporter.Format.SPARSE_ADJACENCY_MATRIX as the default format.
MatrixExporter(MatrixExporter.Format format) Creates a new MatrixExporter with integer name provider for the vertex identifiers.
MatrixExporter(MatrixExporter.Format format, ComponentNameProvider<V> vertexIDProvider) Creates a new MatrixExporter.

Method Summary

Modifier and Type	Method and Description
void	exportGraph(Graph<V,E> g, Writer writer) Export a graph
ComponentNameProvider<E>	getEdgeIDProvider() Get the edge id provider
MatrixExporter.Format	getFormat() Get the format that the exporter is using.
ComponentNameProvider<V>	getVertexIDProvider() Get the vertex id provider
void	setEdgeIDProvider(ComponentNameProvider<E> edgeIDProvider) Set the edge id provider.
void	setFormat(MatrixExporter.Format format) Set the output format of the exporter
void	setVertexIDProvider(ComponentNameProvider<V> vertexIDProvider) Set the vertex id provider

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapht.io.GraphExporter

exportGraph, exportGraph

Field Detail

vertexIDProvider

protected ComponentNameProvider<V> vertexIDProvider

Provides an identifier for a vertex.

edgeIDProvider

protected ComponentNameProvider<E> edgeIDProvider

Provides an identifier for an edge.

Constructor Detail

MatrixExporter

public MatrixExporter()

Creates a new MatrixExporter with integer name provider for the vertex identifiers and MatrixExporter.Format.SPARSE_ADJACENCY_MATRIX as the default format.

MatrixExporter

public MatrixExporter(MatrixExporter.Format format)

Creates a new MatrixExporter with integer name provider for the vertex identifiers.

Parameters:

format - format to use

MatrixExporter

public MatrixExporter(MatrixExporter.Format format,
                      ComponentNameProvider<V> vertexIDProvider)

Creates a new MatrixExporter.

Parameters:

format - format to use

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

Method Detail

getFormat

public MatrixExporter.Format getFormat()

Get the format that the exporter is using.

Returns:

the output format

setFormat

public void setFormat(MatrixExporter.Format format)

Set the output format of the exporter

Parameters:

format - the format to use

exportGraph

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

Description copied from interface: GraphExporter

Export a graph

Specified by:

exportGraph in interface GraphExporter<V,E>

Parameters:

g - the graph to export

writer - the output writer

Throws:

ExportException - in case any error occurs

getVertexIDProvider

public ComponentNameProvider<V> getVertexIDProvider()

Get the vertex id provider

Returns:

the vertex id provider

setVertexIDProvider

public void setVertexIDProvider(ComponentNameProvider<V> vertexIDProvider)

Set the vertex id provider

Parameters:

vertexIDProvider - the new vertex id provider. Must not be null.

getEdgeIDProvider

public ComponentNameProvider<E> getEdgeIDProvider()

Get the edge id provider

Returns:

The edge provider

setEdgeIDProvider

public void setEdgeIDProvider(ComponentNameProvider<E> edgeIDProvider)

Set the edge id provider.

Parameters:

edgeIDProvider - the new edge id provider. Must not be null.