org.apache.tinkerpop.gremlin.structure.io

Interface GraphReader

All Known Implementing Classes:

GraphMLReader, GraphSONReader, GryoReader, LegacyGraphSONReader

public interface GraphReader

Functions for reading a graph and its graph elements from a different format.

Author:

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

Method Summary

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

Method Detail

readGraph

void readGraph(InputStream inputStream,
               Graph graphToWriteTo)
        throws IOException

Reads an entire graph from an InputStream.

Parameters:

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

Throws:

IOException

readVertex

Vertex readVertex(InputStream inputStream,
                  Function<DetachedVertex,Vertex> vertexMaker)
           throws IOException

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

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:

IOException

readVertex

Vertex readVertex(InputStream inputStream,
                  Direction direction,
                  Function<DetachedVertex,Vertex> vertexMaker,
                  Function<DetachedEdge,Edge> edgeMaker)
           throws IOException

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

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:

IOException

readVertices

Iterator<Vertex> readVertices(InputStream inputStream,
                              Direction direction,
                              Function<DetachedVertex,Vertex> vertexMaker,
                              Function<DetachedEdge,Edge> edgeMaker)
                       throws IOException

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

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:

IOException

readEdge

Edge readEdge(InputStream inputStream,
              Function<DetachedEdge,Edge> edgeMaker)
       throws IOException

Reads a single edge from an InputStream.

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:

IOException