org.apache.tinkerpop.gremlin.structure.io.graphson

Class GraphSONWriter

java.lang.Object

org.apache.tinkerpop.gremlin.structure.io.graphson.GraphSONWriter

All Implemented Interfaces:

GraphWriter

public class GraphSONWriter
extends Object
implements GraphWriter

A @{link GraphWriter} that writes a graph and its elements to a JSON-based representation. This implementation only supports JSON data types and is therefore lossy with respect to data types (e.g. a float will become a double). Further note that serialized Map objects do not support complex types for keys. Edge and Vertex objects are serialized to Map instances. If an Element is used as a key, it is coerced to its identifier. Other complex objects are converted via Object.toString() unless a mapper serializer is supplied.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphSONWriter.Builder

Method Summary

Modifier and Type	Method and Description
static GraphSONWriter.Builder	build()
void	writeEdge(OutputStream outputStream, Edge e) Write an edge to a stream.
void	writeGraph(OutputStream outputStream, Graph g) Write the entire graph to a stream.
void	writeVertex(OutputStream outputStream, Vertex v) Write a vertex to a stream without writing its edges.
void	writeVertex(OutputStream outputStream, Vertex v, Direction direction) Write a vertex to a stream with its associated edges.
void	writeVertices(OutputStream outputStream, Traversal<?,Vertex> traversal) Write a vertex to a stream without writing its edges.
void	writeVertices(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

writeGraph

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

Description copied from interface: GraphWriter

Write the entire graph to a stream.

Specified by:

writeGraph in interface GraphWriter

Throws:

IOException

writeVertex

public void writeVertex(OutputStream outputStream,
                        Vertex v,
                        Direction direction)
                 throws 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:

IOException

writeVertex

public void writeVertex(OutputStream outputStream,
                        Vertex v)
                 throws 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:

IOException

writeEdge

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

Description copied from interface: GraphWriter

Write an edge to a stream.

Specified by:

writeEdge in interface GraphWriter

Throws:

IOException

writeVertices

public void writeVertices(OutputStream outputStream,
                          Traversal<?,Vertex> traversal,
                          Direction direction)
                   throws 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:

IOException

writeVertices

public void writeVertices(OutputStream outputStream,
                          Traversal<?,Vertex> traversal)
                   throws 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:

IOException

build

public static GraphSONWriter.Builder build()