org.opencypher.gremlin.client

Class CypherTraversalSource

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource

org.opencypher.gremlin.client.CypherTraversalSource

All Implemented Interfaces:

AutoCloseable, Cloneable, TraversalSource

public class CypherTraversalSource
extends GraphTraversalSource

A TraversalSource implementation that spawns CypherTraversalSource instances. CypherTraversalSource has cypher(String) step that allows to start traversal with Cypher query (which will be translated to Gremlin) then continue with other Gremlin steps

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource

GraphTraversalSource.Symbols

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource

bytecode, connection, graph, strategies

Constructor Summary

Constructors

Constructor and Description
CypherTraversalSource(Graph graph)
CypherTraversalSource(Graph graph, TraversalStrategies traversalStrategies)
CypherTraversalSource(RemoteConnection connection)

Method Summary

Modifier and Type	Method and Description
GraphTraversal<Map<String,Object>,Map<String,Object>>	cypher(String cypher) Translate Cypher query to Gremlin and get the result set as a GraphTraversal.
GraphTraversal<Map<String,Object>,Map<String,Object>>	cypher(String cypher, Map<String,Object> params) Translate Cypher query with provided parameters and get the result set as a GraphTraversal.
GraphTraversal<Map<String,Object>,Map<String,Object>>	cypher(String cypher, Map<String,Object> params, String flavor) Translate Cypher query to Gremlin with flavor and provided parameters and get the result set as a GraphTraversal.
GraphTraversal<Map<String,Object>,Map<String,Object>>	cypher(String cypher, String flavor) Translate Cypher query to Gremlin with flavor and get the result set as a GraphTraversal.
CypherTraversalSource	withRemote(org.apache.commons.configuration.Configuration conf)
CypherTraversalSource	withRemote(RemoteConnection connection)
CypherTraversalSource	withRemote(String configFile)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource

addE, addE, addV, addV, addV, clone, close, E, getAnonymousTraversalClass, getBytecode, getGraph, getStrategies, inject, io, toString, tx, V, with, with, withBulk, withComputer, withComputer, withComputer, withoutStrategies, withPath, withSack, withSack, withSack, withSack, withSack, withSack, withSack, withSack, withSideEffect, withSideEffect, withSideEffect, withSideEffect, withStrategies

Methods inherited from class java.lang.Object

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

Constructor Detail

CypherTraversalSource

public CypherTraversalSource(Graph graph,
                             TraversalStrategies traversalStrategies)

CypherTraversalSource

public CypherTraversalSource(Graph graph)

CypherTraversalSource

public CypherTraversalSource(RemoteConnection connection)

Method Detail

cypher

public GraphTraversal<Map<String,Object>,Map<String,Object>> cypher(String cypher)

Translate Cypher query to Gremlin and get the result set as a GraphTraversal.

Parameters:

cypher - the Cypher query to execute

Returns:

a fluent Gremlin traversal

cypher

public GraphTraversal<Map<String,Object>,Map<String,Object>> cypher(String cypher,
                                                                    String flavor)

Translate Cypher query to Gremlin with flavor and get the result set as a GraphTraversal.

Parameters:

cypher - the Cypher query to execute

flavor - flavor of translation

Returns:

a fluent Gremlin traversal

See Also:

Translator.FlavorBuilder#build(java.lang.String)

cypher

public GraphTraversal<Map<String,Object>,Map<String,Object>> cypher(String cypher,
                                                                    Map<String,Object> params)

Translate Cypher query with provided parameters and get the result set as a GraphTraversal.

Parameters:

cypher - the Cypher query to execute

params - the parameters of the Cypher query

Returns:

a fluent Gremlin traversal

cypher

public GraphTraversal<Map<String,Object>,Map<String,Object>> cypher(String cypher,
                                                                    Map<String,Object> params,
                                                                    String flavor)

Translate Cypher query to Gremlin with flavor and provided parameters and get the result set as a GraphTraversal.

Parameters:

cypher - the Cypher query to execute

params - the parameters of the Cypher query

flavor - flavor of translation

Returns:

a fluent Gremlin traversal

See Also:

*

withRemote

public CypherTraversalSource withRemote(org.apache.commons.configuration.Configuration conf)

Specified by:

withRemote in interface TraversalSource

Overrides:

withRemote in class GraphTraversalSource

withRemote

public CypherTraversalSource withRemote(String configFile)
                                 throws Exception

Specified by:

withRemote in interface TraversalSource

Overrides:

withRemote in class GraphTraversalSource

Throws:

Exception

withRemote

public CypherTraversalSource withRemote(RemoteConnection connection)

Specified by:

withRemote in interface TraversalSource

Overrides:

withRemote in class GraphTraversalSource