com.tinkerpop.blueprints.util.io.graphson

Class GraphSONUtility

java.lang.Object

com.tinkerpop.blueprints.util.io.graphson.GraphSONUtility

public class GraphSONUtility
extends Object

Helps write individual graph elements to TinkerPop JSON format known as GraphSON.

Author:

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

Constructor Summary

Constructors

Constructor and Description
GraphSONUtility(GraphSONMode mode, ElementFactory factory) A GraphSONUtiltiy that includes all properties of vertices and edges.
GraphSONUtility(GraphSONMode mode, ElementFactory factory, ElementPropertyConfig config)
GraphSONUtility(GraphSONMode mode, ElementFactory factory, Set<String> vertexPropertyKeys, Set<String> edgePropertyKeys) A GraphSONUtility that includes the specified properties.

Method Summary

Methods

Modifier and Type	Method and Description
Edge	edgeFromJson(InputStream json, Vertex out, Vertex in) Creates an edge from GraphSON using settings supplied in the constructor.
static Edge	edgeFromJson(InputStream json, Vertex out, Vertex in, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Edge from JSON.
Edge	edgeFromJson(com.fasterxml.jackson.databind.JsonNode json, Vertex out, Vertex in) Creates an edge from GraphSON using settings supplied in the constructor.
static Edge	edgeFromJson(com.fasterxml.jackson.databind.JsonNode json, Vertex out, Vertex in, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Edge from JSON.
Edge	edgeFromJson(org.codehaus.jettison.json.JSONObject json, Vertex out, Vertex in) Creates an edge from GraphSON using settings supplied in the constructor.
static Edge	edgeFromJson(org.codehaus.jettison.json.JSONObject json, Vertex out, Vertex in, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Edge from JSON.
Edge	edgeFromJson(String json, Vertex out, Vertex in) Creates an edge from GraphSON using settings supplied in the constructor.
static Edge	edgeFromJson(String json, Vertex out, Vertex in, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Edge from JSON.
org.codehaus.jettison.json.JSONObject	jsonFromElement(Element element) Creates GraphSON for a single graph element.
static org.codehaus.jettison.json.JSONObject	jsonFromElement(Element element, Set<String> propertyKeys, GraphSONMode mode) Creates a Jettison JSONObject from a graph element.
com.fasterxml.jackson.databind.node.ObjectNode	objectNodeFromElement(Element element) Creates GraphSON for a single graph element.
static com.fasterxml.jackson.databind.node.ObjectNode	objectNodeFromElement(Element element, Set<String> propertyKeys, GraphSONMode mode) Creates a Jackson ObjectNode from a graph element.
Vertex	vertexFromJson(InputStream json) Creates a vertex from GraphSON using settings supplied in the constructor.
static Vertex	vertexFromJson(InputStream json, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Vertex from JSON.
Vertex	vertexFromJson(com.fasterxml.jackson.databind.JsonNode json) Creates a vertex from GraphSON using settings supplied in the constructor.
static Vertex	vertexFromJson(com.fasterxml.jackson.databind.JsonNode json, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Vertex from JSON.
Vertex	vertexFromJson(org.codehaus.jettison.json.JSONObject json) Creates a vertex from GraphSON using settings supplied in the constructor.
static Vertex	vertexFromJson(org.codehaus.jettison.json.JSONObject json, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Vertex from JSON.
Vertex	vertexFromJson(String json) Creates a vertex from GraphSON using settings supplied in the constructor.
static Vertex	vertexFromJson(String json, ElementFactory factory, GraphSONMode mode, Set<String> propertyKeys) Reads an individual Vertex from JSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphSONUtility

public GraphSONUtility(GraphSONMode mode,
               ElementFactory factory)

A GraphSONUtiltiy that includes all properties of vertices and edges.

GraphSONUtility

public GraphSONUtility(GraphSONMode mode,
               ElementFactory factory,
               Set<String> vertexPropertyKeys,
               Set<String> edgePropertyKeys)

A GraphSONUtility that includes the specified properties.

GraphSONUtility

public GraphSONUtility(GraphSONMode mode,
               ElementFactory factory,
               ElementPropertyConfig config)

Method Detail

vertexFromJson

public Vertex vertexFromJson(org.codehaus.jettison.json.JSONObject json)
                      throws IOException

Creates a vertex from GraphSON using settings supplied in the constructor.

Throws:

IOException

vertexFromJson

public Vertex vertexFromJson(String json)
                      throws IOException

Creates a vertex from GraphSON using settings supplied in the constructor.

Throws:

IOException

vertexFromJson

public Vertex vertexFromJson(InputStream json)
                      throws IOException

Creates a vertex from GraphSON using settings supplied in the constructor.

Throws:

IOException

vertexFromJson

public Vertex vertexFromJson(com.fasterxml.jackson.databind.JsonNode json)
                      throws IOException

Creates a vertex from GraphSON using settings supplied in the constructor.

Throws:

IOException

edgeFromJson

public Edge edgeFromJson(org.codehaus.jettison.json.JSONObject json,
                Vertex out,
                Vertex in)
                  throws IOException

Creates an edge from GraphSON using settings supplied in the constructor.

Throws:

IOException

edgeFromJson

public Edge edgeFromJson(String json,
                Vertex out,
                Vertex in)
                  throws IOException

Creates an edge from GraphSON using settings supplied in the constructor.

Throws:

IOException

edgeFromJson

public Edge edgeFromJson(InputStream json,
                Vertex out,
                Vertex in)
                  throws IOException

Creates an edge from GraphSON using settings supplied in the constructor.

Throws:

IOException

edgeFromJson

public Edge edgeFromJson(com.fasterxml.jackson.databind.JsonNode json,
                Vertex out,
                Vertex in)
                  throws IOException

Creates an edge from GraphSON using settings supplied in the constructor.

Throws:

IOException

jsonFromElement

public org.codehaus.jettison.json.JSONObject jsonFromElement(Element element)
                                                      throws org.codehaus.jettison.json.JSONException

Creates GraphSON for a single graph element.

Throws:

org.codehaus.jettison.json.JSONException

objectNodeFromElement

public com.fasterxml.jackson.databind.node.ObjectNode objectNodeFromElement(Element element)

Creates GraphSON for a single graph element.

vertexFromJson

public static Vertex vertexFromJson(org.codehaus.jettison.json.JSONObject json,
                    ElementFactory factory,
                    GraphSONMode mode,
                    Set<String> propertyKeys)
                             throws IOException

Reads an individual Vertex from JSON. The vertex must match the accepted GraphSON format.

Parameters:

json - a single vertex in GraphSON format as Jettison JSONObject

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include on reading of element properties

Throws:

IOException

vertexFromJson

public static Vertex vertexFromJson(String json,
                    ElementFactory factory,
                    GraphSONMode mode,
                    Set<String> propertyKeys)
                             throws IOException

Reads an individual Vertex from JSON. The vertex must match the accepted GraphSON format.

Parameters:

json - a single vertex in GraphSON format as a String.

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include on reading of element properties

Throws:

IOException

vertexFromJson

public static Vertex vertexFromJson(InputStream json,
                    ElementFactory factory,
                    GraphSONMode mode,
                    Set<String> propertyKeys)
                             throws IOException

Reads an individual Vertex from JSON. The vertex must match the accepted GraphSON format.

Parameters:

json - a single vertex in GraphSON format as an InputStream.

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include on reading of element properties

Throws:

IOException

vertexFromJson

public static Vertex vertexFromJson(com.fasterxml.jackson.databind.JsonNode json,
                    ElementFactory factory,
                    GraphSONMode mode,
                    Set<String> propertyKeys)
                             throws IOException

Reads an individual Vertex from JSON. The vertex must match the accepted GraphSON format.

Parameters:

json - a single vertex in GraphSON format as Jackson JsonNode

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include on reading of element properties

Throws:

IOException

edgeFromJson

public static Edge edgeFromJson(org.codehaus.jettison.json.JSONObject json,
                Vertex out,
                Vertex in,
                ElementFactory factory,
                GraphSONMode mode,
                Set<String> propertyKeys)
                         throws IOException

Reads an individual Edge from JSON. The edge must match the accepted GraphSON format.

Parameters:

json - a single edge in GraphSON format as a Jettison JSONObject

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include when reading of element properties

Throws:

IOException

edgeFromJson

public static Edge edgeFromJson(String json,
                Vertex out,
                Vertex in,
                ElementFactory factory,
                GraphSONMode mode,
                Set<String> propertyKeys)
                         throws IOException

Reads an individual Edge from JSON. The edge must match the accepted GraphSON format.

Parameters:

json - a single edge in GraphSON format as a String

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include when reading of element properties

Throws:

IOException

edgeFromJson

public static Edge edgeFromJson(InputStream json,
                Vertex out,
                Vertex in,
                ElementFactory factory,
                GraphSONMode mode,
                Set<String> propertyKeys)
                         throws IOException

Reads an individual Edge from JSON. The edge must match the accepted GraphSON format.

Parameters:

json - a single edge in GraphSON format as an InputStream

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include when reading of element properties

Throws:

IOException

edgeFromJson

public static Edge edgeFromJson(com.fasterxml.jackson.databind.JsonNode json,
                Vertex out,
                Vertex in,
                ElementFactory factory,
                GraphSONMode mode,
                Set<String> propertyKeys)
                         throws IOException

Reads an individual Edge from JSON. The edge must match the accepted GraphSON format.

Parameters:

json - a single edge in GraphSON format as a Jackson JsonNode

factory - the factory responsible for constructing graph elements

mode - the mode of the GraphSON

propertyKeys - a list of keys to include when reading of element properties

Throws:

IOException

jsonFromElement

public static org.codehaus.jettison.json.JSONObject jsonFromElement(Element element,
                                                    Set<String> propertyKeys,
                                                    GraphSONMode mode)
                                                             throws org.codehaus.jettison.json.JSONException

Creates a Jettison JSONObject from a graph element.

Parameters:

element - the graph element to convert to JSON.

propertyKeys - The property keys at the root of the element to serialize. If null, then all keys are serialized.

mode - the type of GraphSON to be generated.

Throws:

org.codehaus.jettison.json.JSONException

objectNodeFromElement

public static com.fasterxml.jackson.databind.node.ObjectNode objectNodeFromElement(Element element,
                                                                   Set<String> propertyKeys,
                                                                   GraphSONMode mode)

Creates a Jackson ObjectNode from a graph element.

Parameters:

element - the graph element to convert to JSON.

propertyKeys - The property keys at the root of the element to serialize. If null, then all keys are serialized.

mode - The type of GraphSON to generate.