com.orientechnologies.orient.graph.graphml

Class OGraphSONUtility

java.lang.Object

com.orientechnologies.orient.graph.graphml.OGraphSONUtility

public class OGraphSONUtility
extends java.lang.Object

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

Author:

Stephen Mallette (http://stephen.genoprime.com), Luca Garulli (l.garulli--(at)--orientdb.com)

Constructor Summary

Constructors

Constructor and Description
OGraphSONUtility(com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode, com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory) A GraphSONUtiltiy that includes all properties of vertices and edges.
OGraphSONUtility(com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode, com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory, com.tinkerpop.blueprints.util.io.graphson.ElementPropertyConfig config)
OGraphSONUtility(com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode, com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory, java.util.Set<java.lang.String> vertexPropertyKeys, java.util.Set<java.lang.String> edgePropertyKeys) A GraphSONUtility that includes the specified properties.

Method Summary

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

OGraphSONUtility

public OGraphSONUtility(com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                        com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory)

A GraphSONUtiltiy that includes all properties of vertices and edges.

OGraphSONUtility

public OGraphSONUtility(com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                        com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                        java.util.Set<java.lang.String> vertexPropertyKeys,
                        java.util.Set<java.lang.String> edgePropertyKeys)

A GraphSONUtility that includes the specified properties.

OGraphSONUtility

public OGraphSONUtility(com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                        com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                        com.tinkerpop.blueprints.util.io.graphson.ElementPropertyConfig config)

Method Detail

vertexFromJson

public com.tinkerpop.blueprints.Vertex vertexFromJson(org.codehaus.jettison.json.JSONObject json)
                                               throws java.io.IOException

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

Throws:

java.io.IOException

vertexFromJson

public com.tinkerpop.blueprints.Vertex vertexFromJson(java.lang.String json)
                                               throws java.io.IOException

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

Throws:

java.io.IOException

vertexFromJson

public com.tinkerpop.blueprints.Vertex vertexFromJson(java.io.InputStream json)
                                               throws java.io.IOException

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

Throws:

java.io.IOException

vertexFromJson

public com.tinkerpop.blueprints.Vertex vertexFromJson(com.fasterxml.jackson.databind.JsonNode json)
                                               throws java.io.IOException

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

Throws:

java.io.IOException

edgeFromJson

public com.tinkerpop.blueprints.Edge edgeFromJson(org.codehaus.jettison.json.JSONObject json,
                                                  com.tinkerpop.blueprints.Vertex out,
                                                  com.tinkerpop.blueprints.Vertex in)
                                           throws java.io.IOException

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

Throws:

java.io.IOException

edgeFromJson

public com.tinkerpop.blueprints.Edge edgeFromJson(java.lang.String json,
                                                  com.tinkerpop.blueprints.Vertex out,
                                                  com.tinkerpop.blueprints.Vertex in)
                                           throws java.io.IOException

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

Throws:

java.io.IOException

edgeFromJson

public com.tinkerpop.blueprints.Edge edgeFromJson(java.io.InputStream json,
                                                  com.tinkerpop.blueprints.Vertex out,
                                                  com.tinkerpop.blueprints.Vertex in)
                                           throws java.io.IOException

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

Throws:

java.io.IOException

edgeFromJson

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

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

Throws:

java.io.IOException

jsonFromElement

public org.codehaus.jettison.json.JSONObject jsonFromElement(com.tinkerpop.blueprints.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(com.tinkerpop.blueprints.Element element)

Creates GraphSON for a single graph element.

vertexFromJson

public static com.tinkerpop.blueprints.Vertex vertexFromJson(org.codehaus.jettison.json.JSONObject json,
                                                             com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                             com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                             java.util.Set<java.lang.String> propertyKeys)
                                                      throws java.io.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:

java.io.IOException

vertexFromJson

public static com.tinkerpop.blueprints.Vertex vertexFromJson(java.lang.String json,
                                                             com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                             com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                             java.util.Set<java.lang.String> propertyKeys)
                                                      throws java.io.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:

java.io.IOException

vertexFromJson

public static com.tinkerpop.blueprints.Vertex vertexFromJson(java.io.InputStream json,
                                                             com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                             com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                             java.util.Set<java.lang.String> propertyKeys)
                                                      throws java.io.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:

java.io.IOException

vertexFromJson

public static com.tinkerpop.blueprints.Vertex vertexFromJson(com.fasterxml.jackson.databind.JsonNode json,
                                                             com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                             com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                             java.util.Set<java.lang.String> propertyKeys)
                                                      throws java.io.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:

java.io.IOException

edgeFromJson

public static com.tinkerpop.blueprints.Edge edgeFromJson(org.codehaus.jettison.json.JSONObject json,
                                                         com.tinkerpop.blueprints.Vertex out,
                                                         com.tinkerpop.blueprints.Vertex in,
                                                         com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                         com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                         java.util.Set<java.lang.String> propertyKeys)
                                                  throws java.io.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:

java.io.IOException

edgeFromJson

public static com.tinkerpop.blueprints.Edge edgeFromJson(java.lang.String json,
                                                         com.tinkerpop.blueprints.Vertex out,
                                                         com.tinkerpop.blueprints.Vertex in,
                                                         com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                         com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                         java.util.Set<java.lang.String> propertyKeys)
                                                  throws java.io.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:

java.io.IOException

edgeFromJson

public static com.tinkerpop.blueprints.Edge edgeFromJson(java.io.InputStream json,
                                                         com.tinkerpop.blueprints.Vertex out,
                                                         com.tinkerpop.blueprints.Vertex in,
                                                         com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                         com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                         java.util.Set<java.lang.String> propertyKeys)
                                                  throws java.io.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:

java.io.IOException

edgeFromJson

public static com.tinkerpop.blueprints.Edge edgeFromJson(com.fasterxml.jackson.databind.JsonNode json,
                                                         com.tinkerpop.blueprints.Vertex out,
                                                         com.tinkerpop.blueprints.Vertex in,
                                                         com.tinkerpop.blueprints.util.io.graphson.ElementFactory factory,
                                                         com.tinkerpop.blueprints.util.io.graphson.GraphSONMode mode,
                                                         java.util.Set<java.lang.String> propertyKeys)
                                                  throws java.io.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:

java.io.IOException