org.opencypher.gremlin.translation

Interface GremlinSteps<T,P>

Type Parameters:

T - translation target type

P - predicate target type

All Known Implementing Classes:

BytecodeGremlinSteps, GroovyGremlinSteps, TraversalGremlinSteps

public interface GremlinSteps<T,P>

Gremlin GraphTraversal DSL wrapper. For DSL details, see Graph Traversal Steps.

Implementations define a translation target that can be built with GraphTraversal steps.

Note: steps are expected to be side-effecting, thus, unsuitable for use in immutable contexts.

See Also:

Translator

Method Summary

Modifier and Type	Method and Description
GremlinSteps<T,P>	addE(String edgeLabel)
GremlinSteps<T,P>	addV()
GremlinSteps<T,P>	addV(String vertexLabel)
GremlinSteps<T,P>	aggregate(String sideEffectKey)
GremlinSteps<T,P>	and(GremlinSteps<T,P>... andTraversals)
GremlinSteps<T,P>	as(String stepLabel)
GremlinSteps<T,P>	barrier()
GremlinSteps<T,P>	bothE(String... edgeLabels)
GremlinSteps<T,P>	by(GremlinSteps<T,P> traversal)
GremlinSteps<T,P>	by(GremlinSteps<T,P> traversal, Order order)
GremlinSteps<T,P>	cap(String sideEffectKey)
GremlinSteps<T,P>	choose(GremlinSteps<T,P> choiceTraversal)
GremlinSteps<T,P>	choose(GremlinSteps<T,P> traversalPredicate, GremlinSteps<T,P> trueChoice)
GremlinSteps<T,P>	choose(GremlinSteps<T,P> traversalPredicate, GremlinSteps<T,P> trueChoice, GremlinSteps<T,P> falseChoice)
GremlinSteps<T,P>	choose(P predicate, GremlinSteps<T,P> trueChoice)
GremlinSteps<T,P>	choose(P predicate, GremlinSteps<T,P> trueChoice, GremlinSteps<T,P> falseChoice)
GremlinSteps<T,P>	coalesce(GremlinSteps<T,P>... coalesceTraversals)
GremlinSteps<T,P>	constant(Object e)
GremlinSteps<T,P>	count()
GremlinSteps<T,P>	count(Scope scope)
T	current() Returns a copy of current translation.
GremlinSteps<T,P>	dedup(String... dedupLabels)
GremlinSteps<T,P>	drop()
GremlinSteps<T,P>	E()
GremlinSteps<T,P>	emit()
GremlinSteps<T,P>	emit(GremlinSteps<T,P> traversal)
GremlinSteps<T,P>	flatMap(GremlinSteps<T,P> traversal)
GremlinSteps<T,P>	fold()
GremlinSteps<T,P>	from(String fromStepLabel)
GremlinSteps<T,P>	group()
GremlinSteps<T,P>	has(String propertyKey)
GremlinSteps<T,P>	has(String propertyKey, P predicate)
GremlinSteps<T,P>	hasKey(String... labels)
GremlinSteps<T,P>	hasLabel(String... labels)
GremlinSteps<T,P>	hasNot(String propertyKey)
GremlinSteps<T,P>	id()
GremlinSteps<T,P>	identity()
GremlinSteps<T,P>	index()
GremlinSteps<T,P>	inE(String... edgeLabels)
GremlinSteps<T,P>	inject(Object... injections)
GremlinSteps<T,P>	inV()
GremlinSteps<T,P>	is(P predicate)
GremlinSteps<T,P>	key()
GremlinSteps<T,P>	label()
GremlinSteps<T,P>	limit(long limit)
GremlinSteps<T,P>	limit(Scope scope, long limit)
GremlinSteps<T,P>	local(GremlinSteps<T,P> localTraversal)
GremlinSteps<T,P>	loops()
GremlinSteps<T,P>	map(CustomFunction function)
GremlinSteps<T,P>	map(GremlinSteps<T,P> traversal)
GremlinSteps<T,P>	math(String expression)
GremlinSteps<T,P>	max()
GremlinSteps<T,P>	max(Scope scope)
GremlinSteps<T,P>	mean()
GremlinSteps<T,P>	mean(Scope scope)
GremlinSteps<T,P>	min()
GremlinSteps<T,P>	min(Scope scope)
GremlinSteps<T,P>	not(GremlinSteps<T,P> notTraversal)
GremlinSteps<T,P>	option(Object pickToken, GremlinSteps<T,P> traversalOption)
GremlinSteps<T,P>	optional(GremlinSteps<T,P> optionalTraversal)
GremlinSteps<T,P>	or(GremlinSteps<T,P>... orTraversals)
GremlinSteps<T,P>	order()
GremlinSteps<T,P>	otherV()
GremlinSteps<T,P>	outE(String... edgeLabels)
GremlinSteps<T,P>	outV()
GremlinSteps<T,P>	path()
GremlinSteps<T,P>	project(String... keys)
GremlinSteps<T,P>	properties(String... propertyKeys)
GremlinSteps<T,P>	property(GremlinSteps<T,P> keyTraversal, GremlinSteps<T,P> valueTraversal)
GremlinSteps<T,P>	property(String key, GremlinSteps<T,P> traversal)
GremlinSteps<T,P>	property(String key, Object value)
GremlinSteps<T,P>	property(T token, Object value)
GremlinSteps<T,P>	property(VertexProperty.Cardinality cardinality, String key, GremlinSteps<T,P> traversal)
GremlinSteps<T,P>	property(VertexProperty.Cardinality cardinality, String key, Object value)
GremlinSteps<T,P>	range(Scope scope, long low, long high)
GremlinSteps<T,P>	repeat(GremlinSteps<T,P> repeatTraversal)
GremlinSteps<T,P>	select(Column column)
GremlinSteps<T,P>	select(Pop pop, String selectKey)
GremlinSteps<T,P>	select(String... selectKeys)
GremlinSteps<T,P>	sideEffect(GremlinSteps<T,P> sideEffectTraversal)
GremlinSteps<T,P>	simplePath()
GremlinSteps<T,P>	skip(long skip)
GremlinSteps<T,P>	start() Spawns a new anonymous traversal wrapper.
GremlinSteps<T,P>	sum()
GremlinSteps<T,P>	sum(Scope scope)
GremlinSteps<T,P>	tail(Scope scope, long limit)
GremlinSteps<T,P>	times(int maxLoops)
GremlinSteps<T,P>	to(String toStepLabel)
GremlinSteps<T,P>	unfold()
GremlinSteps<T,P>	union(GremlinSteps<T,P>... unionTraversals)
GremlinSteps<T,P>	until(GremlinSteps<T,P> untilTraversal)
GremlinSteps<T,P>	V()
GremlinSteps<T,P>	value()
GremlinSteps<T,P>	valueMap()
GremlinSteps<T,P>	valueMap(boolean includeTokens)
GremlinSteps<T,P>	values(String... propertyKeys)
GremlinSteps<T,P>	where(GremlinSteps<T,P> whereTraversal)
GremlinSteps<T,P>	where(P predicate)
GremlinSteps<T,P>	with(String key)
GremlinSteps<T,P>	with(String name, Object value)

