org.jgrapht.io

Class DIMACSExporter<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

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

Exports a graph into DIMACS format.

For a description of the format see http://dimacs.rutgers.edu/Challenges. Note that there are a lot of different formats based on each different challenge, see DIMACSFormat for the supported formats. The exporter uses the DIMACSFormat.MAX_CLIQUE by default.

Since:

January 2017

Author:

Dimitrios Michail

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static DIMACSFormat	DEFAULT_DIMACS_FORMAT The default format used by the exporter.
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
DIMACSExporter() Constructs a new exporter.
DIMACSExporter(ComponentNameProvider<V> vertexIDProvider) Constructs a new exporter with a given vertex ID provider.
DIMACSExporter(ComponentNameProvider<V> vertexIDProvider, DIMACSFormat format) Constructs a new exporter with a given vertex ID provider.

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
DIMACSFormat	getFormat() Get the format of the exporter
ComponentNameProvider<V>	getVertexIDProvider() Get the vertex id provider
boolean	isParameter(DIMACSExporter.Parameter p) Return if a particular parameter of the exporter is enabled
void	setEdgeIDProvider(ComponentNameProvider<E> edgeIDProvider) Set the edge id provider.
void	setFormat(DIMACSFormat format) Set the format of the exporter
void	setParameter(DIMACSExporter.Parameter p, boolean value) Set the value of a parameter 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

DEFAULT_DIMACS_FORMAT

public static final DIMACSFormat DEFAULT_DIMACS_FORMAT

The default format used by the exporter.

vertexIDProvider

protected ComponentNameProvider<V> vertexIDProvider

Provides an identifier for a vertex.

edgeIDProvider

protected ComponentNameProvider<E> edgeIDProvider

Provides an identifier for an edge.

Constructor Detail

DIMACSExporter

public DIMACSExporter()

Constructs a new exporter.

DIMACSExporter

public DIMACSExporter(ComponentNameProvider<V> vertexIDProvider)

Constructs a new exporter with a given vertex ID provider.

Parameters:

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

DIMACSExporter

public DIMACSExporter(ComponentNameProvider<V> vertexIDProvider,
                      DIMACSFormat format)

Constructs a new exporter with a given vertex ID provider.

Parameters:

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

format - the format to use

Method Detail

exportGraph

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

Export a graph

Specified by:

exportGraph in interface GraphExporter<V,E>

Parameters:

g - the graph to export

writer - the output writer

isParameter

public boolean isParameter(DIMACSExporter.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(DIMACSExporter.Parameter p,
                         boolean value)

Set the value of a parameter of the exporter

Parameters:

p - the parameter

value - the value to set

getFormat

public DIMACSFormat getFormat()

Get the format of the exporter

Returns:

the format of the exporter

setFormat

public void setFormat(DIMACSFormat format)

Set the format of the exporter

Parameters:

format - the format to use

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.