org.jgrapht.io

Class CSVExporter<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

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

Exports a graph into a CSV Format or any other Delimiter-separated value format.

The exporter supports three different formats which can be adjusted using the setFormat method. The supported formats are the same CSV formats used by Gephi . For some of the formats, the behavior of the exporter can be adjusted using the setParameter method. See CSVFormat for a description of the formats.

The default output respects rfc4180. The caller can also adjust the separator to something like semicolon or pipe instead of comma. In such a case, all fields are escaped using the new separator. See Delimiter- separated values for more information.

Since:

August 2016

Author:

Dimitrios Michail

See Also:

CSVFormat

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
CSVExporter() Creates a new CSVExporter with CSVFormat.ADJACENCY_LIST format and integer name provider for the vertices.
CSVExporter(ComponentNameProvider<V> vertexIDProvider, CSVFormat format, char delimiter) Constructs a new CSVExporter with the given ID providers and format.
CSVExporter(CSVFormat format) Creates a new CSVExporter with integer name providers for the vertices.
CSVExporter(CSVFormat format, char delimiter) Creates a new CSVExporter with integer name providers for the vertices.

Method Summary

Modifier and Type	Method and Description
void	exportGraph(Graph<V,E> g, Writer writer) Exports a graph
char	getDelimiter() Get the delimiter (comma, semicolon, pipe, etc).
ComponentNameProvider<E>	getEdgeIDProvider() Get the edge id provider
CSVFormat	getFormat() Get the format of the exporter
ComponentNameProvider<V>	getVertexIDProvider() Get the vertex id provider
boolean	isParameter(CSVFormat.Parameter p) Return if a particular parameter of the exporter is enabled
void	setDelimiter(char delimiter) Set the delimiter (comma, semicolon, pipe, etc).
void	setEdgeIDProvider(ComponentNameProvider<E> edgeIDProvider) Set the edge id provider.
void	setFormat(CSVFormat format) Set the format of the exporter
void	setParameter(CSVFormat.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

vertexIDProvider

protected ComponentNameProvider<V> vertexIDProvider

Provides an identifier for a vertex.

edgeIDProvider

protected ComponentNameProvider<E> edgeIDProvider

Provides an identifier for an edge.

Constructor Detail

CSVExporter

public CSVExporter()

Creates a new CSVExporter with CSVFormat.ADJACENCY_LIST format and integer name provider for the vertices.

CSVExporter

public CSVExporter(CSVFormat format)

Creates a new CSVExporter with integer name providers for the vertices.

Parameters:

format - the format to use

CSVExporter

public CSVExporter(CSVFormat format,
                   char delimiter)

Creates a new CSVExporter with integer name providers for the vertices.

Parameters:

format - the format to use

delimiter - delimiter to use

CSVExporter

public CSVExporter(ComponentNameProvider<V> vertexIDProvider,
                   CSVFormat format,
                   char delimiter)

Constructs a new CSVExporter with the given ID providers and format.

Parameters:

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

format - the format to use

delimiter - delimiter to use

Method Detail

exportGraph

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

Exports a graph

Specified by:

exportGraph in interface GraphExporter<V,E>

Parameters:

g - the graph

writer - the writer

isParameter

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

Set the value of a parameter of the exporter

Parameters:

p - the parameter

value - the value to set

getFormat

public CSVFormat getFormat()

Get the format of the exporter

Returns:

the format of the exporter

setFormat

public void setFormat(CSVFormat format)

Set the format of the exporter

Parameters:

format - the format to use

getDelimiter

public char getDelimiter()

Get the delimiter (comma, semicolon, pipe, etc).

Returns:

the delimiter

setDelimiter

public void setDelimiter(char delimiter)

Set the delimiter (comma, semicolon, pipe, etc).

Parameters:

delimiter - the delimiter 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.