com.tinkerpop.gremlin.structure.io.graphson

Class GraphSONReader

java.lang.Object

com.tinkerpop.gremlin.structure.io.graphson.GraphSONReader

All Implemented Interfaces:

GraphReader

public class GraphSONReader
extends java.lang.Object
implements GraphReader

A @{link GraphReader} that constructs a graph from a JSON-based representation of a graph and its elements. This implementation only supports JSON data types and is therefore lossy with respect to data types (e.g. a float will become a double, element IDs may not be retrieved in the format they were serialized, etc.). 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 there is a mapper serializer supplied.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphSONReader.Builder

Constructor Summary

Constructors

Constructor and Description
GraphSONReader(GraphSONMapper mapper, long batchSize, java.lang.String vertexIdKey, java.lang.String edgeIdKey)

Method Summary

Modifier and Type	Method and Description
static GraphSONReader.Builder	build()
Edge	readEdge(java.io.InputStream inputStream, java.util.function.Function<DetachedEdge,Edge> edgeMaker) Reads a single edge from an InputStream.
void	readGraph(java.io.InputStream inputStream, Graph graphToWriteTo) Reads an entire graph from an InputStream.
Vertex	readVertex(java.io.InputStream inputStream, Direction direction, java.util.function.Function<DetachedVertex,Vertex> vertexMaker, java.util.function.Function<DetachedEdge,Edge> edgeMaker) Reads a single vertex from an InputStream.
Vertex	readVertex(java.io.InputStream inputStream, java.util.function.Function<DetachedVertex,Vertex> vertexMaker) Reads a single vertex from an InputStream.
java.util.Iterator<Vertex>	readVertices(java.io.InputStream inputStream, Direction direction, java.util.function.Function<DetachedVertex,Vertex> vertexMaker, java.util.function.Function<DetachedEdge,Edge> edgeMaker) Reads a set of vertices from an InputStream which were written by GraphWriter.writeVertices(java.io.OutputStream, com.tinkerpop.gremlin.process.Traversal).

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphSONReader

public GraphSONReader(GraphSONMapper mapper,
                      long batchSize,
                      java.lang.String vertexIdKey,
                      java.lang.String edgeIdKey)

Method Detail

readGraph

public void readGraph(java.io.InputStream inputStream,
                      Graph graphToWriteTo)
               throws java.io.IOException

Description copied from interface: GraphReader

Reads an entire graph from an InputStream.

Specified by:

readGraph in interface GraphReader

Parameters:

inputStream - a stream containing a single vertex as defined by the accompanying GraphWriter

Throws:

java.io.IOException

readVertices

public java.util.Iterator<Vertex> readVertices(java.io.InputStream inputStream,
                                               Direction direction,
                                               java.util.function.Function<DetachedVertex,Vertex> vertexMaker,
                                               java.util.function.Function<DetachedEdge,Edge> edgeMaker)
                                        throws java.io.IOException

Description copied from interface: GraphReader

Reads a set of vertices from an InputStream which were written by GraphWriter.writeVertices(java.io.OutputStream, com.tinkerpop.gremlin.process.Traversal). This method will read vertex properties as well as edges given the direction supplied as an argument.

Specified by:

readVertices in interface GraphReader

Parameters:

inputStream - a stream containing a single vertex as defined by the accompanying GraphWriter

direction - the direction of edges to read.

vertexMaker - a function to create a vertex where the first argument is the vertex identifier, the second argument is vertex label and the last is the list of properties for it

edgeMaker - a function that creates an edge from the stream where the first argument is the edge identifier, the second argument is the out vertex id, the third is the in vertex id, the fourth is the label, and the fifth is the list of properties as key/value pairs.

Throws:

java.io.IOException

readEdge

public Edge readEdge(java.io.InputStream inputStream,
                     java.util.function.Function<DetachedEdge,Edge> edgeMaker)
              throws java.io.IOException

Description copied from interface: GraphReader

Reads a single edge from an InputStream.

Specified by:

readEdge in interface GraphReader

Parameters:

inputStream - a stream containing a single vertex as defined by the accompanying GraphWriter

edgeMaker - a function that creates an edge from the stream where the first argument is the edge identifier, the second argument is the out vertex id, the third is the in vertex id, the fourth is the label, and the fifth is the list of properties as key/value pairs.

Throws:

java.io.IOException

readVertex

public Vertex readVertex(java.io.InputStream inputStream,
                         java.util.function.Function<DetachedVertex,Vertex> vertexMaker)
                  throws java.io.IOException

Description copied from interface: GraphReader

Reads a single vertex from an InputStream. This method will read vertex properties but not edges.

Specified by:

readVertex in interface GraphReader

Parameters:

inputStream - a stream containing a single vertex as defined by the accompanying GraphWriter

vertexMaker - a function to create a vertex where the first argument is the vertex identifier, the second argument is vertex label and the last is the list of properties for it

Throws:

java.io.IOException

readVertex

public Vertex readVertex(java.io.InputStream inputStream,
                         Direction direction,
                         java.util.function.Function<DetachedVertex,Vertex> vertexMaker,
                         java.util.function.Function<DetachedEdge,Edge> edgeMaker)
                  throws java.io.IOException

Description copied from interface: GraphReader

Reads a single vertex from an InputStream. This method will read vertex properties as well as edges given the direction supplied as an argument.

Specified by:

readVertex in interface GraphReader

Parameters:

inputStream - a stream containing a single vertex as defined by the accompanying GraphWriter

direction - the direction of edges to read.

vertexMaker - a function to create a vertex where the first argument is the vertex identifier, the second argument is vertex label and the last is the list of properties for it

edgeMaker - a function that creates an edge from the stream where the first argument is the edge identifier, the second argument is the out vertex id, the third is the in vertex id, the fourth is the label, and the fifth is the list of properties as key/value pairs.

Throws:

java.io.IOException

build

public static GraphSONReader.Builder build()