com.tinkerpop.blueprints.util.io.graphml

Class GraphMLWriter

java.lang.Object

com.tinkerpop.blueprints.util.io.graphml.GraphMLWriter

public class GraphMLWriter
extends Object

GraphMLWriter writes a Graph to a GraphML OutputStream.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Joshua Shinavier (http://fortytwo.net), Stephen Mallette (http://stephen.genoprime.com)

Constructor Summary

Constructors

Constructor and Description
GraphMLWriter(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 GraphML OutputStream.
static void	outputGraph(Graph graph, OutputStream graphMLOutputStream, Map<String,String> vertexKeyTypes, Map<String,String> edgeKeyTypes) Write the data in a Graph to a GraphML OutputStream.
static void	outputGraph(Graph graph, String filename) Write the data in a Graph to a GraphML file.
static void	outputGraph(Graph graph, String filename, Map<String,String> vertexKeyTypes, Map<String,String> edgeKeyTypes) Write the data in a Graph to a GraphML file.
void	outputGraph(OutputStream graphMLOutputStream) Write the data in a Graph to a GraphML OutputStream.
void	outputGraph(String filename) Write the data in a Graph to a GraphML file.
void	setEdgeKeyTypes(Map<String,String> edgeKeyTypes)
void	setEdgeLabelKey(String edgeLabelKey) Set the name of the edge label in the GraphML.
void	setNormalize(boolean normalize)
void	setVertexKeyTypes(Map<String,String> vertexKeyTypes)
void	setXmlSchemaLocation(String xmlSchemaLocation)

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphMLWriter

public GraphMLWriter(Graph graph)

Parameters:

graph - the Graph to pull the data from

Method Detail

setXmlSchemaLocation

public void setXmlSchemaLocation(String xmlSchemaLocation)

Parameters:

xmlSchemaLocation - the location of the GraphML XML Schema instance

setEdgeLabelKey

public void setEdgeLabelKey(String edgeLabelKey)

Set the name of the edge label in the GraphML. When this value is not set the value of the Edge.getLabel() is written as a "label" attribute on the edge element. This does not validate against the GraphML schema. If this value is set then the the value of Edge.getLabel() is written as a data element on the edge and the appropriate key element is added to define it in the GraphML

Parameters:

edgeLabelKey - if the label of an edge will be handled by the data property.

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.

setVertexKeyTypes

public void setVertexKeyTypes(Map<String,String> vertexKeyTypes)

Parameters:

vertexKeyTypes - a Map of the data types of the vertex keys

setEdgeKeyTypes

public void setEdgeKeyTypes(Map<String,String> edgeKeyTypes)

Parameters:

edgeKeyTypes - a Map of the data types of the edge keys

outputGraph

public void outputGraph(String filename)
                 throws IOException

Write the data in a Graph to a GraphML file.

Parameters:

filename - the name of the file write the Graph data (as GraphML) to

Throws:

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

outputGraph

public void outputGraph(OutputStream graphMLOutputStream)
                 throws IOException

Write the data in a Graph to a GraphML OutputStream.

Parameters:

graphMLOutputStream - the GraphML OutputStream to write the Graph data to

Throws:

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

outputGraph

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

Write the data in a Graph to a GraphML OutputStream.

Parameters:

graph - the Graph to pull the data from

graphMLOutputStream - the GraphML OutputStream to write the Graph data to

Throws:

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

outputGraph

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

Write the data in a Graph to a GraphML file.

Parameters:

graph - the Graph to pull the data from

filename - the name of the file write the Graph data (as GraphML) to

Throws:

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

outputGraph

public static void outputGraph(Graph graph,
               String filename,
               Map<String,String> vertexKeyTypes,
               Map<String,String> edgeKeyTypes)
                        throws IOException

Write the data in a Graph to a GraphML file.

Parameters:

graph - the Graph to pull the data from

filename - the name of the file write the Graph data (as GraphML) to

vertexKeyTypes - a Map of the data types of the vertex keys

edgeKeyTypes - a Map of the data types of the edge keys

Throws:

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

outputGraph

public static void outputGraph(Graph graph,
               OutputStream graphMLOutputStream,
               Map<String,String> vertexKeyTypes,
               Map<String,String> edgeKeyTypes)
                        throws IOException

Write the data in a Graph to a GraphML OutputStream.

Parameters:

graph - the Graph to pull the data from

graphMLOutputStream - the GraphML OutputStream to write the Graph data to

vertexKeyTypes - a Map of the data types of the vertex keys

edgeKeyTypes - a Map of the data types of the edge keys

Throws:

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