Method Detail

current

T current()

Returns a copy of current translation.

Returns:

current translation

start

GremlinSteps<T,P> start()

Spawns a new anonymous traversal wrapper.

Returns:

anonymous traversal wrapper

V

GremlinSteps<T,P> V()

E

GremlinSteps<T,P> E()

addE

GremlinSteps<T,P> addE(String edgeLabel)

addV

GremlinSteps<T,P> addV()

addV

GremlinSteps<T,P> addV(String vertexLabel)

aggregate

GremlinSteps<T,P> aggregate(String sideEffectKey)

and

GremlinSteps<T,P> and(GremlinSteps<T,P>... andTraversals)

as

GremlinSteps<T,P> as(String stepLabel)

barrier

GremlinSteps<T,P> barrier()

bothE

GremlinSteps<T,P> bothE(String... edgeLabels)

by

GremlinSteps<T,P> by(GremlinSteps<T,P> traversal)

by

GremlinSteps<T,P> by(GremlinSteps<T,P> traversal,
                     Order order)

cap

GremlinSteps<T,P> cap(String sideEffectKey)

choose

GremlinSteps<T,P> choose(GremlinSteps<T,P> choiceTraversal)

choose

GremlinSteps<T,P> choose(GremlinSteps<T,P> traversalPredicate,
                         GremlinSteps<T,P> trueChoice)

choose

GremlinSteps<T,P> choose(GremlinSteps<T,P> traversalPredicate,
                         GremlinSteps<T,P> trueChoice,
                         GremlinSteps<T,P> falseChoice)

choose

GremlinSteps<T,P> choose(P predicate,
                         GremlinSteps<T,P> trueChoice,
                         GremlinSteps<T,P> falseChoice)

choose

GremlinSteps<T,P> choose(P predicate,
                         GremlinSteps<T,P> trueChoice)

coalesce

GremlinSteps<T,P> coalesce(GremlinSteps<T,P>... coalesceTraversals)

constant

GremlinSteps<T,P> constant(Object e)

count

GremlinSteps<T,P> count()

count

GremlinSteps<T,P> count(Scope scope)

dedup

GremlinSteps<T,P> dedup(String... dedupLabels)

drop

GremlinSteps<T,P> drop()

emit

GremlinSteps<T,P> emit()

emit

GremlinSteps<T,P> emit(GremlinSteps<T,P> traversal)

flatMap

GremlinSteps<T,P> flatMap(GremlinSteps<T,P> traversal)

fold

