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

Interface GraphTraversal<S,E>

All Superinterfaces:

AutoCloseable, Cloneable, Iterator<E>, Serializable, Traversal<S,E>

All Known Subinterfaces:

GraphTraversal.Admin<S,E>

All Known Implementing Classes:

DefaultGraphTraversal

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>
static class	GraphTraversal.Symbols

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal

Traversal.Exceptions

Method Summary

Modifier and Type	Method and Description
default GraphTraversal<S,Edge>	addE(Direction direction, String firstVertexKeyOrEdgeLabel, String edgeLabelOrSecondVertexKey, Object... propertyKeyValues) Deprecated. As of release 3.1.0, replaced by addE(String)
default GraphTraversal<S,Edge>	addE(String edgeLabel)
default GraphTraversal<S,Edge>	addInE(String firstVertexKeyOrEdgeLabel, String edgeLabelOrSecondVertexKey, Object... propertyKeyValues) Deprecated. As of release 3.1.0, replaced by addE(String)
default GraphTraversal<S,Edge>	addOutE(String firstVertexKeyOrEdgeLabel, String edgeLabelOrSecondVertexKey, Object... propertyKeyValues) Deprecated. As of release 3.1.0, replaced by addE(String)
default GraphTraversal<S,Vertex>	addV()
default GraphTraversal<S,Vertex>	addV(Object... propertyKeyValues) Deprecated. As of release 3.1.0, replaced by addV()
default GraphTraversal<S,Vertex>	addV(String vertexLabel)
default GraphTraversal<S,E>	aggregate(String sideEffectKey)
default GraphTraversal<S,E>	and(Traversal<?,?>... andTraversals)
default GraphTraversal<S,E>	as(String stepLabel, String... stepLabels)
default GraphTraversal.Admin<S,E>	asAdmin() Get access to administrative methods of the traversal via its accompanying Traversal.Admin.
default GraphTraversal<S,E>	barrier()
default GraphTraversal<S,E>	barrier(Consumer<TraverserSet<Object>> barrierConsumer)
default GraphTraversal<S,E>	barrier(int maxBarrierSize)
default GraphTraversal<S,Vertex>	both(String... edgeLabels) Map the Vertex to its adjacent vertices given the edge labels.
default GraphTraversal<S,Edge>	bothE(String... edgeLabels) Map the Vertex to its incident edges given the edge labels.
default GraphTraversal<S,Vertex>	bothV() Map the Edge to its incident vertices.
default <M,E2> GraphTraversal<S,E2>	branch(Function<Traverser<E>,M> function)
default <M,E2> GraphTraversal<S,E2>	branch(Traversal<?,M> branchTraversal)
default GraphTraversal<S,E>	by()
default GraphTraversal<S,E>	by(Comparator<E> comparator)
default <U> GraphTraversal<S,E>	by(Function<U,Object> function, Comparator comparator)
default <V> GraphTraversal<S,E>	by(Function<V,Object> function)
default GraphTraversal<S,E>	by(Order order)
default GraphTraversal<S,E>	by(String key)
default <V> GraphTraversal<S,E>	by(String key, Comparator<V> comparator)
default GraphTraversal<S,E>	by(T token)
default GraphTraversal<S,E>	by(Traversal<?,?> traversal)
default <V> GraphTraversal<S,E>	by(Traversal<?,?> traversal, Comparator<V> comparator)
default <E2> GraphTraversal<S,E2>	cap(String sideEffectKey, String... sideEffectKeys)
default <M,E2> GraphTraversal<S,E2>	choose(Function<E,M> choiceFunction)
default <E2> GraphTraversal<S,E2>	choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice)
default <E2> GraphTraversal<S,E2>	choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
default <E2> GraphTraversal<S,E2>	choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice)
default <E2> GraphTraversal<S,E2>	choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
default <M,E2> GraphTraversal<S,E2>	choose(Traversal<?,M> choiceTraversal)
default <E2> GraphTraversal<S,E2>	coalesce(Traversal<?,E2>... coalesceTraversals)
default GraphTraversal<S,E>	coin(double probability) Filter the E object given a biased coin toss.
default <E2> GraphTraversal<S,E2>	constant(E2 e) Map any object to a fixed E value.
default GraphTraversal<S,Long>	count() Map the traversal stream to its reduction as a sum of the Traverser.bulk() values (i.e.
default GraphTraversal<S,Long>	count(Scope scope)
default GraphTraversal<S,E>	cyclicPath() Filter the E object if its Traverser.path() is Path.isSimple().
default GraphTraversal<S,E>	dedup(Scope scope, String... dedupLabels) Remove all duplicates in the traversal stream up to this point.
default GraphTraversal<S,E>	dedup(String... dedupLabels) Remove all duplicates in the traversal stream up to this point.
default GraphTraversal<S,E>	drop()
default GraphTraversal<S,E>	emit()
default GraphTraversal<S,E>	emit(Predicate<Traverser<E>> emitPredicate)
default GraphTraversal<S,E>	emit(Traversal<?,?> emitTraversal)
default GraphTraversal<S,E>	filter(Predicate<Traverser<E>> predicate)
default GraphTraversal<S,E>	filter(Traversal<?,?> filterTraversal)
default <E2> GraphTraversal<S,E2>	flatMap(Function<Traverser<E>,Iterator<E2>> function) Map a Traverser referencing an object of type E to an iterator of objects of type E2.
default <E2> GraphTraversal<S,E2>	flatMap(Traversal<?,E2> flatMapTraversal) Map a Traverser referencing an object of type E to an iterator of objects of type E2.
default GraphTraversal<S,List<E>>	fold()
default <E2> GraphTraversal<S,E2>	fold(E2 seed, BiFunction<E2,E,E2> foldFunction)
default GraphTraversal<S,E>	from(String fromStepLabel)
default GraphTraversal<S,E>	from(Traversal<E,Vertex> fromVertex)
default <K,V> GraphTraversal<S,Map<K,V>>	group()
default GraphTraversal<S,E>	group(String sideEffectKey)
default <K> GraphTraversal<S,Map<K,Long>>	groupCount()
default GraphTraversal<S,E>	groupCount(String sideEffectKey)
default <K,V> GraphTraversal<S,Map<K,V>>	groupV3d0() Deprecated. As of release 3.1.0, replaced by group()
default GraphTraversal<S,E>	groupV3d0(String sideEffectKey) Deprecated. As of release 3.1.0, replaced by group(String).
default GraphTraversal<S,E>	has(String propertyKey)
default GraphTraversal<S,E>	has(String propertyKey, Object value)
default GraphTraversal<S,E>	has(String propertyKey, P<?> predicate)
default GraphTraversal<S,E>	has(String label, String propertyKey, Object value)
default GraphTraversal<S,E>	has(String label, String propertyKey, P<?> predicate)
default GraphTraversal<S,E>	has(String propertyKey, Traversal<?,?> propertyTraversal)
default GraphTraversal<S,E>	has(T accessor, Object value)
default GraphTraversal<S,E>	has(T accessor, P<?> predicate)
default GraphTraversal<S,E>	has(T accessor, Traversal<?,?> propertyTraversal)
default GraphTraversal<S,E>	hasId(Object id, Object... otherIds)
default GraphTraversal<S,E>	hasId(P<Object> predicate)
default GraphTraversal<S,E>	hasKey(P<String> predicate)
default GraphTraversal<S,E>	hasKey(String label, String... otherLabels)
default GraphTraversal<S,E>	hasLabel(P<String> predicate)
default GraphTraversal<S,E>	hasLabel(String label, String... otherLabels)
default GraphTraversal<S,E>	hasNot(String propertyKey)
default GraphTraversal<S,E>	hasValue(Object value, Object... otherValues)
default GraphTraversal<S,E>	hasValue(P<Object> predicate)
default GraphTraversal<S,Object>	id() Map the Element to its Element.id().
default GraphTraversal<S,E>	identity() Map the E object to itself.
default GraphTraversal<S,Vertex>	in(String... edgeLabels) Map the Vertex to its incoming adjacent vertices given the edge labels.
default GraphTraversal<S,Edge>	inE(String... edgeLabels) Map the Vertex to its incoming incident edges given the edge labels.
default GraphTraversal<S,E>	inject(E... injections)
default GraphTraversal<S,Vertex>	inV() Map the Edge to its incoming/head incident Vertex.
default GraphTraversal<S,E>	is(Object value) Filter the E object if it is not P.eq(V) to the provided value.
default GraphTraversal<S,E>	is(P<E> predicate)
default GraphTraversal<S,E>	iterate() Iterate all the Traverser instances in the traversal.
default GraphTraversal<S,String>	key() Map the Property to its Property.key().
default GraphTraversal<S,String>	label() Map the Element to its Element.label().
default GraphTraversal<S,E>	limit(long limit)
default <E2> GraphTraversal<S,E2>	limit(Scope scope, long limit)
default <E2> GraphTraversal<S,E2>	local(Traversal<?,E2> localTraversal)
default GraphTraversal<S,Integer>	loops()
default <E2> GraphTraversal<S,E2>	map(Function<Traverser<E>,E2> function) Map a traverser referencing an object of type E to an object of type E2.
default <E2> GraphTraversal<S,E2>	map(Traversal<?,E2> mapTraversal)
default <E2> GraphTraversal<S,E2>	mapKeys() Deprecated. As of release 3.1.0, replaced by select(Column)
default <E2> GraphTraversal<S,E2>	mapValues() Deprecated. As of release 3.1.0, replaced by select(Column)
default <E2> GraphTraversal<S,Map<String,E2>>	match(Traversal<?,?>... matchTraversals) Map the Traverser to a Map of bindings as specified by the provided match traversals.
default <E2 extends Number> GraphTraversal<S,E2>	max()
default <E2 extends Number> GraphTraversal<S,E2>	max(Scope scope)
default <E2 extends Number> GraphTraversal<S,E2>	mean()
default <E2 extends Number> GraphTraversal<S,E2>	mean(Scope scope)
default <E2 extends Number> GraphTraversal<S,E2>	min()
default <E2 extends Number> GraphTraversal<S,E2>	min(Scope scope)
default GraphTraversal<S,E>	not(Traversal<?,?> notTraversal)
default <M,E2> GraphTraversal<S,E>	option(M pickToken, Traversal<E,E2> traversalOption)
default <E2> GraphTraversal<S,E>	option(Traversal<E,E2> traversalOption)
default <E2> GraphTraversal<S,E2>	optional(Traversal<?,E2> optionalTraversal)
default GraphTraversal<S,E>	or(Traversal<?,?>... orTraversals)
default GraphTraversal<S,E>	order() Order all the objects in the traversal up to this point and then emit them one-by-one in their ordered sequence.
default GraphTraversal<S,E>	order(Scope scope) Order either the Scope.local object (e.g.
default GraphTraversal<S,Vertex>	otherV() Map the Edge to the incident vertex that was not just traversed from in the path history.
default GraphTraversal<S,Vertex>	out(String... edgeLabels) Map the Vertex to its outgoing adjacent vertices given the edge labels.
default GraphTraversal<S,Edge>	outE(String... edgeLabels) Map the Vertex to its outgoing incident edges given the edge labels.
default GraphTraversal<S,Vertex>	outV() Map the Edge to its outgoing/tail incident Vertex.
default GraphTraversal<S,E>	pageRank()
default GraphTraversal<S,E>	pageRank(double alpha)
default GraphTraversal<S,Path>	path() Map the Traverser to its Path history via Traverser.path().
default GraphTraversal<S,E>	peerPressure()
default GraphTraversal<S,TraversalMetrics>	profile() Profile the traversal.
default GraphTraversal<S,E>	profile(String sideEffectKey)
default GraphTraversal<S,E>	program(VertexProgram<?> vertexProgram)
default <E2> GraphTraversal<S,Map<String,E2>>	project(String projectKey, String... otherProjectKeys)
default <E2> GraphTraversal<S,? extends Property<E2>>	properties(String... propertyKeys) Map the Element to its associated properties given the provide property keys.
default GraphTraversal<S,E>	property(Object key, Object value, Object... keyValues) Sets the key and value of a Property.
default GraphTraversal<S,E>	property(VertexProperty.Cardinality cardinality, Object key, Object value, Object... keyValues) Sets a Property value and related meta properties if supplied, if supported by the Graph and if the Element is a VertexProperty.
default <E2> GraphTraversal<S,Map<String,E2>>	propertyMap(String... propertyKeys) Map the Element to a Map of the properties key'd according to their Property.key().
default GraphTraversal<S,E>	range(long low, long high)
default <E2> GraphTraversal<S,E2>	range(Scope scope, long low, long high)
default GraphTraversal<S,E>	repeat(Traversal<?,E> repeatTraversal)
default <E2> GraphTraversal<S,E2>	sack() Map the Traverser to its Traverser.sack() value.
default <V,U> GraphTraversal<S,E>	sack(BiFunction<V,U,V> sackOperator)
default <V,U> GraphTraversal<S,E>	sack(BiFunction<V,U,V> sackOperator, String elementPropertyKey) Deprecated. As of release 3.1.0, replaced by sack(BiFunction) with by(String).
default GraphTraversal<S,E>	sample(int amountToSample)
default GraphTraversal<S,E>	sample(Scope scope, int amountToSample)
default <E2> GraphTraversal<S,Collection<E2>>	select(Column column)
default <E2> GraphTraversal<S,E2>	select(Pop pop, String selectKey)
default <E2> GraphTraversal<S,Map<String,E2>>	select(Pop pop, String selectKey1, String selectKey2, String... otherSelectKeys) Map the Traverser to a Map projection of sideEffect values, map values, and/or path values.
default <E2> GraphTraversal<S,E2>	select(String selectKey)
default <E2> GraphTraversal<S,Map<String,E2>>	select(String selectKey1, String selectKey2, String... otherSelectKeys) Map the Traverser to a Map projection of sideEffect values, map values, and/or path values.
default GraphTraversal<S,E>	sideEffect(Consumer<Traverser<E>> consumer)
default GraphTraversal<S,E>	sideEffect(Traversal<?,?> sideEffectTraversal)
default GraphTraversal<S,E>	simplePath() Filter the E object if its Traverser.path() is not Path.isSimple().
default GraphTraversal<S,E>	store(String sideEffectKey)
default GraphTraversal<S,Edge>	subgraph(String sideEffectKey)
default <E2 extends Number> GraphTraversal<S,E2>	sum() Map the traversal stream to its reduction as a sum of the Traverser.get() values multiplied by their Traverser.bulk() (i.e.
default <E2 extends Number> GraphTraversal<S,E2>	sum(Scope scope)
default GraphTraversal<S,E>	tail()
default GraphTraversal<S,E>	tail(long limit)
default <E2> GraphTraversal<S,E2>	tail(Scope scope)
default <E2> GraphTraversal<S,E2>	tail(Scope scope, long limit)
default GraphTraversal<S,E>	timeLimit(long timeLimit) Once the first Traverser hits this step, a count down is started.
default GraphTraversal<S,E>	times(int maxLoops)
default GraphTraversal<S,Vertex>	to(Direction direction, String... edgeLabels) Map the Vertex to its adjacent vertices given a direction and edge labels.
default GraphTraversal<S,E>	to(String toStepLabel)
default GraphTraversal<S,E>	to(Traversal<E,Vertex> toVertex)
default GraphTraversal<S,Edge>	toE(Direction direction, String... edgeLabels) Map the Vertex to its incident edges given the direction and edge labels.
default GraphTraversal<S,Vertex>	toV(Direction direction) Map the Edge to its incident vertices given the direction.
default GraphTraversal<S,Tree>	tree()
default GraphTraversal<S,E>	tree(String sideEffectKey)
default <E2> GraphTraversal<S,E2>	unfold()
default <E2> GraphTraversal<S,E2>	union(Traversal<?,E2>... unionTraversals)
default GraphTraversal<S,E>	until(Predicate<Traverser<E>> untilPredicate)
default GraphTraversal<S,E>	until(Traversal<?,?> untilTraversal)
default GraphTraversal<S,Vertex>	V(Object... vertexIdsOrElements)
default <E2> GraphTraversal<S,E2>	value() Map the Property to its Property.value().
default <E2> GraphTraversal<S,Map<String,E2>>	valueMap(boolean includeTokens, String... propertyKeys) Map the Element to a Map of the property values key'd according to their Property.key().
default <E2> GraphTraversal<S,Map<String,E2>>	valueMap(String... propertyKeys) Map the Element to a Map of the property values key'd according to their Property.key().
default <E2> GraphTraversal<S,E2>	values(String... propertyKeys) Map the Element to the values of the associated properties given the provide property keys.
default GraphTraversal<S,E>	where(P<String> predicate)
default GraphTraversal<S,E>	where(String startKey, P<String> predicate)
default GraphTraversal<S,E>	where(Traversal<?,?> whereTraversal)

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal

close, explain, fill, forEachRemaining, forEachRemaining, next, promise, toBulkSet, toList, toSet, toStream, tryNext

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

asAdmin

default 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(Function<Traverser<E>,E2> function)

Map a traverser referencing an object of type E to an object of type E2.

Parameters:

function - the lambda expression that does the functional mapping

Returns:

the traversal with an appended LambdaMapStep.

map

default <E2> GraphTraversal<S,E2> map(Traversal<?,E2> mapTraversal)

flatMap

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

Map a Traverser referencing an object of type E to an iterator of objects of type E2. The resultant iterator is drained one-by-one before a new E object is pulled in for processing.

Type Parameters:

E2 - the type of the returned iterator objects

Parameters:

function - the lambda expression that does the functional mapping

Returns:

the traversal with an appended LambdaFlatMapStep.

flatMap

default <E2> GraphTraversal<S,E2> flatMap(Traversal<?,E2> flatMapTraversal)

Map a Traverser referencing an object of type E to an iterator of objects of type E2. The internal traversal is drained one-by-one before a new E object is pulled in for processing.

Type Parameters:

E2 - the end type of the internal traversal

Parameters:

flatMapTraversal - the traversal generating objects of type E2

Returns:

the traversal with an appended TraversalFlatMapStep.

id

default GraphTraversal<S,Object> id()

Map the Element to its Element.id().

Returns:

the traversal with an appended IdStep.

label

default GraphTraversal<S,String> label()

Map the Element to its Element.label().

Returns:

the traversal with an appended LabelStep.

identity

default GraphTraversal<S,E> identity()

Map the E object to itself. In other words, a "no op."

Returns:

the traversal with an appended IdentityStep.

constant

default <E2> GraphTraversal<S,E2> constant(E2 e)

Map any object to a fixed E value.

Returns:

the traversal with an appended ConstantStep.

V

default GraphTraversal<S,Vertex> V(Object... vertexIdsOrElements)

to

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

Map the Vertex to its adjacent vertices given a direction and edge labels.

Parameters:

direction - the direction to traverse from the current vertex

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

out

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

Map the Vertex to its outgoing adjacent vertices given the edge labels.

Parameters:

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

in

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

Map the Vertex to its incoming adjacent vertices given the edge labels.

Parameters:

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

both

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

Map the Vertex to its adjacent vertices given the edge labels.

Parameters:

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

toE

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

Map the Vertex to its incident edges given the direction and edge labels.

Parameters:

direction - the direction to traverse from the current vertex

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

outE

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

Map the Vertex to its outgoing incident edges given the edge labels.

Parameters:

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

inE

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

Map the Vertex to its incoming incident edges given the edge labels.

Parameters:

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

bothE

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

Map the Vertex to its incident edges given the edge labels.

Parameters:

edgeLabels - the edge labels to traverse

Returns:

the traversal with an appended VertexStep.

toV

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

Map the Edge to its incident vertices given the direction.

Parameters:

direction - the direction to traverser from the current edge

Returns:

the traversal with an appended EdgeVertexStep.

inV

default GraphTraversal<S,Vertex> inV()

Map the Edge to its incoming/head incident Vertex.

Returns:

the traversal with an appended EdgeVertexStep.

outV

default GraphTraversal<S,Vertex> outV()

Map the Edge to its outgoing/tail incident Vertex.

Returns:

the traversal with an appended EdgeVertexStep.

bothV

default GraphTraversal<S,Vertex> bothV()

Map the Edge to its incident vertices.

Returns:

the traversal with an appended EdgeVertexStep.

otherV

default GraphTraversal<S,Vertex> otherV()

Map the Edge to the incident vertex that was not just traversed from in the path history.

Returns:

the traversal with an appended EdgeOtherVertexStep.

order

default GraphTraversal<S,E> order()

Order all the objects in the traversal up to this point and then emit them one-by-one in their ordered sequence.

Returns:

the traversal with an appended OrderGlobalStep.

order

default GraphTraversal<S,E> order(Scope scope)

Order either the Scope.local object (e.g. a list, map, etc.) or the entire Scope.global traversal stream.

Parameters:

scope - whether the ordering is the current local object or the entire global stream.

Returns:

the traversal with an appended OrderGlobalStep or OrderLocalStep.

properties

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

Map the Element to its associated properties given the provide property keys. If no property keys are provided, then all properties are emitted.

Type Parameters:

E2 - the value type of the returned properties

Parameters:

propertyKeys - the properties to retrieve

Returns:

the traversal with an appended PropertiesStep.

values

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

Map the Element to the values of the associated properties given the provide property keys. If no property keys are provided, then all property values are emitted.

Type Parameters:

E2 - the value type of the properties

Parameters:

propertyKeys - the properties to retrieve their value from

Returns:

the traversal with an appended PropertiesStep.

propertyMap

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

Map the Element to a Map of the properties key'd according to their Property.key(). If no property keys are provided, then all properties are retrieved.

Type Parameters:

E2 - the value type of the returned properties

Parameters:

propertyKeys - the properties to retrieve

Returns:

the traversal with an appended PropertyMapStep.

valueMap

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

Map the Element to a Map of the property values key'd according to their Property.key(). If no property keys are provided, then all property values are retrieved.

Type Parameters:

E2 - the value type of the returned properties

Parameters:

propertyKeys - the properties to retrieve

Returns:

the traversal with an appended PropertyMapStep.

valueMap

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

Map the Element to a Map of the property values key'd according to their Property.key(). If no property keys are provided, then all property values are retrieved.

Type Parameters:

E2 - the value type of the returned properties

Parameters:

includeTokens - whether to include T tokens in the emitted map.

propertyKeys - the properties to retrieve

Returns:

the traversal with an appended PropertyMapStep.

select

default <E2> GraphTraversal<S,Collection<E2>> select(Column column)

mapValues

@Deprecated
default <E2> GraphTraversal<S,E2> mapValues()

Deprecated. As of release 3.1.0, replaced by select(Column)

mapKeys

@Deprecated
default <E2> GraphTraversal<S,E2> mapKeys()

Deprecated. As of release 3.1.0, replaced by select(Column)

key

default GraphTraversal<S,String> key()

Map the Property to its Property.key().

Returns:

the traversal with an appended PropertyKeyStep.

value

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

Map the Property to its Property.value().

Returns:

the traversal with an appended PropertyValueStep.

path

default GraphTraversal<S,Path> path()

Map the Traverser to its Path history via Traverser.path().

Returns:

the traversal with an appended PathStep.

match

default <E2> GraphTraversal<S,Map<String,E2>> match(Traversal<?,?>... matchTraversals)

Map the Traverser to a Map of bindings as specified by the provided match traversals.

Type Parameters:

E2 - the type of the obejcts bound in the variables

Parameters:

matchTraversals - the traversal that maintain variables which must hold for the life of the traverser

Returns:

the traversal with an appended MatchStep.

sack

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

Map the Traverser to its Traverser.sack() value.

Type Parameters:

E2 - the sack value type

Returns:

the traversal with an appended SackStep.

loops

default GraphTraversal<S,Integer> loops()

project

default <E2> GraphTraversal<S,Map<String,E2>> project(String projectKey,
                                                      String... otherProjectKeys)

select

default <E2> GraphTraversal<S,Map<String,E2>> select(Pop pop,
                                                     String selectKey1,
                                                     String selectKey2,
                                                     String... otherSelectKeys)

Map the Traverser to a Map projection of sideEffect values, map values, and/or path values.

Type Parameters:

E2 - the type of the objects projected

Parameters:

pop - if there are multiple objects referenced in the path, the Pop to use.

selectKey1 - the first key to project

selectKey2 - the second key to project

otherSelectKeys - the third+ keys to project

Returns:

the traversal with an appended SelectStep.

select

default <E2> GraphTraversal<S,Map<String,E2>> select(String selectKey1,
                                                     String selectKey2,
                                                     String... otherSelectKeys)

Map the Traverser to a Map projection of sideEffect values, map values, and/or path values.

Type Parameters:

E2 - the type of the objects projected

Parameters:

selectKey1 - the first key to project

selectKey2 - the second key to project

otherSelectKeys - the third+ keys to project

Returns:

the traversal with an appended SelectStep.

select

default <E2> GraphTraversal<S,E2> select(Pop pop,
                                         String selectKey)

select

default <E2> GraphTraversal<S,E2> select(String selectKey)

unfold

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

fold

default GraphTraversal<S,List<E>> fold()

fold

default <E2> GraphTraversal<S,E2> fold(E2 seed,
                                       BiFunction<E2,E,E2> foldFunction)

count

default GraphTraversal<S,Long> count()

Map the traversal stream to its reduction as a sum of the Traverser.bulk() values (i.e. count the number of traversers up to this point).

Returns:

the traversal with an appended CountGlobalStep.

count

default GraphTraversal<S,Long> count(Scope scope)

sum

default <E2 extends Number> GraphTraversal<S,E2> sum()

Map the traversal stream to its reduction as a sum of the Traverser.get() values multiplied by their Traverser.bulk() (i.e. sum the traverser values up to this point).

Returns:

the traversal with an appended SumGlobalStep.

sum

default <E2 extends Number> GraphTraversal<S,E2> sum(Scope scope)

max

default <E2 extends Number> GraphTraversal<S,E2> max()

max

default <E2 extends Number> GraphTraversal<S,E2> max(Scope scope)

min

default <E2 extends Number> GraphTraversal<S,E2> min()

min

default <E2 extends Number> GraphTraversal<S,E2> min(Scope scope)

mean

default <E2 extends Number> GraphTraversal<S,E2> mean()

mean

default <E2 extends Number> GraphTraversal<S,E2> mean(Scope scope)

group

default <K,V> GraphTraversal<S,Map<K,V>> group()

groupV3d0

@Deprecated
default <K,V> GraphTraversal<S,Map<K,V>> groupV3d0()

Deprecated. As of release 3.1.0, replaced by group()

groupCount

default <K> GraphTraversal<S,Map<K,Long>> groupCount()

tree

default GraphTraversal<S,Tree> tree()

addV

default GraphTraversal<S,Vertex> addV(String vertexLabel)

addV

default GraphTraversal<S,Vertex> addV()

addV

@Deprecated
default GraphTraversal<S,Vertex> addV(Object... propertyKeyValues)

Deprecated. As of release 3.1.0, replaced by addV()

addE

default GraphTraversal<S,Edge> addE(String edgeLabel)

to

default GraphTraversal<S,E> to(String toStepLabel)

from

default GraphTraversal<S,E> from(String fromStepLabel)

to

default GraphTraversal<S,E> to(Traversal<E,Vertex> toVertex)

from

default GraphTraversal<S,E> from(Traversal<E,Vertex> fromVertex)

addE

@Deprecated
default GraphTraversal<S,Edge> addE(Direction direction,
                                                String firstVertexKeyOrEdgeLabel,
                                                String edgeLabelOrSecondVertexKey,
                                                Object... propertyKeyValues)

Deprecated. As of release 3.1.0, replaced by addE(String)

addOutE

@Deprecated
default GraphTraversal<S,Edge> addOutE(String firstVertexKeyOrEdgeLabel,
                                                   String edgeLabelOrSecondVertexKey,
                                                   Object... propertyKeyValues)

Deprecated. As of release 3.1.0, replaced by addE(String)

addInE

@Deprecated
default GraphTraversal<S,Edge> addInE(String firstVertexKeyOrEdgeLabel,
                                                  String edgeLabelOrSecondVertexKey,
                                                  Object... propertyKeyValues)

Deprecated. As of release 3.1.0, replaced by addE(String)

filter

default GraphTraversal<S,E> filter(Predicate<Traverser<E>> predicate)

filter

default GraphTraversal<S,E> filter(Traversal<?,?> filterTraversal)

or

default GraphTraversal<S,E> or(Traversal<?,?>... orTraversals)

and

default GraphTraversal<S,E> and(Traversal<?,?>... andTraversals)

inject

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

dedup

default GraphTraversal<S,E> dedup(Scope scope,
                                  String... dedupLabels)

Remove all duplicates in the traversal stream up to this point.

Parameters:

scope - whether the deduplication is on the stream (global) or the current object (local).

dedupLabels - if labels are provided, then the scope labels determine de-duplication. No labels implies current object.

Returns:

the traversal with an appended DedupGlobalStep.

dedup

default GraphTraversal<S,E> dedup(String... dedupLabels)

Remove all duplicates in the traversal stream up to this point.

Parameters:

dedupLabels - if labels are provided, then the scoped object's labels determine de-duplication. No labels implies current object.

Returns:

the traversal with an appended DedupGlobalStep.

where

default GraphTraversal<S,E> where(String startKey,
                                  P<String> predicate)

where

default GraphTraversal<S,E> where(P<String> predicate)

where

default GraphTraversal<S,E> where(Traversal<?,?> whereTraversal)

has

default GraphTraversal<S,E> has(String propertyKey,
                                P<?> predicate)

has

default GraphTraversal<S,E> has(T accessor,
                                P<?> predicate)

has

default GraphTraversal<S,E> has(String propertyKey,
                                Object value)

has

default GraphTraversal<S,E> has(T accessor,
                                Object value)

has

default GraphTraversal<S,E> has(String label,
                                String propertyKey,
                                P<?> predicate)

has

default GraphTraversal<S,E> has(String label,
                                String propertyKey,
                                Object value)

has

default GraphTraversal<S,E> has(T accessor,
                                Traversal<?,?> propertyTraversal)

has

default GraphTraversal<S,E> has(String propertyKey,
                                Traversal<?,?> propertyTraversal)

has

default GraphTraversal<S,E> has(String propertyKey)

hasNot

default GraphTraversal<S,E> hasNot(String propertyKey)

hasLabel

default GraphTraversal<S,E> hasLabel(String label,
                                     String... otherLabels)

hasLabel

default GraphTraversal<S,E> hasLabel(P<String> predicate)

hasId

default GraphTraversal<S,E> hasId(Object id,
                                  Object... otherIds)

hasId

default GraphTraversal<S,E> hasId(P<Object> predicate)

hasKey

default GraphTraversal<S,E> hasKey(String label,
                                   String... otherLabels)

hasKey

default GraphTraversal<S,E> hasKey(P<String> predicate)

hasValue

default GraphTraversal<S,E> hasValue(Object value,
                                     Object... otherValues)

hasValue

default GraphTraversal<S,E> hasValue(P<Object> predicate)

is

default GraphTraversal<S,E> is(P<E> predicate)

is

default GraphTraversal<S,E> is(Object value)

Filter the E object if it is not P.eq(V) to the provided value.

Parameters:

value - the value that the object must equal.

Returns:

the traversal with an appended IsStep.

not

default GraphTraversal<S,E> not(Traversal<?,?> notTraversal)

coin

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

Filter the E object given a biased coin toss.

Parameters:

probability - the probability that the object will pass through

Returns:

the traversal with an appended CoinStep.

range

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

range

default <E2> GraphTraversal<S,E2> range(Scope scope,
                                        long low,
                                        long high)

limit

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

limit

default <E2> GraphTraversal<S,E2> limit(Scope scope,
                                        long limit)

tail

default GraphTraversal<S,E> tail()

tail

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

tail

default <E2> GraphTraversal<S,E2> tail(Scope scope)

tail

default <E2> GraphTraversal<S,E2> tail(Scope scope,
                                       long limit)

timeLimit

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

Once the first Traverser hits this step, a count down is started. Once the time limit is up, all remaining traversers are filtered out.

Parameters:

timeLimit - the count down time

Returns:

the traversal with an appended TimeLimitStep

simplePath

default GraphTraversal<S,E> simplePath()

Filter the E object if its Traverser.path() is not Path.isSimple().

Returns:

the traversal with an appended SimplePathStep.

cyclicPath

default GraphTraversal<S,E> cyclicPath()

Filter the E object if its Traverser.path() is Path.isSimple().

Returns:

the traversal with an appended CyclicPathStep.

sample

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

sample

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

drop

default GraphTraversal<S,E> drop()

sideEffect

default GraphTraversal<S,E> sideEffect(Consumer<Traverser<E>> consumer)

sideEffect

default GraphTraversal<S,E> sideEffect(Traversal<?,?> sideEffectTraversal)

cap

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

subgraph

default GraphTraversal<S,Edge> subgraph(String sideEffectKey)

aggregate

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

group

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

groupV3d0

default GraphTraversal<S,E> groupV3d0(String sideEffectKey)

Deprecated. As of release 3.1.0, replaced by group(String).

groupCount

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

tree

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

sack

default <V,U> GraphTraversal<S,E> sack(BiFunction<V,U,V> sackOperator)

sack

@Deprecated
default <V,U> GraphTraversal<S,E> sack(BiFunction<V,U,V> sackOperator,
                                                   String elementPropertyKey)

Deprecated. As of release 3.1.0, replaced by sack(BiFunction) with by(String).

store

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

profile

default GraphTraversal<S,E> profile(String sideEffectKey)

profile

default GraphTraversal<S,TraversalMetrics> profile()

Description copied from interface: Traversal

Profile the traversal.

Specified by:

profile in interface Traversal<S,E>

Returns:

the updated traversal with respective ProfileSideEffectStep.

property

default GraphTraversal<S,E> property(VertexProperty.Cardinality cardinality,
                                     Object key,
                                     Object value,
                                     Object... keyValues)

Sets a Property value and related meta properties if supplied, if supported by the Graph and if the Element is a VertexProperty. This method is the long-hand version of property(Object, Object, Object...) with the difference that the VertexProperty.Cardinality can be supplied.

Generally speaking, this method will append an AddPropertyStep to the Traversal but when possible, this method will attempt to fold key/value pairs into an AddVertexStep, AddEdgeStep or AddVertexStartStep. This potential optimization can only happen if cardinality is not supplied and when meta-properties are not included.

Parameters:

cardinality - the specified cardinality of the property where null will allow the Graph to use its default settings

key - the key for the property

value - the value for the property

keyValues - any meta properties to be assigned to this property

property

default GraphTraversal<S,E> property(Object key,
                                     Object value,
                                     Object... keyValues)

Sets the key and value of a Property. If the Element is a VertexProperty and the Graph supports it, meta properties can be set. Use of this method assumes that the VertexProperty.Cardinality is defaulted to null which means that the default cardinality for the Graph will be used.

This method is effectively calls property(org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality, Object, Object, Object...) as property(null, key, value, keyValues.

Parameters:

key - the key for the property

value - the value for the property

keyValues - any meta properties to be assigned to this property

branch

default <M,E2> GraphTraversal<S,E2> branch(Traversal<?,M> branchTraversal)

branch

default <M,E2> GraphTraversal<S,E2> branch(Function<Traverser<E>,M> function)

choose

default <M,E2> GraphTraversal<S,E2> choose(Traversal<?,M> choiceTraversal)

choose

default <E2> GraphTraversal<S,E2> choose(Traversal<?,?> traversalPredicate,
                                         Traversal<?,E2> trueChoice,
                                         Traversal<?,E2> falseChoice)

choose

default <E2> GraphTraversal<S,E2> choose(Traversal<?,?> traversalPredicate,
                                         Traversal<?,E2> trueChoice)

choose

default <M,E2> GraphTraversal<S,E2> choose(Function<E,M> choiceFunction)

choose

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

choose

default <E2> GraphTraversal<S,E2> choose(Predicate<E> choosePredicate,
                                         Traversal<?,E2> trueChoice)

optional

default <E2> GraphTraversal<S,E2> optional(Traversal<?,E2> optionalTraversal)

union

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

coalesce

default <E2> GraphTraversal<S,E2> coalesce(Traversal<?,E2>... coalesceTraversals)

repeat

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

emit

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

emit

default GraphTraversal<S,E> emit(Predicate<Traverser<E>> emitPredicate)

emit

default GraphTraversal<S,E> emit()

until

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

until

default GraphTraversal<S,E> until(Predicate<Traverser<E>> untilPredicate)

times

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

local

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

pageRank

default GraphTraversal<S,E> pageRank()

pageRank

default GraphTraversal<S,E> pageRank(double alpha)

peerPressure

default GraphTraversal<S,E> peerPressure()

program

default GraphTraversal<S,E> program(VertexProgram<?> vertexProgram)

as

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

barrier

default GraphTraversal<S,E> barrier()

barrier

default GraphTraversal<S,E> barrier(int maxBarrierSize)

barrier

default GraphTraversal<S,E> barrier(Consumer<TraverserSet<Object>> barrierConsumer)

by

default GraphTraversal<S,E> by()

by

default GraphTraversal<S,E> by(Traversal<?,?> traversal)

by

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

by

default GraphTraversal<S,E> by(String key)

by

default <V> GraphTraversal<S,E> by(Function<V,Object> function)

by

default <V> GraphTraversal<S,E> by(Traversal<?,?> traversal,
                                   Comparator<V> comparator)

by

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

by

default GraphTraversal<S,E> by(Order order)

by

default <V> GraphTraversal<S,E> by(String key,
                                   Comparator<V> comparator)

by

default <U> GraphTraversal<S,E> by(Function<U,Object> function,
                                   Comparator comparator)

option

default <M,E2> GraphTraversal<S,E> option(M pickToken,
                                          Traversal<E,E2> traversalOption)

option

default <E2> GraphTraversal<S,E> option(Traversal<E,E2> traversalOption)

iterate

default GraphTraversal<S,E> iterate()

Description copied from interface: Traversal

Iterate all the Traverser instances in the traversal. What is returned is the empty traversal. It is assumed that what is desired from the computation is are the sideEffects yielded by the traversal.

Specified by:

iterate in interface Traversal<S,E>

Returns:

the fully drained traversal