com.tinkerpop.gremlin.process.graph

Interface GraphTraversal<S,E>

All Superinterfaces:

java.lang.Cloneable, java.util.Iterator<E>, Traversal<S,E>

All Known Implementing Classes:

DefaultGraphTraversal, EmptyGraphTraversal

public interface GraphTraversal<S,E>
extends Traversal<S,E>

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GraphTraversal.Admin<S,E>

Nested classes/interfaces inherited from interface com.tinkerpop.gremlin.process.Traversal

Traversal.Exceptions

Field Summary

Fields inherited from interface com.tinkerpop.gremlin.process.Traversal

OF

Method Summary

Modifier and Type	Method and Description
default GraphTraversal<S,Vertex>	addBothE(java.lang.String edgeLabel, java.lang.String stepLabel, java.lang.Object... propertyKeyValues)
default GraphTraversal<S,Vertex>	addE(Direction direction, java.lang.String edgeLabel, java.lang.String stepLabel, java.lang.Object... propertyKeyValues)
default GraphTraversal<S,Vertex>	addInE(java.lang.String edgeLabel, java.lang.String stepLabel, java.lang.Object... propertyKeyValues)
default GraphTraversal<S,Vertex>	addOutE(java.lang.String edgeLabel, java.lang.String stepLabel, java.lang.Object... propertyKeyValues)
default GraphTraversal<S,E>	aggregate()
default GraphTraversal<S,E>	aggregate(java.lang.String sideEffectKey)
default GraphTraversal<S,E>	as(java.lang.String stepLabel)
GraphTraversal.Admin<S,E>	asAdmin() Get access to administrative methods of the traversal via its accompanying Traversal.Admin.
default <E2> GraphTraversal<S,E2>	back(java.lang.String stepLabel)
default <E2 extends Element> GraphTraversal<S,E2>	between(java.lang.String key, java.lang.Comparable startValue, java.lang.Comparable endValue)
default GraphTraversal<S,Vertex>	both(java.lang.String... edgeLabels)
default GraphTraversal<S,Edge>	bothE(java.lang.String... edgeLabels)
default GraphTraversal<S,Vertex>	bothV()
default GraphTraversal<S,E>	branch(java.util.function.Function<Traverser<E>,java.util.Collection<java.lang.String>> function)
default GraphTraversal<S,E>	by()
default GraphTraversal<S,E>	by(java.util.Comparator<E> comparator)
default <V> GraphTraversal<S,E>	by(java.util.function.Function<Element,V> elementFunctionProjection, java.util.Comparator<V> elementFunctionValueComparator)
default <V> GraphTraversal<S,E>	by(java.util.function.Function<V,java.lang.Object> functionProjection)
default GraphTraversal<S,E>	by(java.lang.String elementPropertyProjection)
default <V> GraphTraversal<S,E>	by(java.lang.String elementPropertyProjection, java.util.Comparator<V> propertyValueComparator)
default GraphTraversal<S,E>	by(T tokenProjection)
default <V> GraphTraversal<S,E>	by(T tokenProjection, java.util.Comparator<V> tokenValueComparator)
default <E2> GraphTraversal<S,E2>	cap()
default <E2> GraphTraversal<S,E2>	cap(java.lang.String sideEffectKey)
default <M,E2> GraphTraversal<S,E2>	choose(java.util.function.Function<E,M> mapFunction, java.util.Map<M,Traversal<?,E2>> choices)
default <E2> GraphTraversal<S,E2>	choose(java.util.function.Predicate<E> choosePredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
default GraphTraversal<S,E>	coin(double probability)
default GraphTraversal<S,java.lang.Long>	count()
default GraphTraversal<S,E>	cyclicPath()
default GraphTraversal<S,E>	dedup()
default GraphTraversal<S,E>	emit()
default GraphTraversal<S,E>	emit(java.util.function.Predicate<Traverser<E>> emitPredicate)
default GraphTraversal<S,E>	emit(Traversal<?,?> emitTraversal)
default GraphTraversal<S,E>	except(java.util.Collection<E> exceptionCollection)
default GraphTraversal<S,E>	except(E exceptionObject)
default GraphTraversal<S,E>	except(java.lang.String sideEffectKey)
default GraphTraversal<S,E>	filter(java.util.function.Predicate<Traverser<E>> predicate)
default <E2> GraphTraversal<S,E2>	flatMap(java.util.function.Function<Traverser<E>,java.util.Iterator<E2>> function)
default GraphTraversal<S,java.util.List<E>>	fold()
default <E2> GraphTraversal<S,E2>	fold(E2 seed, java.util.function.BiFunction<E2,E,E2> foldFunction)
default GraphTraversal<S,E>	group()
default GraphTraversal<S,E>	group(java.lang.String sideEffectKey)
default GraphTraversal<S,E>	groupCount()
default GraphTraversal<S,E>	groupCount(java.lang.String sideEffectKey)
default <E2 extends Element> GraphTraversal<S,E2>	has(java.lang.String key)
default <E2 extends Element> GraphTraversal<S,E2>	has(java.lang.String key, java.util.function.BiPredicate predicate, java.lang.Object value)
default <E2 extends Element> GraphTraversal<S,E2>	has(java.lang.String key, java.lang.Object value)
default <E2 extends Element> GraphTraversal<S,E2>	has(java.lang.String label, java.lang.String key, java.util.function.BiPredicate predicate, java.lang.Object value)
default <E2 extends Element> GraphTraversal<S,E2>	has(java.lang.String label, java.lang.String key, java.lang.Object value)
default <E2 extends Element> GraphTraversal<S,E2>	has(T accessor, java.util.function.BiPredicate predicate, java.lang.Object value)
default <E2 extends Element> GraphTraversal<S,E2>	has(T accessor, java.lang.Object value)
default <E2 extends Element> GraphTraversal<S,E2>	hasNot(java.lang.String key)
default GraphTraversal<S,java.lang.Object>	id()
default GraphTraversal<S,E>	identity()
default GraphTraversal<S,Vertex>	in(java.lang.String... edgeLabels)
default GraphTraversal<S,Edge>	inE(java.lang.String... edgeLabels)
default GraphTraversal<S,E>	inject(E... injections)
default GraphTraversal<S,Vertex>	inV()
default GraphTraversal<S,java.lang.String>	key()
default GraphTraversal<S,java.lang.String>	label()
default GraphTraversal<S,E>	limit(long limit)
default <E2> GraphTraversal<S,E2>	local(Traversal<?,E2> localTraversal)
default <E2> GraphTraversal<S,E2>	map(java.util.function.Function<Traverser<E>,E2> function)
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	match(java.lang.String startLabel, Traversal... traversals)
default GraphTraversal<S,E>	order()
default GraphTraversal<S,Vertex>	otherV()
default GraphTraversal<S,Vertex>	out(java.lang.String... edgeLabels)
default GraphTraversal<S,Edge>	outE(java.lang.String... edgeLabels)
default GraphTraversal<S,Vertex>	outV()
default GraphTraversal<S,Path>	path()
default GraphTraversal<S,E>	profile()
default <E2> GraphTraversal<S,? extends Property<E2>>	properties(java.lang.String... propertyKeys)
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	propertyMap(java.lang.String... propertyKeys)
default GraphTraversal<S,E>	range(long low, long high)
default void	remove()
default GraphTraversal<S,E>	repeat(Traversal<?,E> repeatTraversal)
default GraphTraversal<S,E>	retain(java.util.Collection<E> retainCollection)
default GraphTraversal<S,E>	retain(E retainObject)
default GraphTraversal<S,E>	retain(java.lang.String sideEffectKey)
default <E2> GraphTraversal<S,E2>	sack()
default <V> GraphTraversal<S,E>	sack(java.util.function.BiFunction<V,E,V> sackFunction)
default <E2 extends Element,V> GraphTraversal<S,E2>	sack(java.util.function.BinaryOperator<V> sackOperator, java.lang.String elementPropertyKey)
default GraphTraversal<S,E>	sample(int amountToSample)
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	select(java.lang.String... stepLabels)
default <E2> GraphTraversal<S,E2>	select(java.lang.String stepLabel)
default GraphTraversal<S,E>	shuffle()
default GraphTraversal<S,E>	sideEffect(java.util.function.Consumer<Traverser<E>> consumer)
default GraphTraversal<S,E>	simplePath()
default GraphTraversal<S,E>	store()
default GraphTraversal<S,E>	store(java.lang.String sideEffectKey)
default GraphTraversal<S,E>	subgraph(java.util.function.Predicate<Edge> includeEdge)
default GraphTraversal<S,E>	subgraph(java.util.Set<java.lang.Object> edgeIdHolder, java.util.Map<java.lang.Object,Vertex> vertexMap, java.util.function.Predicate<Edge> includeEdge)
default GraphTraversal<S,E>	subgraph(java.lang.String sideEffectKey, java.util.function.Predicate<Edge> includeEdge)
default GraphTraversal<S,E>	subgraph(java.lang.String sideEffectKey, java.util.Set<java.lang.Object> edgeIdHolder, java.util.Map<java.lang.Object,Vertex> vertexMap, java.util.function.Predicate<Edge> includeEdge)
default GraphTraversal<S,E>	submit(GraphComputer computer) Submit the traversal to a GraphComputer for OLAP execution.
default GraphTraversal<S,java.lang.Double>	sum()
default GraphTraversal<S,E>	timeLimit(long timeLimit)
default GraphTraversal<S,E>	times(int maxLoops)
default GraphTraversal<S,Vertex>	to(Direction direction, java.lang.String... edgeLabels)
default GraphTraversal<S,Edge>	toE(Direction direction, java.lang.String... edgeLabels)
default GraphTraversal<S,Vertex>	toV(Direction direction)
default GraphTraversal<S,E>	tree()
default GraphTraversal<S,E>	tree(java.lang.String sideEffectKey)
default <E2> GraphTraversal<S,E2>	unfold()
default <E2> GraphTraversal<S,E2>	union(Traversal<?,E2>... traversals)
default GraphTraversal<S,E>	until(java.util.function.Predicate<Traverser<E>> untilPredicate)
default GraphTraversal<S,E>	until(Traversal<?,?> untilTraversal)
default <E2> GraphTraversal<S,E2>	value()
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	valueMap(boolean includeTokens, java.lang.String... propertyKeys)
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	valueMap(java.lang.String... propertyKeys)
default <E2> GraphTraversal<S,E2>	values(java.lang.String... propertyKeys)
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	where(java.lang.String firstKey, java.util.function.BiPredicate predicate, java.lang.String secondKey)
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	where(java.lang.String firstKey, java.lang.String secondKey, java.util.function.BiPredicate predicate)
default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>>	where(Traversal constraint)
default GraphTraversal<S,E>	withPath()
default <A> GraphTraversal<S,E>	withSack(java.util.function.Supplier<A> initialValue)
default <A> GraphTraversal<S,E>	withSack(java.util.function.Supplier<A> initialValue, java.util.function.UnaryOperator<A> splitOperator)
default GraphTraversal<S,E>	withSideEffect(java.lang.String key, java.util.function.Supplier supplier)

Methods inherited from interface com.tinkerpop.gremlin.process.Traversal

clone, fill, forEachRemaining, iterate, next, toBulkSet, toList, toSet, tryNext

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next

Method Detail

submit

default GraphTraversal<S,E> submit(GraphComputer computer)

Description copied from interface: Traversal

Submit the traversal to a GraphComputer for OLAP execution. This method should apply the traversal strategies for TraversalEngine.COMPUTER. Then register and execute the traversal via TraversalVertexProgram. Then wrap the ComputerResult in a new Traversal containing a ComputerResultStep.

Specified by:

submit in interface Traversal<S,E>

Parameters:

computer - the GraphComputer to execute the traversal on

Returns:

a new traversal with the starts being the results of the TraversalVertexProgram

asAdmin

GraphTraversal.Admin<S,E> asAdmin()

Description copied from interface: Traversal

Get access to administrative methods of the traversal via its accompanying Traversal.Admin.

Specified by:

asAdmin in interface Traversal<S,E>

Returns:

the admin of this traversal

map

default <E2> GraphTraversal<S,E2> map(java.util.function.Function<Traverser<E>,E2> function)

flatMap

default <E2> GraphTraversal<S,E2> flatMap(java.util.function.Function<Traverser<E>,java.util.Iterator<E2>> function)

id

default GraphTraversal<S,java.lang.Object> id()

label

default GraphTraversal<S,java.lang.String> label()

identity

default GraphTraversal<S,E> identity()

to

default GraphTraversal<S,Vertex> to(Direction direction,
                                    java.lang.String... edgeLabels)

out

default GraphTraversal<S,Vertex> out(java.lang.String... edgeLabels)

in

default GraphTraversal<S,Vertex> in(java.lang.String... edgeLabels)

both

default GraphTraversal<S,Vertex> both(java.lang.String... edgeLabels)

toE

default GraphTraversal<S,Edge> toE(Direction direction,
                                   java.lang.String... edgeLabels)

outE

default GraphTraversal<S,Edge> outE(java.lang.String... edgeLabels)

inE

default GraphTraversal<S,Edge> inE(java.lang.String... edgeLabels)

bothE

default GraphTraversal<S,Edge> bothE(java.lang.String... edgeLabels)

toV

default GraphTraversal<S,Vertex> toV(Direction direction)

inV

default GraphTraversal<S,Vertex> inV()

outV

default GraphTraversal<S,Vertex> outV()

bothV

default GraphTraversal<S,Vertex> bothV()

otherV

default GraphTraversal<S,Vertex> otherV()

order

default GraphTraversal<S,E> order()

shuffle

default GraphTraversal<S,E> shuffle()

properties

default <E2> GraphTraversal<S,? extends Property<E2>> properties(java.lang.String... propertyKeys)

values

default <E2> GraphTraversal<S,E2> values(java.lang.String... propertyKeys)

propertyMap

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> propertyMap(java.lang.String... propertyKeys)

valueMap

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> valueMap(java.lang.String... propertyKeys)

valueMap

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> valueMap(boolean includeTokens,
                                                                           java.lang.String... propertyKeys)

key

default GraphTraversal<S,java.lang.String> key()

value

default <E2> GraphTraversal<S,E2> value()

path

default GraphTraversal<S,Path> path()

back

default <E2> GraphTraversal<S,E2> back(java.lang.String stepLabel)

match

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> match(java.lang.String startLabel,
                                                                        Traversal... traversals)

sack

default <E2> GraphTraversal<S,E2> sack()

select

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> select(java.lang.String... stepLabels)

select

default <E2> GraphTraversal<S,E2> select(java.lang.String stepLabel)

unfold

default <E2> GraphTraversal<S,E2> unfold()

fold

default GraphTraversal<S,java.util.List<E>> fold()

fold

default <E2> GraphTraversal<S,E2> fold(E2 seed,
                                       java.util.function.BiFunction<E2,E,E2> foldFunction)

local

default <E2> GraphTraversal<S,E2> local(Traversal<?,E2> localTraversal)

filter

default GraphTraversal<S,E> filter(java.util.function.Predicate<Traverser<E>> predicate)

inject

default GraphTraversal<S,E> inject(E... injections)

dedup

default GraphTraversal<S,E> dedup()

except

default GraphTraversal<S,E> except(java.lang.String sideEffectKey)

except

default GraphTraversal<S,E> except(E exceptionObject)

except

default GraphTraversal<S,E> except(java.util.Collection<E> exceptionCollection)

where

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> where(java.lang.String firstKey,
                                                                        java.lang.String secondKey,
                                                                        java.util.function.BiPredicate predicate)

where

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> where(java.lang.String firstKey,
                                                                        java.util.function.BiPredicate predicate,
                                                                        java.lang.String secondKey)

where

default <E2> GraphTraversal<S,java.util.Map<java.lang.String,E2>> where(Traversal constraint)

has

default <E2 extends Element> GraphTraversal<S,E2> has(java.lang.String key)

has

default <E2 extends Element> GraphTraversal<S,E2> has(java.lang.String key,
                                                      java.lang.Object value)

has

default <E2 extends Element> GraphTraversal<S,E2> has(T accessor,
                                                      java.lang.Object value)

has

default <E2 extends Element> GraphTraversal<S,E2> has(java.lang.String key,
                                                      java.util.function.BiPredicate predicate,
                                                      java.lang.Object value)

has

default <E2 extends Element> GraphTraversal<S,E2> has(T accessor,
                                                      java.util.function.BiPredicate predicate,
                                                      java.lang.Object value)

has

default <E2 extends Element> GraphTraversal<S,E2> has(java.lang.String label,
                                                      java.lang.String key,
                                                      java.lang.Object value)

has

default <E2 extends Element> GraphTraversal<S,E2> has(java.lang.String label,
                                                      java.lang.String key,
                                                      java.util.function.BiPredicate predicate,
                                                      java.lang.Object value)

hasNot

default <E2 extends Element> GraphTraversal<S,E2> hasNot(java.lang.String key)

between

default <E2 extends Element> GraphTraversal<S,E2> between(java.lang.String key,
                                                          java.lang.Comparable startValue,
                                                          java.lang.Comparable endValue)

coin

default GraphTraversal<S,E> coin(double probability)

range

default GraphTraversal<S,E> range(long low,
                                  long high)

limit

default GraphTraversal<S,E> limit(long limit)

retain

default GraphTraversal<S,E> retain(java.lang.String sideEffectKey)

retain

default GraphTraversal<S,E> retain(E retainObject)

retain

default GraphTraversal<S,E> retain(java.util.Collection<E> retainCollection)

simplePath

default GraphTraversal<S,E> simplePath()

cyclicPath

default GraphTraversal<S,E> cyclicPath()

sample

default GraphTraversal<S,E> sample(int amountToSample)

sideEffect

default GraphTraversal<S,E> sideEffect(java.util.function.Consumer<Traverser<E>> consumer)

cap

default <E2> GraphTraversal<S,E2> cap(java.lang.String sideEffectKey)

cap

default <E2> GraphTraversal<S,E2> cap()

count

default GraphTraversal<S,java.lang.Long> count()

sum

default GraphTraversal<S,java.lang.Double> sum()

subgraph

default GraphTraversal<S,E> subgraph(java.lang.String sideEffectKey,
                                     java.util.Set<java.lang.Object> edgeIdHolder,
                                     java.util.Map<java.lang.Object,Vertex> vertexMap,
                                     java.util.function.Predicate<Edge> includeEdge)

subgraph

default GraphTraversal<S,E> subgraph(java.util.Set<java.lang.Object> edgeIdHolder,
                                     java.util.Map<java.lang.Object,Vertex> vertexMap,
                                     java.util.function.Predicate<Edge> includeEdge)

subgraph

default GraphTraversal<S,E> subgraph(java.lang.String sideEffectKey,
                                     java.util.function.Predicate<Edge> includeEdge)

subgraph

default GraphTraversal<S,E> subgraph(java.util.function.Predicate<Edge> includeEdge)

aggregate

default GraphTraversal<S,E> aggregate(java.lang.String sideEffectKey)

aggregate

default GraphTraversal<S,E> aggregate()

group

default GraphTraversal<S,E> group(java.lang.String sideEffectKey)

group

default GraphTraversal<S,E> group()

groupCount

default GraphTraversal<S,E> groupCount(java.lang.String sideEffectKey)

groupCount

default GraphTraversal<S,E> groupCount()

addE

default GraphTraversal<S,Vertex> addE(Direction direction,
                                      java.lang.String edgeLabel,
                                      java.lang.String stepLabel,
                                      java.lang.Object... propertyKeyValues)

addInE

default GraphTraversal<S,Vertex> addInE(java.lang.String edgeLabel,
                                        java.lang.String stepLabel,
                                        java.lang.Object... propertyKeyValues)

addOutE

default GraphTraversal<S,Vertex> addOutE(java.lang.String edgeLabel,
                                         java.lang.String stepLabel,
                                         java.lang.Object... propertyKeyValues)

addBothE

default GraphTraversal<S,Vertex> addBothE(java.lang.String edgeLabel,
                                          java.lang.String stepLabel,
                                          java.lang.Object... propertyKeyValues)

timeLimit

default GraphTraversal<S,E> timeLimit(long timeLimit)

tree

default GraphTraversal<S,E> tree(java.lang.String sideEffectKey)

tree

default GraphTraversal<S,E> tree()

sack

default <V> GraphTraversal<S,E> sack(java.util.function.BiFunction<V,E,V> sackFunction)

sack

default <E2 extends Element,V> GraphTraversal<S,E2> sack(java.util.function.BinaryOperator<V> sackOperator,
                                                         java.lang.String elementPropertyKey)

store

default GraphTraversal<S,E> store(java.lang.String sideEffectKey)

store

default GraphTraversal<S,E> store()

branch

default GraphTraversal<S,E> branch(java.util.function.Function<Traverser<E>,java.util.Collection<java.lang.String>> function)

choose

default <E2> GraphTraversal<S,E2> choose(java.util.function.Predicate<E> choosePredicate,
                                         Traversal<?,E2> trueChoice,
                                         Traversal<?,E2> falseChoice)

choose

default <M,E2> GraphTraversal<S,E2> choose(java.util.function.Function<E,M> mapFunction,
                                           java.util.Map<M,Traversal<?,E2>> choices)

union

default <E2> GraphTraversal<S,E2> union(Traversal<?,E2>... traversals)

repeat

default GraphTraversal<S,E> repeat(Traversal<?,E> repeatTraversal)

emit

default GraphTraversal<S,E> emit(java.util.function.Predicate<Traverser<E>> emitPredicate)

emit

default GraphTraversal<S,E> emit(Traversal<?,?> emitTraversal)

emit

default GraphTraversal<S,E> emit()

until

default GraphTraversal<S,E> until(java.util.function.Predicate<Traverser<E>> untilPredicate)

until

default GraphTraversal<S,E> until(Traversal<?,?> untilTraversal)

times

default GraphTraversal<S,E> times(int maxLoops)

withSideEffect

default GraphTraversal<S,E> withSideEffect(java.lang.String key,
                                           java.util.function.Supplier supplier)

withSack

default <A> GraphTraversal<S,E> withSack(java.util.function.Supplier<A> initialValue,
                                         java.util.function.UnaryOperator<A> splitOperator)

withSack

default <A> GraphTraversal<S,E> withSack(java.util.function.Supplier<A> initialValue)

withPath

default GraphTraversal<S,E> withPath()

as

default GraphTraversal<S,E> as(java.lang.String stepLabel)

by

default GraphTraversal<S,E> by()

by

default <V> GraphTraversal<S,E> by(java.util.function.Function<V,java.lang.Object> functionProjection)

by

default GraphTraversal<S,E> by(T tokenProjection)

by

default GraphTraversal<S,E> by(java.lang.String elementPropertyProjection)

by

default GraphTraversal<S,E> by(java.util.Comparator<E> comparator)

by

default <V> GraphTraversal<S,E> by(java.util.function.Function<Element,V> elementFunctionProjection,
                                   java.util.Comparator<V> elementFunctionValueComparator)

by

default <V> GraphTraversal<S,E> by(T tokenProjection,
                                   java.util.Comparator<V> tokenValueComparator)

by

default <V> GraphTraversal<S,E> by(java.lang.String elementPropertyProjection,
                                   java.util.Comparator<V> propertyValueComparator)

profile

default GraphTraversal<S,E> profile()

remove

default void remove()

Specified by:

remove in interface java.util.Iterator<E>