org.apache.tinkerpop.gremlin.structure.io

Interface GraphWriter

All Known Implementing Classes:

GraphMLWriter, GraphSONWriter, GryoWriter

public interface GraphWriter

Functions for writing a graph and its elements to a different format.

Author:

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

Method Summary

Modifier and Type	Method and Description
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.
default void	writeVertices(OutputStream outputStream, Traversal<?,Vertex> traversal) Write a vertex to a stream without writing its edges.
default void	writeVertices(OutputStream outputStream, Traversal<?,Vertex> traversal, Direction direction) Write a list of vertices from a Traversal to a stream with its associated edges.

Method Detail

writeGraph

void writeGraph(OutputStream outputStream,
                Graph g)
         throws IOException

Write the entire graph to a stream.

Throws:

IOException

writeVertex

void writeVertex(OutputStream outputStream,
                 Vertex v,
                 Direction direction)
          throws IOException

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

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

void writeVertex(OutputStream outputStream,
                 Vertex v)
          throws IOException

Write a vertex to a stream without writing its edges.

Parameters:

outputStream - The stream to write to.

v - The vertex to write.

Throws:

IOException

writeVertices

default void writeVertices(OutputStream outputStream,
                           Traversal<?,Vertex> traversal,
                           Direction direction)
                    throws IOException

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

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

default void writeVertices(OutputStream outputStream,
                           Traversal<?,Vertex> traversal)
                    throws IOException

Write a vertex to a stream without writing its edges.

Parameters:

outputStream - The stream to write to.

traversal - A traversal that returns a list of vertices.

Throws:

IOException

writeEdge

void writeEdge(OutputStream outputStream,
               Edge e)
        throws IOException

Write an edge to a stream.

Throws:

IOException