com.tinkerpop.gremlin.structure.io.graphml

Class GraphMLWriter

java.lang.Object

com.tinkerpop.gremlin.structure.io.graphml.GraphMLWriter

All Implemented Interfaces:

GraphWriter

public class GraphMLWriter
extends java.lang.Object
implements GraphWriter

GraphMLWriter writes a Graph to a GraphML OutputStream. Note that this format is lossy, in the sense that data types and features of Gremlin Structure not supported by GraphML are not serialized. This format is meant for external export of a graph to tools outside of Gremlin Structure graphs. Note that GraphML does not support the notion of multi-properties or properties on properties and will throw an exception when writing a graph elements that have such things.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphMLWriter.Builder

Method Summary

Modifier and Type	Method and Description
static GraphMLWriter.Builder	build()
void	writeEdge(java.io.OutputStream outputStream, Edge e) Write an edge to a stream.
void	writeGraph(java.io.OutputStream outputStream, Graph g) Write the data in a Graph to a GraphML OutputStream.
void	writeVertex(java.io.OutputStream outputStream, Vertex v) Write a vertex to a stream without writing its edges.
void	writeVertex(java.io.OutputStream outputStream, Vertex v, Direction direction) Write a vertex to a stream with its associated edges.
void	writeVertices(java.io.OutputStream outputStream, Traversal<?,Vertex> traversal) Write a vertex to a stream without writing its edges.
void	writeVertices(java.io.OutputStream outputStream, Traversal<?,Vertex> traversal, Direction direction) Write a list of vertices from a Traversal to a stream with its associated edges.

Methods inherited from class java.lang.Object

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

Method Detail

writeVertex

public void writeVertex(java.io.OutputStream outputStream,
                        Vertex v,
                        Direction direction)
                 throws java.io.IOException

Description copied from interface: GraphWriter

Write a vertex to a stream with its associated edges. Only write edges as defined by the requested direction.

Specified by:

writeVertex in interface GraphWriter

Parameters:

outputStream - The stream to write to.

v - The vertex to write.

direction - If direction is null then no edges are written.

Throws:

java.io.IOException

writeVertex

public void writeVertex(java.io.OutputStream outputStream,
                        Vertex v)
                 throws java.io.IOException

Description copied from interface: GraphWriter

Write a vertex to a stream without writing its edges.

Specified by:

writeVertex in interface GraphWriter

Parameters:

outputStream - The stream to write to.

v - The vertex to write.

Throws:

java.io.IOException

writeEdge

public void writeEdge(java.io.OutputStream outputStream,
                      Edge e)
               throws java.io.IOException

Description copied from interface: GraphWriter

Write an edge to a stream.

Specified by:

writeEdge in interface GraphWriter

Throws:

java.io.IOException

writeVertices

public void writeVertices(java.io.OutputStream outputStream,
                          Traversal<?,Vertex> traversal,
                          Direction direction)
                   throws java.io.IOException

Description copied from interface: GraphWriter

Write a list of vertices from a Traversal to a stream with its associated edges. Only write edges as defined by the requested direction.

Specified by:

writeVertices in interface GraphWriter

Parameters:

outputStream - The stream to write to.

traversal - A traversal that returns a list of vertices.

direction - If direction is null then no edges are written.

Throws:

java.io.IOException

writeVertices

public void writeVertices(java.io.OutputStream outputStream,
                          Traversal<?,Vertex> traversal)
                   throws java.io.IOException

Description copied from interface: GraphWriter

Write a vertex to a stream without writing its edges.

Specified by:

writeVertices in interface GraphWriter

Parameters:

outputStream - The stream to write to.

traversal - A traversal that returns a list of vertices.

Throws:

java.io.IOException

writeGraph

public void writeGraph(java.io.OutputStream outputStream,
                       Graph g)
                throws java.io.IOException

Write the data in a Graph to a GraphML OutputStream.

Specified by:

writeGraph in interface GraphWriter

Parameters:

outputStream - the GraphML OutputStream to write the Graph data to

Throws:

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

build

public static GraphMLWriter.Builder build()