Package org.apache.tinkerpop.gremlin.process.traversal

Class GremlinLang

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.GremlinLang

All Implemented Interfaces:

Serializable, Cloneable

public class GremlinLang
extends Object
implements Cloneable, Serializable

This class helps to build a gremlin-lang compatible string representation based on a TraversalSource and then a Traversal.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GremlinLang()
GremlinLang(String sourceName, Object... arguments)

Method Summary

Modifier and Type	Method	Description
void	addG(String g)	The alias to set.
void	addSource(String sourceName, Object... arguments)	Add a TraversalSource instruction to the GremlinLang.
void	addStep(String stepName, Object... arguments)	Add a Traversal instruction to the GremlinLang.
GremlinLang	clone()
boolean	equals(Object o)
String	getGremlin()	Get gremlin-lang compatible representation of Traversal
String	getGremlin(String g)	Get gremlin-lang compatible representation of Traversal.
List<OptionsStrategy>	getOptionsStrategies()	Provides a way to get configuration of a Traversal.
Map<String,Object>	getParameters()	Get parameters used in Traversal.
int	hashCode()
boolean	isEmpty()
void	reset()	Reset parameter naming counter.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GremlinLang

public GremlinLang()

GremlinLang

public GremlinLang(String sourceName,
                   Object... arguments)

Method Detail

getGremlin

public String getGremlin()

Get gremlin-lang compatible representation of Traversal

Returns:

gremlin-lang compatible String

getGremlin

public String getGremlin(String g)

Get gremlin-lang compatible representation of Traversal. "g" is expected for gremlin-lang. "__" can be used for an anonymous GraphTraversal.

Parameters:

g - GraphTraversalSource name

Returns:

gremlin-lang compatible String

getParameters

public Map<String,Object> getParameters()

Get parameters used in Traversal.

Returns:

parameters Map

addG

public void addG(String g)

The alias to set.

reset

public void reset()

Reset parameter naming counter. Mainly intended to make testing easier

addSource

public void addSource(String sourceName,
                      Object... arguments)

Add a TraversalSource instruction to the GremlinLang.

Parameters:

sourceName - the traversal source method name (e.g. withSack())

arguments - the traversal source method arguments

addStep

public void addStep(String stepName,
                    Object... arguments)

Add a Traversal instruction to the GremlinLang.

Parameters:

stepName - the traversal method name (e.g. out())

arguments - the traversal method arguments

getOptionsStrategies

public List<OptionsStrategy> getOptionsStrategies()

Provides a way to get configuration of a Traversal.

Returns:

list of OptionsStrategy

isEmpty

public boolean isEmpty()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GremlinLang clone()

Overrides:

clone in class Object