GremlinSteps<T,P> fold()

from

GremlinSteps<T,P> from(String fromStepLabel)

group

GremlinSteps<T,P> group()

has

GremlinSteps<T,P> has(String propertyKey)

has

GremlinSteps<T,P> has(String propertyKey,
                      P predicate)

hasKey

GremlinSteps<T,P> hasKey(String... labels)

hasLabel

GremlinSteps<T,P> hasLabel(String... labels)

hasNot

GremlinSteps<T,P> hasNot(String propertyKey)

id

GremlinSteps<T,P> id()

identity

GremlinSteps<T,P> identity()

inE

GremlinSteps<T,P> inE(String... edgeLabels)

inV

GremlinSteps<T,P> inV()

index

GremlinSteps<T,P> index()

inject

GremlinSteps<T,P> inject(Object... injections)

is

GremlinSteps<T,P> is(P predicate)

key

GremlinSteps<T,P> key()

label

GremlinSteps<T,P> label()

limit

GremlinSteps<T,P> limit(long limit)

limit

GremlinSteps<T,P> limit(Scope scope,
                        long limit)

local

GremlinSteps<T,P> local(GremlinSteps<T,P> localTraversal)

loops

GremlinSteps<T,P> loops()

map

GremlinSteps<T,P> map(CustomFunction function)

map

GremlinSteps<T,P> map(GremlinSteps<T,P> traversal)

math

GremlinSteps<T,P> math(String expression)

max

GremlinSteps<T,P> max()

max

GremlinSteps<T,P> max(Scope scope)

mean

GremlinSteps<T,P> mean()

mean

GremlinSteps<T,P> mean(Scope scope)

min

GremlinSteps<T,P> min()

min

GremlinSteps<T,P> min(Scope scope)

not

GremlinSteps<T,P> not(GremlinSteps<T,P> notTraversal)

option

GremlinSteps<T,P> option(Object pickToken,
                         GremlinSteps<T,P> traversalOption)

optional

GremlinSteps<T,P> optional(GremlinSteps<T,P> optionalTraversal)

or

GremlinSteps<T,P> or(GremlinSteps<T,P>... orTraversals)

order

GremlinSteps<T,P> order()

otherV

GremlinSteps<T,P> otherV()

outE

GremlinSteps<T,P> outE(String... edgeLabels)

outV

GremlinSteps<T,P> outV()

path

GremlinSteps<T,P> path()

properties

GremlinSteps<T,P> properties(String... propertyKeys)

property

GremlinSteps<T,P> property(T token,
                           Object value)

property

GremlinSteps<T,P> property(String key,
                           Object value)

property

GremlinSteps<T,P> property(VertexProperty.Cardinality cardinality,
                           String key,
                           Object value)

property

GremlinSteps<T,P> property(String key,
                           GremlinSteps<T,P> traversal)

property

GremlinSteps<T,P> property(GremlinSteps<T,P> keyTraversal,
                           GremlinSteps<T,P> valueTraversal)

property

GremlinSteps<T,P> property(VertexProperty.Cardinality cardinality,
                           String key,
                           GremlinSteps<T,P> traversal)

project

GremlinSteps<T,P> project(String... keys)

range

GremlinSteps<T,P> range(Scope scope,
                        long low,
                        long high)

repeat

GremlinSteps<T,P> repeat(GremlinSteps<T,P> repeatTraversal)

select

GremlinSteps<T,P> select(Pop pop,
                         String selectKey)

select

GremlinSteps<T,P> select(String... selectKeys)

select

GremlinSteps<T,P> select(Column column)

sideEffect

GremlinSteps<T,P> sideEffect(GremlinSteps<T,P> sideEffectTraversal)

simplePath

GremlinSteps<T,P> simplePath()

skip

GremlinSteps<T,P> skip(long skip)

sum

GremlinSteps<T,P> sum()

sum

GremlinSteps<T,P> sum(Scope scope)

tail

GremlinSteps<T,P> tail(Scope scope,
                       long limit)

times

GremlinSteps<T,P> times(int maxLoops)

to

GremlinSteps<T,P> to(String toStepLabel)

unfold

GremlinSteps<T,P> unfold()

union

GremlinSteps<T,P> union(GremlinSteps<T,P>... unionTraversals)

until

GremlinSteps<T,P> until(GremlinSteps<T,P> untilTraversal)

value

GremlinSteps<T,P> value()

valueMap

GremlinSteps<T,P> valueMap()

valueMap

GremlinSteps<T,P> valueMap(boolean includeTokens)

values

GremlinSteps<T,P> values(String... propertyKeys)

where

GremlinSteps<T,P> where(GremlinSteps<T,P> whereTraversal)

where

GremlinSteps<T,P> where(P predicate)

with

GremlinSteps<T,P> with(String key)

with

GremlinSteps<T,P> with(String name,
                       Object value)