com.tinkerpop.blueprints.util.io.graphson

Class GraphSONWriter

java.lang.Object

com.tinkerpop.blueprints.util.io.graphson.GraphSONWriter

public class GraphSONWriter
extends Object

GraphSONWriter writes a Graph to a TinkerPop JSON OutputStream.

Author:

Stephen Mallette

Constructor Summary

Constructors

Constructor and Description
GraphSONWriter(Graph graph)

Method Summary

Methods

Modifier and Type	Method and Description
static void	outputGraph(Graph graph, OutputStream jsonOutputStream) Write the data in a Graph to a JSON OutputStream.
static void	outputGraph(Graph graph, OutputStream jsonOutputStream, GraphSONMode mode) Write the data in a Graph to a JSON OutputStream.
static void	outputGraph(Graph graph, OutputStream jsonOutputStream, Set<String> vertexPropertyKeys, Set<String> edgePropertyKeys, GraphSONMode mode) Write the data in a Graph to a JSON OutputStream.
static void	outputGraph(Graph graph, String filename) Write the data in a Graph to a JSON OutputStream.
static void	outputGraph(Graph graph, String filename, GraphSONMode mode) Write the data in a Graph to a JSON OutputStream.
static void	outputGraph(Graph graph, String filename, Set<String> vertexPropertyKeys, Set<String> edgePropertyKeys, GraphSONMode mode) Write the data in a Graph to a JSON OutputStream.
void	outputGraph(OutputStream jsonOutputStream, Set<String> vertexPropertyKeys, Set<String> edgePropertyKeys, GraphSONMode mode) Write the data in a Graph to a JSON OutputStream.
void	outputGraph(OutputStream jsonOutputStream, Set<String> vertexPropertyKeys, Set<String> edgePropertyKeys, GraphSONMode mode, boolean normalize)
void	outputGraph(String filename, Set<String> vertexPropertyKeys, Set<String> edgePropertyKeys, GraphSONMode mode) Write the data in a Graph to a JSON OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphSONWriter

public GraphSONWriter(Graph graph)

Parameters:

graph - the Graph to pull the data from

Method Detail

outputGraph

public void outputGraph(String filename,
               Set<String> vertexPropertyKeys,
               Set<String> edgePropertyKeys,
               GraphSONMode mode)
                 throws IOException

Write the data in a Graph to a JSON OutputStream.

Parameters:

filename - the JSON file to write the Graph data to

vertexPropertyKeys - the keys of the vertex elements to write to JSON

edgePropertyKeys - the keys of the edge elements to write to JSON

mode - determines the format of the GraphSON

Throws:

IOException - thrown if there is an error generating the JSON data

outputGraph

public void outputGraph(OutputStream jsonOutputStream,
               Set<String> vertexPropertyKeys,
               Set<String> edgePropertyKeys,
               GraphSONMode mode)
                 throws IOException

Write the data in a Graph to a JSON OutputStream.

Parameters:

jsonOutputStream - the JSON OutputStream to write the Graph data to

vertexPropertyKeys - the keys of the vertex elements to write to JSON

edgePropertyKeys - the keys of the edge elements to write to JSON

mode - determines the format of the GraphSON

Throws:

IOException - thrown if there is an error generating the JSON data

outputGraph

public void outputGraph(OutputStream jsonOutputStream,
               Set<String> vertexPropertyKeys,
               Set<String> edgePropertyKeys,
               GraphSONMode mode,
               boolean normalize)
                 throws IOException

Throws:

IOException

outputGraph

public static void outputGraph(Graph graph,
               OutputStream jsonOutputStream)
                        throws IOException

Write the data in a Graph to a JSON OutputStream. All keys are written to JSON. Utilizing GraphSONMode.NORMAL.

Parameters:

graph - the graph to serialize to JSON

jsonOutputStream - the JSON OutputStream to write the Graph data to

Throws:

IOException - thrown if there is an error generating the JSON data

outputGraph

public static void outputGraph(Graph graph,
               String filename)
                        throws IOException

Write the data in a Graph to a JSON OutputStream. All keys are written to JSON. Utilizing GraphSONMode.NORMAL.

Parameters:

graph - the graph to serialize to JSON

filename - the JSON file to write the Graph data to

Throws:

IOException - thrown if there is an error generating the JSON data

outputGraph

public static void outputGraph(Graph graph,
               OutputStream jsonOutputStream,
               GraphSONMode mode)
                        throws IOException

Write the data in a Graph to a JSON OutputStream. All keys are written to JSON.

Parameters:

graph - the graph to serialize to JSON

jsonOutputStream - the JSON OutputStream to write the Graph data to

mode - determines the format of the GraphSON

Throws:

IOException - thrown if there is an error generating the JSON data

outputGraph

public static void outputGraph(Graph graph,
               String filename,
               GraphSONMode mode)
                        throws IOException

Write the data in a Graph to a JSON OutputStream. All keys are written to JSON.

Parameters:

graph - the graph to serialize to JSON

filename - the JSON file to write the Graph data to

mode - determines the format of the GraphSON

Throws:

IOException - thrown if there is an error generating the JSON data

outputGraph

public static void outputGraph(Graph graph,
               OutputStream jsonOutputStream,
               Set<String> vertexPropertyKeys,
               Set<String> edgePropertyKeys,
               GraphSONMode mode)
                        throws IOException

Write the data in a Graph to a JSON OutputStream.

Parameters:

graph - the graph to serialize to JSON

jsonOutputStream - the JSON OutputStream to write the Graph data to

vertexPropertyKeys - the keys of the vertex elements to write to JSON

edgePropertyKeys - the keys of the edge elements to write to JSON

mode - determines the format of the GraphSON

Throws:

IOException - thrown if there is an error generating the JSON data

outputGraph

public static void outputGraph(Graph graph,
               String filename,
               Set<String> vertexPropertyKeys,
               Set<String> edgePropertyKeys,
               GraphSONMode mode)
                        throws IOException

Write the data in a Graph to a JSON OutputStream.

Parameters:

graph - the graph to serialize to JSON

filename - the JSON file to write the Graph data to

vertexPropertyKeys - the keys of the vertex elements to write to JSON

edgePropertyKeys - the keys of the edge elements to write to JSON

mode - determines the format of the GraphSON

Throws:

IOException - thrown if there is an error generating the JSON data