com.tinkerpop.blueprints.util.io.gml

Class GMLWriter

java.lang.Object

com.tinkerpop.blueprints.util.io.gml.GMLWriter

public class GMLWriter
extends Object

GMLWriter writes a Graph to a GML OutputStream. GML definition taken from (http://www.fim.uni-passau.de/fileadmin/files/lehrstuhl/brandenburg/projekte/gml/gml-documentation.tar.gz)

Author:

Stuart Hendren (http://stuarthendren.net)

Constructor Summary

Constructors

Constructor and Description
GMLWriter(Graph graph)

Method Summary

Methods

Modifier and Type	Method and Description
static void	outputGraph(Graph graph, OutputStream graphMLOutputStream) Write the data in a Graph to a GML OutputStream.
static void	outputGraph(Graph graph, String filename) Write the data in a Graph to a GML OutputStream.
void	outputGraph(OutputStream gMLOutputStream) Write the data in a Graph to a GML OutputStream.
void	outputGraph(String filename) Write the data in a Graph to a GML OutputStream.
void	setEdgeIdKey(String edgeIdKey)
void	setNormalize(boolean normalize)
void	setStrict(boolean strict)
void	setUseId(boolean useId)
void	setVertexIdKey(String vertexIdKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

GMLWriter

public GMLWriter(Graph graph)

Parameters:

graph - the Graph to pull the data from

Method Detail

setStrict

public void setStrict(boolean strict)

Parameters:

strict - when set to true, property keys in the graph that do not meet the exact guidelines of the GML specification are ignored. By default this value is false.

setNormalize

public void setNormalize(boolean normalize)

Parameters:

normalize - whether to normalize the output. Normalized output is deterministic with respect to the order of elements and properties in the resulting XML document, and is compatible with line diff-based tools such as Git. Note: normalized output is memory-intensive and is not appropriate for very large graphs.

setUseId

public void setUseId(boolean useId)

Parameters:

useId - whether to use the blueprints id directly or substitute with a generated integer. To use this option the blueprints ids must all be Integers of String representations of integers

setVertexIdKey

public void setVertexIdKey(String vertexIdKey)

Parameters:

vertexIdKey - gml property to use for the blueprints vertex id, defaults to GMLTokens.BLUEPRINTS_ID

setEdgeIdKey

public void setEdgeIdKey(String edgeIdKey)

Parameters:

edgeIdKey - gml property to use for the blueprints edges id, defaults to GMLTokens.BLUEPRINTS_ID

outputGraph

public void outputGraph(String filename)
                 throws IOException

Write the data in a Graph to a GML OutputStream.

Parameters:

filename - the GML file to write the Graph data to

Throws:

IOException - thrown if there is an error generating the GML data

outputGraph

public void outputGraph(OutputStream gMLOutputStream)
                 throws IOException

Write the data in a Graph to a GML OutputStream.

Parameters:

gMLOutputStream - the GML OutputStream to write the Graph data to

Throws:

IOException - thrown if there is an error generating the GML data

outputGraph

public static void outputGraph(Graph graph,
               OutputStream graphMLOutputStream)
                        throws IOException

Write the data in a Graph to a GML OutputStream.

Parameters:

graph - the Graph to pull the data from

graphMLOutputStream - the GML OutputStream to write the Graph data to

Throws:

IOException - thrown if there is an error generating the GML data

outputGraph

public static void outputGraph(Graph graph,
               String filename)
                        throws IOException

Write the data in a Graph to a GML OutputStream.

Parameters:

graph - the Graph to pull the data from

filename - the GML file to write the Graph data to

Throws:

IOException - thrown if there is an error generating the GML data