Interface CredentialTraversal<S,E>
-
- All Superinterfaces:
AutoCloseable
,Cloneable
,CredentialTraversalDsl<S,E>
,GraphTraversal<S,E>
,GraphTraversal.Admin<S,E>
,Iterator<E>
,Serializable
,Traversal<S,E>
,Traversal.Admin<S,E>
- All Known Implementing Classes:
DefaultCredentialTraversal
public interface CredentialTraversal<S,E> extends CredentialTraversalDsl<S,E>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal
GraphTraversal.Admin<S,E>, GraphTraversal.Symbols
-
Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal
Traversal.Admin<S,E>, Traversal.Exceptions, Traversal.Symbols
-
-
Field Summary
-
Fields inherited from interface org.apache.tinkerpop.gremlin.groovy.jsr223.dsl.credential.CredentialTraversalDsl
BCRYPT_ROUNDS
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default CredentialTraversal<S,Edge>
addE(String edgeLabel)
Adds anEdge
with the specified edge label.default CredentialTraversal<S,Edge>
addE(Traversal<?,String> edgeLabelTraversal)
default CredentialTraversal<S,Vertex>
addV()
Adds aVertex
with a default vertex label.default CredentialTraversal<S,Vertex>
addV(String vertexLabel)
Adds aVertex
.default CredentialTraversal<S,Vertex>
addV(Traversal<?,String> vertexLabelTraversal)
default CredentialTraversal<S,E>
aggregate(String sideEffectKey)
Eagerly collects objects up to this step into a side-effect.default CredentialTraversal<S,E>
aggregate(Scope scope, String sideEffectKey)
Collects objects in a list using theScope
argument to determine whether it should be lazyScope.local
or eager (Scope.global
while gathering those objects.default <S2> CredentialTraversal<S,E>
all(P<S2> predicate)
FiltersE
lists given the providedpredicate
.default CredentialTraversal<S,E>
and(Traversal<?,?>... andTraversals)
Ensures that all of the provided traversals yield a result.default <S2> CredentialTraversal<S,E>
any(P<S2> predicate)
FiltersE
lists given the providedpredicate
.default CredentialTraversal<S,E>
as(String stepLabel, String... stepLabels)
A step modulator that provides a label to the step that can be accessed later in the traversal by other steps.default CredentialTraversal<S,Date>
asDate()
Parse value of the incoming traverser as an ISO-8601Date
.default CredentialTraversal<S,String>
asString()
Returns the value of incoming traverser as strings.default <E2> CredentialTraversal<S,E2>
asString(Scope scope)
Returns the value of incoming traverser as strings.default CredentialTraversal<S,E>
barrier()
Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to the size of the barrier.default CredentialTraversal<S,E>
barrier(int maxBarrierSize)
Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to the size of the barrier.default CredentialTraversal<S,E>
barrier(Consumer<TraverserSet<Object>> barrierConsumer)
Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to the size of the barrier.default CredentialTraversal<S,Vertex>
both(String... edgeLabels)
Map theVertex
to its adjacent vertices given the edge labels.default CredentialTraversal<S,Edge>
bothE(String... edgeLabels)
Map theVertex
to its incident edges given the edge labels.default CredentialTraversal<S,Vertex>
bothV()
Map theEdge
to its incident vertices.default <M,E2>
CredentialTraversal<S,E2>branch(Function<Traverser<E>,M> function)
Split theTraverser
to all the specified functions.default <M,E2>
CredentialTraversal<S,E2>branch(Traversal<?,M> branchTraversal)
Split theTraverser
to all the specified traversals.default CredentialTraversal<S,E>
by()
Theby()
can be applied to a number of different step to alter their behaviors.default CredentialTraversal<S,E>
by(String key)
Theby()
can be applied to a number of different step to alter their behaviors.default <V> CredentialTraversal<S,E>
by(String key, Comparator<V> comparator)
Theby()
can be applied to a number of different step to alter their behaviors.default CredentialTraversal<S,E>
by(Comparator<E> comparator)
Theby()
can be applied to a number of different step to alter their behaviors.default <U> CredentialTraversal<S,E>
by(Function<U,Object> function, Comparator comparator)
Theby()
can be applied to a number of different step to alter their behaviors.default <V> CredentialTraversal<S,E>
by(Function<V,Object> function)
Theby()
can be applied to a number of different step to alter their behaviors.default CredentialTraversal<S,E>
by(Order order)
Theby()
can be applied to a number of different step to alter their behaviors.default CredentialTraversal<S,E>
by(Traversal<?,?> traversal)
Theby()
can be applied to a number of different step to alter their behaviors.default <V> CredentialTraversal<S,E>
by(Traversal<?,?> traversal, Comparator<V> comparator)
Theby()
can be applied to a number of different step to alter their behaviors.default CredentialTraversal<S,E>
by(T token)
Theby()
can be applied to a number of different step to alter their behaviors.default <E> CredentialTraversal<S,E>
call(String service)
Perform the specified service call with no parameters.default <E> CredentialTraversal<S,E>
call(String service, Map params)
Perform the specified service call with the specified static parameters.default <E> CredentialTraversal<S,E>
call(String service, Map params, Traversal<?,Map<?,?>> childTraversal)
Perform the specified service call with both static and dynamic parameters produced by the specified child traversal.default <E> CredentialTraversal<S,E>
call(String service, Traversal<?,Map<?,?>> childTraversal)
Perform the specified service call with dynamic parameters produced by the specified child traversal.default <E2> CredentialTraversal<S,E2>
cap(String sideEffectKey, String... sideEffectKeys)
Iterates the traversal up to the itself and emits the side-effect referenced by the key.default <M,E2>
CredentialTraversal<S,E2>choose(Function<E,M> choiceFunction)
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.default <E2> CredentialTraversal<S,E2>
choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice)
Routes the current traverser to a particular traversal branch option which allows the creation of if-then like semantics within a traversal.default <E2> CredentialTraversal<S,E2>
choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.default <E2> CredentialTraversal<S,E2>
choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice)
Routes the current traverser to a particular traversal branch option which allows the creation of if-then like semantics within a traversal.default <E2> CredentialTraversal<S,E2>
choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.default <M,E2>
CredentialTraversal<S,E2>choose(Traversal<?,M> choiceTraversal)
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.default <E2> CredentialTraversal<S,E2>
coalesce(Traversal<?,E2>... coalesceTraversals)
Evaluates the provided traversals and returns the result of the first traversal to emit at least one object.default CredentialTraversal<S,E>
coin(double probability)
Filter theE
object given a biased coin toss.default CredentialTraversal<S,List<?>>
combine(Object values)
Combines the list traverser and list argument.default CredentialTraversal<S,String>
concat(String... concatStrings)
Concatenate an arbitrary number of strings to the incoming traverser.default CredentialTraversal<S,String>
concat(Traversal<?,String> concatTraversal, Traversal<?,String>... otherConcatTraversals)
Concatenate values of an arbitrary number of string traversals to the incoming traverser.default CredentialTraversal<S,String>
conjoin(String delimiter)
Joins together the elements of the incoming list traverser together with the provided delimiter.default CredentialTraversal<S,E>
connectedComponent()
Executes a Connected Component algorithm over the graph.default <E2> CredentialTraversal<S,E2>
constant(E2 e)
Map any object to a fixedE
value.default CredentialTraversal<S,Long>
count()
Map the traversal stream to its reduction as a sum of theTraverser.bulk()
values (i.e.default CredentialTraversal<S,Long>
count(Scope scope)
Map the traversal stream to its reduction as a sum of theTraverser.bulk()
values given the specifiedScope
(i.e.default CredentialTraversal<S,E>
cyclicPath()
default CredentialTraversal<S,Date>
dateAdd(DT dateToken, int value)
Increase value of inputDate
.default CredentialTraversal<S,Long>
dateDiff(Date value)
Returns the difference between twoDate
in epoch time.default CredentialTraversal<S,Long>
dateDiff(Traversal<?,Date> dateTraversal)
Returns the difference between twoDate
in epoch time.default CredentialTraversal<S,E>
dedup(String... dedupLabels)
Remove all duplicates in the traversal stream up to this point.default CredentialTraversal<S,E>
dedup(Scope scope, String... dedupLabels)
Remove all duplicates in the traversal stream up to this point.default CredentialTraversal<S,Set<?>>
difference(Object values)
Calculates the difference between the list traverser and list argument.default CredentialTraversal<S,Set<?>>
disjunct(Object values)
Calculates the disjunction between the list traverser and list argument.default CredentialTraversal<S,E>
drop()
Removes elements and properties from the graph.default CredentialTraversal<S,Edge>
E(Object... edgeIdsOrElements)
AE
step is usually used to start a traversal but it may also be used mid-traversal.default CredentialTraversal<S,Element>
element()
default <E2> CredentialTraversal<S,Map<Object,E2>>
elementMap(String... propertyKeys)
default CredentialTraversal<S,E>
emit()
Emit is used in conjunction withGraphTraversal.repeat(Traversal)
to emit all objects from the loop.default CredentialTraversal<S,E>
emit(Predicate<Traverser<E>> emitPredicate)
Emit is used in conjunction withGraphTraversal.repeat(Traversal)
to determine what objects get emit from the loop.default CredentialTraversal<S,E>
emit(Traversal<?,?> emitTraversal)
Emit is used in conjunction withGraphTraversal.repeat(Traversal)
to determine what objects get emit from the loop.default CredentialTraversal<S,E>
fail()
When triggered, immediately throws aRuntimeException
which implements theFailure
interface.default CredentialTraversal<S,E>
fail(String message)
When triggered, immediately throws aRuntimeException
which implements theFailure
interface.default CredentialTraversal<S,E>
filter(Predicate<Traverser<E>> predicate)
Map theTraverser
to eithertrue
orfalse
, wherefalse
will not pass the traverser to the next step.default CredentialTraversal<S,E>
filter(Traversal<?,?> filterTraversal)
Map theTraverser
to eithertrue
orfalse
, wherefalse
will not pass the traverser to the next step.default <E2> CredentialTraversal<S,E2>
flatMap(Function<Traverser<E>,Iterator<E2>> function)
default <E2> CredentialTraversal<S,E2>
flatMap(Traversal<?,E2> flatMapTraversal)
default CredentialTraversal<S,List<E>>
fold()
Rolls up objects in the stream into an aggregate list.default <E2> CredentialTraversal<S,E2>
fold(E2 seed, BiFunction<E2,E,E2> foldFunction)
Rolls up objects in the stream into an aggregate value as defined by aseed
andBiFunction
.default CredentialTraversal<S,String>
format(String format)
A mid-traversal step which will handle result formatting to string values.default CredentialTraversal<S,E>
from(String fromStepLabel)
Providefrom()
-modulation to respective steps.default CredentialTraversal<S,E>
from(Traversal<?,Vertex> fromVertex)
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the outgoing vertex of the newly addedEdge
.default CredentialTraversal<S,E>
from(Vertex fromVertex)
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the outgoing vertex of the newly addedEdge
.default <K,V>
CredentialTraversal<S,Map<K,V>>group()
Organize objects in the stream into aMap
.default CredentialTraversal<S,E>
group(String sideEffectKey)
Organize objects in the stream into aMap
.default <K> CredentialTraversal<S,Map<K,Long>>
groupCount()
Counts the number of times a particular objects has been part of a traversal, returning aMap
where the object is the key and the value is the count.default CredentialTraversal<S,E>
groupCount(String sideEffectKey)
Counts the number of times a particular objects has been part of a traversal, returning aMap
where the object is the key and the value is the count.default CredentialTraversal<S,E>
has(String propertyKey)
Filters vertices, edges and vertex properties based on the existence of properties.default CredentialTraversal<S,E>
has(String propertyKey, Object value)
Filters vertices, edges and vertex properties based on their properties.default CredentialTraversal<S,E>
has(String label, String propertyKey, Object value)
Filters vertices, edges and vertex properties based on their properties.default CredentialTraversal<S,E>
has(String label, String propertyKey, P<?> predicate)
Filters vertices, edges and vertex properties based on their properties.default CredentialTraversal<S,E>
has(String propertyKey, P<?> predicate)
Filters vertices, edges and vertex properties based on their properties.default CredentialTraversal<S,E>
has(String propertyKey, Traversal<?,?> propertyTraversal)
Filters vertices, edges and vertex properties based on the value of the specified property key.default CredentialTraversal<S,E>
has(T accessor, Object value)
Filters vertices, edges and vertex properties based on their properties.default CredentialTraversal<S,E>
has(T accessor, P<?> predicate)
Filters vertices, edges and vertex properties based on their properties.default CredentialTraversal<S,E>
has(T accessor, Traversal<?,?> propertyTraversal)
default CredentialTraversal<S,E>
hasId(Object id, Object... otherIds)
Filters vertices, edges and vertex properties based on their identifier.default CredentialTraversal<S,E>
hasId(P<Object> predicate)
Filters vertices, edges and vertex properties based on their identifier.default CredentialTraversal<S,E>
hasKey(String label, String... otherLabels)
FiltersProperty
objects based on their key.default CredentialTraversal<S,E>
hasKey(P<String> predicate)
FiltersProperty
objects based on their key.default CredentialTraversal<S,E>
hasLabel(String label, String... otherLabels)
Filters vertices, edges and vertex properties based on their label.default CredentialTraversal<S,E>
hasLabel(P<String> predicate)
Filters vertices, edges and vertex properties based on their label.default CredentialTraversal<S,E>
hasNot(String propertyKey)
Filters vertices, edges and vertex properties based on the non-existence of properties.default CredentialTraversal<S,E>
hasValue(Object value, Object... otherValues)
FiltersProperty
objects based on their value.default CredentialTraversal<S,E>
hasValue(P<Object> predicate)
FiltersProperty
objects based on their value.Note that calling this step withnull
is the same as callingGraphTraversal.hasValue(Object, Object...)
with a singlenull
.default CredentialTraversal<S,Object>
id()
Map theElement
to itsElement.id()
.default CredentialTraversal<S,E>
identity()
Map theE
object to itself.default CredentialTraversal<S,Vertex>
in(String... edgeLabels)
Map theVertex
to its incoming adjacent vertices given the edge labels.default <E2> CredentialTraversal<S,E2>
index()
Indexes all items of the current collection.default CredentialTraversal<S,Edge>
inE(String... edgeLabels)
Map theVertex
to its incoming incident edges given the edge labels.default CredentialTraversal<S,E>
inject(E... injections)
Provides a way to add arbitrary objects to a traversal stream.default CredentialTraversal<S,Set<?>>
intersect(Object values)
Calculates the intersection between the list traverser and list argument.default CredentialTraversal<S,Vertex>
inV()
default CredentialTraversal<S,E>
is(Object value)
Filter theE
object if it is notP.eq(V)
to the provided value.default CredentialTraversal<S,E>
is(P<E> predicate)
FiltersE
object values given the providedpredicate
.default CredentialTraversal<S,E>
iterate()
Iterate all theTraverser
instances in the traversal.default CredentialTraversal<S,String>
key()
Map theProperty
to itsProperty.key()
.default CredentialTraversal<S,String>
label()
Map theElement
to itsElement.label()
.default CredentialTraversal<S,Integer>
length()
Returns the length incoming string traverser.default <E2> CredentialTraversal<S,E2>
length(Scope scope)
Returns the length incoming string or list.default CredentialTraversal<S,E>
limit(long limit)
Filter the objects in the traversal by the number of them to pass through the stream, where only the firstn
objects are allowed as defined by thelimit
argument.default <E2> CredentialTraversal<S,E2>
limit(Scope scope, long limit)
Filter the objects in the traversal by the number of them to pass through the stream given theScope
, where only the firstn
objects are allowed as defined by thelimit
argument.default <E2> CredentialTraversal<S,E2>
local(Traversal<?,E2> localTraversal)
Provides a execute a specified traversal on a single element within a stream.default CredentialTraversal<S,Integer>
loops()
If theTraverser
supports looping then calling this method will extract the number of loops for that traverser.default CredentialTraversal<S,Integer>
loops(String loopName)
If theTraverser
supports looping then calling this method will extract the number of loops for that traverser for the named loop.default CredentialTraversal<S,String>
lTrim()
Returns a string with leading whitespace removed.default <E2> CredentialTraversal<S,E2>
lTrim(Scope scope)
Returns a string with leading whitespace removed.default <E2> CredentialTraversal<S,E2>
map(Function<Traverser<E>,E2> function)
default <E2> CredentialTraversal<S,E2>
map(Traversal<?,E2> mapTraversal)
default <E2> CredentialTraversal<S,Map<String,E2>>
match(Traversal<?,?>... matchTraversals)
default CredentialTraversal<S,Double>
math(String expression)
default <E2 extends Comparable>
CredentialTraversal<S,E2>max()
Determines the largest value in the stream.default <E2 extends Comparable>
CredentialTraversal<S,E2>max(Scope scope)
Determines the largest value in the stream given theScope
.default <E2 extends Number>
CredentialTraversal<S,E2>mean()
Determines the mean value in the stream.default <E2 extends Number>
CredentialTraversal<S,E2>mean(Scope scope)
Determines the mean value in the stream given theScope
.default <E2> CredentialTraversal<S,E2>
merge(Object values)
Merges the list traverser and list argument.default CredentialTraversal<S,Edge>
mergeE()
Spawns aGraphTraversal
by doing a merge (i.e.default CredentialTraversal<S,Edge>
mergeE(Map<Object,Object> searchCreate)
Spawns aGraphTraversal
by doing a merge (i.e.default CredentialTraversal<S,Edge>
mergeE(Traversal<?,Map<Object,Object>> searchCreate)
Spawns aGraphTraversal
by doing a merge (i.e.default CredentialTraversal<S,Vertex>
mergeV()
Performs a merge (i.e.default CredentialTraversal<S,Vertex>
mergeV(Map<Object,Object> searchCreate)
Performs a merge (i.e.default CredentialTraversal<S,Vertex>
mergeV(Traversal<?,Map<Object,Object>> searchCreate)
Performs a merge (i.e.default <E2 extends Comparable>
CredentialTraversal<S,E2>min()
Determines the smallest value in the stream.default <E2 extends Comparable>
CredentialTraversal<S,E2>min(Scope scope)
Determines the smallest value in the stream given theScope
.default CredentialTraversal<S,E>
none()
Filter all traversers in the traversal.default CredentialTraversal<S,E>
not(Traversal<?,?> notTraversal)
Removes objects from the traversal stream when the traversal provided as an argument returns any objects.default <M,E2>
CredentialTraversal<S,E>option(M token, Map<Object,Object> m)
This is a step modulator to aTraversalOptionParent
likechoose()
ormergeV()
where the provided argument associated to thetoken
is applied according to the semantics of the step.default <M,E2>
CredentialTraversal<S,E>option(M token, Traversal<?,E2> traversalOption)
This is a step modulator to aTraversalOptionParent
likechoose()
ormergeV()
where the provided argument associated to thetoken
is applied according to the semantics of the step.default <M,E2>
CredentialTraversal<S,E>option(Merge merge, Map<Object,Object> m, VertexProperty.Cardinality cardinality)
This is a step modulator to aTraversalOptionParent
likechoose()
ormergeV()
where the provided argument associated to thetoken
is applied according to the semantics of the step.default <E2> CredentialTraversal<S,E>
option(Traversal<?,E2> traversalOption)
This step modifiesGraphTraversal.choose(Function)
to specifies the available choices that might be executed.default <E2> CredentialTraversal<S,E2>
optional(Traversal<?,E2> optionalTraversal)
Returns the result of the specified traversal if it yields a result, otherwise it returns the calling element.default CredentialTraversal<S,E>
or(Traversal<?,?>... orTraversals)
Ensures that at least one of the provided traversals yield a result.default CredentialTraversal<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 CredentialTraversal<S,E>
order(Scope scope)
Order either theScope.local
object (e.g.default CredentialTraversal<S,Vertex>
otherV()
Map theEdge
to the incident vertex that was not just traversed from in the path history.default CredentialTraversal<S,Vertex>
out(String... edgeLabels)
Map theVertex
to its outgoing adjacent vertices given the edge labels.default CredentialTraversal<S,Edge>
outE(String... edgeLabels)
Map theVertex
to its outgoing incident edges given the edge labels.default CredentialTraversal<S,Vertex>
outV()
default CredentialTraversal<S,E>
pageRank()
Calculates a PageRank over the graph using a 0.85 for thealpha
value.default CredentialTraversal<S,E>
pageRank(double alpha)
Calculates a PageRank over the graph.default CredentialTraversal<S,Path>
path()
default CredentialTraversal<S,E>
peerPressure()
Executes a Peer Pressure community detection algorithm over the graph.default CredentialTraversal<S,List<List<?>>>
product(Object values)
Calculates the cartesian product between the list traverser and list argument.default CredentialTraversal<S,TraversalMetrics>
profile()
Profile the traversal.default CredentialTraversal<S,E>
profile(String sideEffectKey)
Allows developers to examine statistical information about a traversal providing data like execution times, counts, etc.default CredentialTraversal<S,E>
program(VertexProgram<?> vertexProgram)
Executes an arbitraryVertexProgram
over the graph.default <E2> CredentialTraversal<S,Map<String,E2>>
project(String projectKey, String... otherProjectKeys)
Projects the current object in the stream into aMap
that is keyed by the provided labels.default <E2> CredentialTraversal<S,? extends Property<E2>>
properties(String... propertyKeys)
Map theElement
to its associated properties given the provide property keys.default CredentialTraversal<S,E>
property(Object key, Object value, Object... keyValues)
Sets the key and value of aProperty
.default CredentialTraversal<S,E>
property(Map<Object,Object> value)
When aMap
is supplied then each of the key/value pairs in the map will be added as property.default CredentialTraversal<S,E>
property(VertexProperty.Cardinality cardinality, Object key, Object value, Object... keyValues)
Sets aProperty
value and related meta properties if supplied, if supported by theGraph
and if theElement
is aVertexProperty
.default <E2> CredentialTraversal<S,Map<String,E2>>
propertyMap(String... propertyKeys)
default CredentialTraversal<S,E>
range(long low, long high)
Filter the objects in the traversal by the number of them to pass through the stream.default <E2> CredentialTraversal<S,E2>
range(Scope scope, long low, long high)
Filter the objects in the traversal by the number of them to pass through the stream as constrained by theScope
.default CredentialTraversal<S,E>
read()
This step is technically a step modulator for the theGraphTraversalSource.io(String)
step which instructs the step to perform a read with its given configuration.default CredentialTraversal<S,E>
repeat(String loopName, Traversal<?,E> repeatTraversal)
This step is used for looping over a traversal given some break predicate and with a specified loop name.default CredentialTraversal<S,E>
repeat(Traversal<?,E> repeatTraversal)
This step is used for looping over a traversal given some break predicate.default CredentialTraversal<S,String>
replace(String oldChar, String newChar)
Returns a string with the specified characters in the original string replaced with the new characters.default <E2> CredentialTraversal<S,E2>
replace(Scope scope, String oldChar, String newChar)
Returns a string with the specified characters in the original string replaced with the new characters.default <E2> CredentialTraversal<S,E2>
reverse()
Returns the reverse of the incoming traverser.default CredentialTraversal<S,String>
rTrim()
Returns a string with trailing whitespace removed.default <E2> CredentialTraversal<S,E2>
rTrim(Scope scope)
Returns a string with trailing whitespace removed.default <E2> CredentialTraversal<S,E2>
sack()
Map theTraverser
to itsTraverser.sack()
value.default <V,U>
CredentialTraversal<S,E>sack(BiFunction<V,U,V> sackOperator)
Map theTraverser
to itsTraverser.sack()
value.default CredentialTraversal<S,E>
sample(int amountToSample)
Allow some specified number of objects to pass through the stream.default CredentialTraversal<S,E>
sample(Scope scope, int amountToSample)
Allow some specified number of objects to pass through the stream.default <E2> CredentialTraversal<S,E2>
select(String selectKey)
Map theTraverser
to the object specified by theselectKey
.default <E2> CredentialTraversal<S,Map<String,E2>>
select(String selectKey1, String selectKey2, String... otherSelectKeys)
default <E2> CredentialTraversal<S,E2>
select(Pop pop, String selectKey)
default <E2> CredentialTraversal<S,Map<String,E2>>
select(Pop pop, String selectKey1, String selectKey2, String... otherSelectKeys)
default <E2> CredentialTraversal<S,E2>
select(Pop pop, Traversal<S,E2> keyTraversal)
default <E2> CredentialTraversal<S,E2>
select(Traversal<S,E2> keyTraversal)
Map theTraverser
to the object specified by the key returned by thekeyTraversal
.default <E2> CredentialTraversal<S,Collection<E2>>
select(Column column)
A version ofselect
that allows for the extraction of aColumn
from objects in the traversal.default CredentialTraversal<S,Path>
shortestPath()
Executes a Shortest Path algorithm over the graph.default CredentialTraversal<S,E>
sideEffect(Consumer<Traverser<E>> consumer)
Perform some operation on theTraverser
and pass it to the next step unmodified.default CredentialTraversal<S,E>
sideEffect(Traversal<?,?> sideEffectTraversal)
Perform some operation on theTraverser
and pass it to the next step unmodified.default CredentialTraversal<S,E>
simplePath()
default CredentialTraversal<S,E>
skip(long skip)
Filters out the firstn
objects in the traversal.default <E2> CredentialTraversal<S,E2>
skip(Scope scope, long skip)
Filters out the firstn
objects in the traversal.default CredentialTraversal<S,List<String>>
split(String separator)
Returns a list of strings created by splitting the incoming string traverser around the matches of the given separator.default <E2> CredentialTraversal<S,List<E2>>
split(Scope scope, String separator)
Returns a list of strings created by splitting the incoming string traverser around the matches of the given separator.default CredentialTraversal<S,E>
store(String sideEffectKey)
Lazily aggregates objects in the stream into a side-effect collection.default CredentialTraversal<S,Edge>
subgraph(String sideEffectKey)
Extracts a portion of the graph being traversed into aGraph
object held in the specified side-effect key.default CredentialTraversal<S,String>
substring(int startIndex)
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) specified, to the end of the string.default CredentialTraversal<S,String>
substring(int startIndex, int endIndex)
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) and end index (exclusive).default <E2> CredentialTraversal<S,E2>
substring(Scope scope, int startIndex)
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) specified, to the end of the string.default <E2> CredentialTraversal<S,E2>
substring(Scope scope, int startIndex, int endIndex)
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) and end index (exclusive).default <E2 extends Number>
CredentialTraversal<S,E2>sum()
Map the traversal stream to its reduction as a sum of theTraverser.get()
values multiplied by theirTraverser.bulk()
(i.e.default <E2 extends Number>
CredentialTraversal<S,E2>sum(Scope scope)
Map the traversal stream to its reduction as a sum of theTraverser.get()
values multiplied by theirTraverser.bulk()
given the specifiedScope
(i.e.default CredentialTraversal<S,E>
tail()
Filters the objects in the traversal emitted as being last objects in the stream.default CredentialTraversal<S,E>
tail(long limit)
Filters the objects in the traversal emitted as being last objects in the stream.default <E2> CredentialTraversal<S,E2>
tail(Scope scope)
Filters the objects in the traversal emitted as being last objects in the stream given theScope
.default <E2> CredentialTraversal<S,E2>
tail(Scope scope, long limit)
Filters the objects in the traversal emitted as being last objects in the stream given theScope
.default CredentialTraversal<S,E>
timeLimit(long timeLimit)
Once the firstTraverser
hits this step, a count down is started.default CredentialTraversal<S,E>
times(int maxLoops)
Modifies aGraphTraversal.repeat(Traversal)
to specify how many loops should occur before exiting.default CredentialTraversal<S,E>
to(String toStepLabel)
Provideto()
-modulation to respective steps.default CredentialTraversal<S,E>
to(Traversal<?,Vertex> toVertex)
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the incoming vertex of the newly addedEdge
.default CredentialTraversal<S,Vertex>
to(Direction direction, String... edgeLabels)
Map theVertex
to its adjacent vertices given a direction and edge labels.default CredentialTraversal<S,E>
to(Vertex toVertex)
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the incoming vertex of the newly addedEdge
.default CredentialTraversal<S,Edge>
toE(Direction direction, String... edgeLabels)
Map theVertex
to its incident edges given the direction and edge labels.default CredentialTraversal<S,String>
toLower()
Returns the lowercase representation of incoming string traverser.default <E2> CredentialTraversal<S,E2>
toLower(Scope scope)
Returns the lowercase representation of incoming string or list of strings.default CredentialTraversal<S,String>
toUpper()
Returns the uppercase representation of incoming string traverser.default <E2> CredentialTraversal<S,E2>
toUpper(Scope scope)
Returns the uppercase representation of incoming string or list of strings.default CredentialTraversal<S,Vertex>
toV(Direction direction)
Map theEdge
to its incident vertices given the direction.default CredentialTraversal<S,Tree>
tree()
Aggregates the emanating paths into aTree
data structure.default CredentialTraversal<S,E>
tree(String sideEffectKey)
Aggregates the emanating paths into aTree
data structure.default CredentialTraversal<S,String>
trim()
Returns a string with leading and trailing whitespace removed.default <E2> CredentialTraversal<S,E2>
trim(Scope scope)
Returns a string with leading and trailing whitespace removed.default <E2> CredentialTraversal<S,E2>
unfold()
Unrolls aIterator
,Iterable
orMap
into a linear form or simply emits the object if it is not one of those types.default <E2> CredentialTraversal<S,E2>
union(Traversal<?,E2>... unionTraversals)
Merges the results of an arbitrary number of traversals.default CredentialTraversal<S,E>
until(Predicate<Traverser<E>> untilPredicate)
Modifies aGraphTraversal.repeat(Traversal)
to determine when the loop should exit.default CredentialTraversal<S,E>
until(Traversal<?,?> untilTraversal)
Modifies aGraphTraversal.repeat(Traversal)
to determine when the loop should exit.default CredentialTraversal<S,Vertex>
user(String username, String password)
Creates or updates a user.default CredentialTraversal<S,Vertex>
users()
Finds all users.default CredentialTraversal<S,Vertex>
users(String username, String... more)
Finds users by name.default CredentialTraversal<S,Vertex>
V(Object... vertexIdsOrElements)
AV
step is usually used to start a traversal but it may also be used mid-traversal.default <E2> CredentialTraversal<S,E2>
value()
Map theProperty
to itsProperty.value()
.default <E2> CredentialTraversal<S,Map<Object,E2>>
valueMap(boolean includeTokens, String... propertyKeys)
default <E2> CredentialTraversal<S,Map<Object,E2>>
valueMap(String... propertyKeys)
default <E2> CredentialTraversal<S,E2>
values(String... propertyKeys)
Map theElement
to the values of the associated properties given the provide property keys.default CredentialTraversal<S,E>
where(String startKey, P<String> predicate)
Filters the current object based on the object itself or the path history.default CredentialTraversal<S,E>
where(P<String> predicate)
Filters the current object based on the object itself or the path history.default CredentialTraversal<S,E>
where(Traversal<?,?> whereTraversal)
Filters the current object based on the object itself or the path history.default CredentialTraversal<S,E>
with(String key)
Provides a configuration to a step in the form of a key which is the same aswith(key, true)
.default CredentialTraversal<S,E>
with(String key, Object value)
Provides a configuration to a step in the form of a key and value pair.default CredentialTraversal<S,E>
write()
This step is technically a step modulator for the theGraphTraversalSource.io(String)
step which instructs the step to perform a write with its given configuration.-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal
asAdmin
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal.Admin
addStep, clone
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal
close, explain, fill, forEachRemaining, forEachRemaining, next, notifyClose, promise, toBulkSet, toList, toSet, toStream, tryNext
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin
addStart, addStarts, addStep, applyStrategies, equals, getBytecode, getEndStep, getGraph, getParent, getSideEffects, getStartStep, getSteps, getStrategies, getTraversalSource, getTraverserGenerator, getTraverserRequirements, getTraverserSetSupplier, isLocked, isRoot, lock, nextTraverser, removeStep, removeStep, reset, setGraph, setParent, setSideEffects, setStrategies
-
-
-
-
Method Detail
-
users
default CredentialTraversal<S,Vertex> users()
Description copied from interface:CredentialTraversalDsl
Finds all users.- Specified by:
users
in interfaceCredentialTraversalDsl<S,E>
-
users
default CredentialTraversal<S,Vertex> users(String username, String... more)
Description copied from interface:CredentialTraversalDsl
Finds users by name.- Specified by:
users
in interfaceCredentialTraversalDsl<S,E>
-
user
default CredentialTraversal<S,Vertex> user(String username, String password)
Description copied from interface:CredentialTraversalDsl
Creates or updates a user.- Specified by:
user
in interfaceCredentialTraversalDsl<S,E>
-
map
default <E2> CredentialTraversal<S,E2> map(Function<Traverser<E>,E2> function)
Description copied from interface:GraphTraversal
- Specified by:
map
in interfaceGraphTraversal<S,E>
- Parameters:
function
- the lambda expression that does the functional mapping- Returns:
- the traversal with an appended
LambdaMapStep
. - See Also:
- Reference Documentation - General Steps
-
map
default <E2> CredentialTraversal<S,E2> map(Traversal<?,E2> mapTraversal)
Description copied from interface:GraphTraversal
- Specified by:
map
in interfaceGraphTraversal<S,E>
- Parameters:
mapTraversal
- the traversal expression that does the functional mapping- Returns:
- the traversal with an appended
LambdaMapStep
. - See Also:
- Reference Documentation - General Steps
-
flatMap
default <E2> CredentialTraversal<S,E2> flatMap(Function<Traverser<E>,Iterator<E2>> function)
Description copied from interface:GraphTraversal
Map aTraverser
referencing an object of typeE
to an iterator of objects of typeE2
. The resultant iterator is drained one-by-one before a newE
object is pulled in for processing.- Specified by:
flatMap
in interfaceGraphTraversal<S,E>
- 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
. - See Also:
- Reference Documentation - General Steps
-
flatMap
default <E2> CredentialTraversal<S,E2> flatMap(Traversal<?,E2> flatMapTraversal)
Description copied from interface:GraphTraversal
Map aTraverser
referencing an object of typeE
to an iterator of objects of typeE2
. The internal traversal is drained one-by-one before a newE
object is pulled in for processing.- Specified by:
flatMap
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the end type of the internal traversal- Parameters:
flatMapTraversal
- the traversal generating objects of typeE2
- Returns:
- the traversal with an appended
TraversalFlatMapStep
. - See Also:
- Reference Documentation - General Steps
-
id
default CredentialTraversal<S,Object> id()
Description copied from interface:GraphTraversal
Map theElement
to itsElement.id()
.- Specified by:
id
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
IdStep
. - See Also:
- Reference Documentation - Id Step
-
label
default CredentialTraversal<S,String> label()
Description copied from interface:GraphTraversal
Map theElement
to itsElement.label()
.- Specified by:
label
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
LabelStep
. - See Also:
- Reference Documentation - Label Step
-
identity
default CredentialTraversal<S,E> identity()
Description copied from interface:GraphTraversal
Map theE
object to itself. In other words, a "no op."- Specified by:
identity
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
IdentityStep
.
-
constant
default <E2> CredentialTraversal<S,E2> constant(E2 e)
Description copied from interface:GraphTraversal
Map any object to a fixedE
value.- Specified by:
constant
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ConstantStep
. - See Also:
- Reference Documentation - Constant Step
-
V
default CredentialTraversal<S,Vertex> V(Object... vertexIdsOrElements)
Description copied from interface:GraphTraversal
AV
step is usually used to start a traversal but it may also be used mid-traversal.- Specified by:
V
in interfaceGraphTraversal<S,E>
- Parameters:
vertexIdsOrElements
- vertices to inject into the traversal- Returns:
- the traversal with an appended
GraphStep
- See Also:
- Reference Documentation - Graph Step
-
E
default CredentialTraversal<S,Edge> E(Object... edgeIdsOrElements)
Description copied from interface:GraphTraversal
AE
step is usually used to start a traversal but it may also be used mid-traversal.- Specified by:
E
in interfaceGraphTraversal<S,E>
- Parameters:
edgeIdsOrElements
- edges to inject into the traversal- Returns:
- the traversal with an appended
GraphStep
- See Also:
- Reference Documentation - E Step
-
to
default CredentialTraversal<S,Vertex> to(Direction direction, String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its adjacent vertices given a direction and edge labels.- Specified by:
to
in interfaceGraphTraversal<S,E>
- Parameters:
direction
- the direction to traverse from the current vertexedgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
out
default CredentialTraversal<S,Vertex> out(String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its outgoing adjacent vertices given the edge labels.- Specified by:
out
in interfaceGraphTraversal<S,E>
- Parameters:
edgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
in
default CredentialTraversal<S,Vertex> in(String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its incoming adjacent vertices given the edge labels.- Specified by:
in
in interfaceGraphTraversal<S,E>
- Parameters:
edgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
both
default CredentialTraversal<S,Vertex> both(String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its adjacent vertices given the edge labels.- Specified by:
both
in interfaceGraphTraversal<S,E>
- Parameters:
edgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
toE
default CredentialTraversal<S,Edge> toE(Direction direction, String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its incident edges given the direction and edge labels.- Specified by:
toE
in interfaceGraphTraversal<S,E>
- Parameters:
direction
- the direction to traverse from the current vertexedgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
outE
default CredentialTraversal<S,Edge> outE(String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its outgoing incident edges given the edge labels.- Specified by:
outE
in interfaceGraphTraversal<S,E>
- Parameters:
edgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
inE
default CredentialTraversal<S,Edge> inE(String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its incoming incident edges given the edge labels.- Specified by:
inE
in interfaceGraphTraversal<S,E>
- Parameters:
edgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
bothE
default CredentialTraversal<S,Edge> bothE(String... edgeLabels)
Description copied from interface:GraphTraversal
Map theVertex
to its incident edges given the edge labels.- Specified by:
bothE
in interfaceGraphTraversal<S,E>
- Parameters:
edgeLabels
- the edge labels to traverse- Returns:
- the traversal with an appended
VertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
toV
default CredentialTraversal<S,Vertex> toV(Direction direction)
Description copied from interface:GraphTraversal
Map theEdge
to its incident vertices given the direction.- Specified by:
toV
in interfaceGraphTraversal<S,E>
- Parameters:
direction
- the direction to traverser from the current edge- Returns:
- the traversal with an appended
EdgeVertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
inV
default CredentialTraversal<S,Vertex> inV()
Description copied from interface:GraphTraversal
- Specified by:
inV
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
EdgeVertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
outV
default CredentialTraversal<S,Vertex> outV()
Description copied from interface:GraphTraversal
- Specified by:
outV
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
EdgeVertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
bothV
default CredentialTraversal<S,Vertex> bothV()
Description copied from interface:GraphTraversal
Map theEdge
to its incident vertices.- Specified by:
bothV
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
EdgeVertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
otherV
default CredentialTraversal<S,Vertex> otherV()
Description copied from interface:GraphTraversal
Map theEdge
to the incident vertex that was not just traversed from in the path history.- Specified by:
otherV
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
EdgeOtherVertexStep
. - See Also:
- Reference Documentation - Vertex Step
-
order
default CredentialTraversal<S,E> order()
Description copied from interface:GraphTraversal
Order all the objects in the traversal up to this point and then emit them one-by-one in their ordered sequence.- Specified by:
order
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
OrderGlobalStep
. - See Also:
- Reference Documentation - Order Step
-
order
default CredentialTraversal<S,E> order(Scope scope)
Description copied from interface:GraphTraversal
Order either theScope.local
object (e.g. a list, map, etc.) or the entireScope.global
traversal stream.- Specified by:
order
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- whether the ordering is the current local object or the entire global stream.- Returns:
- the traversal with an appended
OrderGlobalStep
orOrderLocalStep
depending on thescope
. - See Also:
- Reference Documentation - Order Step
-
properties
default <E2> CredentialTraversal<S,? extends Property<E2>> properties(String... propertyKeys)
Description copied from interface:GraphTraversal
Map theElement
to its associated properties given the provide property keys. If no property keys are provided, then all properties are emitted.- Specified by:
properties
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the value type of the returned properties- Parameters:
propertyKeys
- the properties to retrieve- Returns:
- the traversal with an appended
PropertiesStep
. - See Also:
- Reference Documentation - Properties Step
-
values
default <E2> CredentialTraversal<S,E2> values(String... propertyKeys)
Description copied from interface:GraphTraversal
Map theElement
to the values of the associated properties given the provide property keys. If no property keys are provided, then all property values are emitted.- Specified by:
values
in interfaceGraphTraversal<S,E>
- 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
. - See Also:
- Reference Documentation - Values Step
-
propertyMap
default <E2> CredentialTraversal<S,Map<String,E2>> propertyMap(String... propertyKeys)
Description copied from interface:GraphTraversal
Map theElement
to aMap
of the properties key'd according to theirProperty.key()
. If no property keys are provided, then all properties are retrieved.- Specified by:
propertyMap
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the value type of the returned properties- Parameters:
propertyKeys
- the properties to retrieve- Returns:
- the traversal with an appended
PropertyMapStep
. - See Also:
- Reference Documentation - PropertyMap Step
-
elementMap
default <E2> CredentialTraversal<S,Map<Object,E2>> elementMap(String... propertyKeys)
Description copied from interface:GraphTraversal
Map theElement
to aMap
of the property values key'd according to theirProperty.key()
. If no property keys are provided, then all property values are retrieved. For vertices, theMap
will be returned with the assumption of single property values along withT.id
andT.label
. PreferGraphTraversal.valueMap(String...)
if multi-property processing is required. For edges, keys will include additional related edge structure ofDirection.IN
andDirection.OUT
which themselves areMap
instances of the particularVertex
represented byT.id
andT.label
.- Specified by:
elementMap
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the value type of the returned properties- Parameters:
propertyKeys
- the properties to retrieve- Returns:
- the traversal with an appended
ElementMapStep
. - See Also:
- Reference Documentation - ElementMap Step
-
valueMap
default <E2> CredentialTraversal<S,Map<Object,E2>> valueMap(String... propertyKeys)
Description copied from interface:GraphTraversal
Map theElement
to aMap
of the property values key'd according to theirProperty.key()
. If no property keys are provided, then all property values are retrieved.- Specified by:
valueMap
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the value type of the returned properties- Parameters:
propertyKeys
- the properties to retrieve- Returns:
- the traversal with an appended
PropertyMapStep
. - See Also:
- Reference Documentation - ValueMap Step
-
valueMap
default <E2> CredentialTraversal<S,Map<Object,E2>> valueMap(boolean includeTokens, String... propertyKeys)
Description copied from interface:GraphTraversal
Map theElement
to aMap
of the property values key'd according to theirProperty.key()
. If no property keys are provided, then all property values are retrieved.- Specified by:
valueMap
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the value type of the returned properties- Parameters:
includeTokens
- whether to includeT
tokens in the emitted map.propertyKeys
- the properties to retrieve- Returns:
- the traversal with an appended
PropertyMapStep
. - See Also:
- Reference Documentation - ValueMap Step
-
key
default CredentialTraversal<S,String> key()
Description copied from interface:GraphTraversal
Map theProperty
to itsProperty.key()
.- Specified by:
key
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
PropertyKeyStep
. - See Also:
- Reference Documentation - Key Step
-
value
default <E2> CredentialTraversal<S,E2> value()
Description copied from interface:GraphTraversal
Map theProperty
to itsProperty.value()
.- Specified by:
value
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
PropertyValueStep
. - See Also:
- Reference Documentation - Value Step
-
path
default CredentialTraversal<S,Path> path()
Description copied from interface:GraphTraversal
- Specified by:
path
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
PathStep
. - See Also:
- Reference Documentation - Path Step
-
match
default <E2> CredentialTraversal<S,Map<String,E2>> match(Traversal<?,?>... matchTraversals)
Description copied from interface:GraphTraversal
- Specified by:
match
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the type of the objects 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
. - See Also:
- Reference Documentation - Match Step
-
sack
default <E2> CredentialTraversal<S,E2> sack()
Description copied from interface:GraphTraversal
Map theTraverser
to itsTraverser.sack()
value.- Specified by:
sack
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the sack value type- Returns:
- the traversal with an appended
SackStep
. - See Also:
- Reference Documentation - Sack Step
-
loops
default CredentialTraversal<S,Integer> loops()
Description copied from interface:GraphTraversal
If theTraverser
supports looping then calling this method will extract the number of loops for that traverser.- Specified by:
loops
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
LoopsStep
- See Also:
- Reference Documentation - Loops Step
-
loops
default CredentialTraversal<S,Integer> loops(String loopName)
Description copied from interface:GraphTraversal
If theTraverser
supports looping then calling this method will extract the number of loops for that traverser for the named loop.- Specified by:
loops
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
LoopsStep
- See Also:
- Reference Documentation - Loops Step
-
project
default <E2> CredentialTraversal<S,Map<String,E2>> project(String projectKey, String... otherProjectKeys)
Description copied from interface:GraphTraversal
Projects the current object in the stream into aMap
that is keyed by the provided labels.- Specified by:
project
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ProjectStep
- See Also:
- Reference Documentation - Project Step
-
select
default <E2> CredentialTraversal<S,Map<String,E2>> select(Pop pop, String selectKey1, String selectKey2, String... otherSelectKeys)
Description copied from interface:GraphTraversal
- Specified by:
select
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the type of the objects projected- Parameters:
pop
- if there are multiple objects referenced in the path, thePop
to use.selectKey1
- the first key to projectselectKey2
- the second key to projectotherSelectKeys
- the third+ keys to project- Returns:
- the traversal with an appended
SelectStep
. - See Also:
- Reference Documentation - Select Step
-
select
default <E2> CredentialTraversal<S,Map<String,E2>> select(String selectKey1, String selectKey2, String... otherSelectKeys)
Description copied from interface:GraphTraversal
- Specified by:
select
in interfaceGraphTraversal<S,E>
- Type Parameters:
E2
- the type of the objects projected- Parameters:
selectKey1
- the first key to projectselectKey2
- the second key to projectotherSelectKeys
- the third+ keys to project- Returns:
- the traversal with an appended
SelectStep
. - See Also:
- Reference Documentation - Select Step
-
select
default <E2> CredentialTraversal<S,E2> select(Pop pop, String selectKey)
Description copied from interface:GraphTraversal
- Specified by:
select
in interfaceGraphTraversal<S,E>
selectKey
- the key to project- Returns:
- the traversal with an appended
SelectStep
. - See Also:
- Reference Documentation - Select Step
-
select
default <E2> CredentialTraversal<S,E2> select(String selectKey)
Description copied from interface:GraphTraversal
Map theTraverser
to the object specified by theselectKey
. Note that unlike other uses ofselect
where there are multiple keys, this use ofselect
with a single key does not produce aMap
.- Specified by:
select
in interfaceGraphTraversal<S,E>
- Parameters:
selectKey
- the key to project- Returns:
- the traversal with an appended
SelectStep
. - See Also:
- Reference Documentation - Select Step
-
select
default <E2> CredentialTraversal<S,E2> select(Pop pop, Traversal<S,E2> keyTraversal)
Description copied from interface:GraphTraversal
Map theTraverser
to the object specified by the key returned by thekeyTraversal
and apply thePop
operation to it.- Specified by:
select
in interfaceGraphTraversal<S,E>
keyTraversal
- the traversal expression that selects the key to project- Returns:
- the traversal with an appended
SelectStep
. - See Also:
- Reference Documentation - Select Step
-
select
default <E2> CredentialTraversal<S,E2> select(Traversal<S,E2> keyTraversal)
Description copied from interface:GraphTraversal
Map theTraverser
to the object specified by the key returned by thekeyTraversal
. Note that unlike other uses ofselect
where there are multiple keys, this use ofselect
with a traversal does not produce aMap
.- Specified by:
select
in interfaceGraphTraversal<S,E>
- Parameters:
keyTraversal
- the traversal expression that selects the key to project- Returns:
- the traversal with an appended
TraversalSelectStep
. - See Also:
- Reference Documentation - Select Step
-
select
default <E2> CredentialTraversal<S,Collection<E2>> select(Column column)
Description copied from interface:GraphTraversal
A version ofselect
that allows for the extraction of aColumn
from objects in the traversal.- Specified by:
select
in interfaceGraphTraversal<S,E>
- Parameters:
column
- the column to extract- Returns:
- the traversal with an appended
TraversalMapStep
- See Also:
- Reference Documentation - Select Step
-
unfold
default <E2> CredentialTraversal<S,E2> unfold()
Description copied from interface:GraphTraversal
Unrolls aIterator
,Iterable
orMap
into a linear form or simply emits the object if it is not one of those types.- Specified by:
unfold
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
UnfoldStep
- See Also:
- Reference Documentation - Unfold Step
-
fold
default CredentialTraversal<S,List<E>> fold()
Description copied from interface:GraphTraversal
Rolls up objects in the stream into an aggregate list.- Specified by:
fold
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
FoldStep
- See Also:
- Reference Documentation - Fold Step
-
fold
default <E2> CredentialTraversal<S,E2> fold(E2 seed, BiFunction<E2,E,E2> foldFunction)
Description copied from interface:GraphTraversal
Rolls up objects in the stream into an aggregate value as defined by aseed
andBiFunction
.- Specified by:
fold
in interfaceGraphTraversal<S,E>
- Parameters:
seed
- the value to provide as the first argument to thefoldFunction
foldFunction
- the function to fold by where the first argument is theseed
or the value returned from subsequent class and the second argument is the value from the stream- Returns:
- the traversal with an appended
FoldStep
- See Also:
- Reference Documentation - Fold Step
-
count
default CredentialTraversal<S,Long> count()
Description copied from interface:GraphTraversal
Map the traversal stream to its reduction as a sum of theTraverser.bulk()
values (i.e. count the number of traversers up to this point).- Specified by:
count
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
CountGlobalStep
. - See Also:
- Reference Documentation - Count Step
-
count
default CredentialTraversal<S,Long> count(Scope scope)
Description copied from interface:GraphTraversal
Map the traversal stream to its reduction as a sum of theTraverser.bulk()
values given the specifiedScope
(i.e. count the number of traversers up to this point).- Specified by:
count
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
CountGlobalStep
orCountLocalStep
depending on theScope
- See Also:
- Reference Documentation - Count Step
-
sum
default <E2 extends Number> CredentialTraversal<S,E2> sum()
Description copied from interface:GraphTraversal
Map the traversal stream to its reduction as a sum of theTraverser.get()
values multiplied by theirTraverser.bulk()
(i.e. sum the traverser values up to this point).- Specified by:
sum
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
SumGlobalStep
. - See Also:
- Reference Documentation - Sum Step
-
sum
default <E2 extends Number> CredentialTraversal<S,E2> sum(Scope scope)
Description copied from interface:GraphTraversal
Map the traversal stream to its reduction as a sum of theTraverser.get()
values multiplied by theirTraverser.bulk()
given the specifiedScope
(i.e. sum the traverser values up to this point).- Specified by:
sum
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
SumGlobalStep
orSumLocalStep
depending on theScope
. - See Also:
- Reference Documentation - Sum Step
-
max
default <E2 extends Comparable> CredentialTraversal<S,E2> max()
Description copied from interface:GraphTraversal
Determines the largest value in the stream.- Specified by:
max
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
MaxGlobalStep
. - See Also:
- Reference Documentation - Max Step
-
max
default <E2 extends Comparable> CredentialTraversal<S,E2> max(Scope scope)
Description copied from interface:GraphTraversal
Determines the largest value in the stream given theScope
.- Specified by:
max
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
MaxGlobalStep
orMaxLocalStep
depending on theScope
- See Also:
- Reference Documentation - Max Step
-
min
default <E2 extends Comparable> CredentialTraversal<S,E2> min()
Description copied from interface:GraphTraversal
Determines the smallest value in the stream.- Specified by:
min
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
MinGlobalStep
. - See Also:
- Reference Documentation - Min Step
-
min
default <E2 extends Comparable> CredentialTraversal<S,E2> min(Scope scope)
Description copied from interface:GraphTraversal
Determines the smallest value in the stream given theScope
.- Specified by:
min
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
MinGlobalStep
orMinLocalStep
depending on theScope
- See Also:
- Reference Documentation - Min Step
-
mean
default <E2 extends Number> CredentialTraversal<S,E2> mean()
Description copied from interface:GraphTraversal
Determines the mean value in the stream.- Specified by:
mean
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
MeanGlobalStep
. - See Also:
- Reference Documentation - Mean Step
-
mean
default <E2 extends Number> CredentialTraversal<S,E2> mean(Scope scope)
Description copied from interface:GraphTraversal
Determines the mean value in the stream given theScope
.- Specified by:
mean
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
MeanGlobalStep
orMeanLocalStep
depending on theScope
- See Also:
- Reference Documentation - Mean Step
-
group
default <K,V> CredentialTraversal<S,Map<K,V>> group()
Description copied from interface:GraphTraversal
Organize objects in the stream into aMap
. Calls togroup()
are typically accompanied withGraphTraversal.by()
modulators which help specify how the grouping should occur.- Specified by:
group
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
GroupStep
. - See Also:
- Reference Documentation - Group Step
-
groupCount
default <K> CredentialTraversal<S,Map<K,Long>> groupCount()
Description copied from interface:GraphTraversal
Counts the number of times a particular objects has been part of a traversal, returning aMap
where the object is the key and the value is the count.- Specified by:
groupCount
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
GroupCountStep
. - See Also:
- Reference Documentation - GroupCount Step
-
tree
default CredentialTraversal<S,Tree> tree()
Description copied from interface:GraphTraversal
Aggregates the emanating paths into aTree
data structure.- Specified by:
tree
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
TreeStep
- See Also:
- Reference Documentation - Tree Step
-
addV
default CredentialTraversal<S,Vertex> addV(String vertexLabel)
Description copied from interface:GraphTraversal
Adds aVertex
.- Specified by:
addV
in interfaceGraphTraversal<S,E>
- Parameters:
vertexLabel
- the label of theVertex
to add- Returns:
- the traversal with the
AddVertexStep
added - See Also:
- Reference Documentation - AddVertex Step
-
addV
default CredentialTraversal<S,Vertex> addV(Traversal<?,String> vertexLabelTraversal)
Description copied from interface:GraphTraversal
- Specified by:
addV
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the
AddVertexStep
added - See Also:
- Reference Documentation - AddVertex Step
-
addV
default CredentialTraversal<S,Vertex> addV()
Description copied from interface:GraphTraversal
Adds aVertex
with a default vertex label.- Specified by:
addV
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the
AddVertexStep
added - See Also:
- Reference Documentation - AddVertex Step
-
mergeV
default CredentialTraversal<S,Vertex> mergeV()
Description copied from interface:GraphTraversal
Performs a merge (i.e. upsert) style operation for anVertex
using the incomingMap
traverser as an argument. TheMap
represents search criteria and will match each of the supplied key/value pairs where the keys may beString
property values or a value ofT
. If a match is not made it will use that search criteria to create the newVertex
.- Specified by:
mergeV
in interfaceGraphTraversal<S,E>
-
mergeV
default CredentialTraversal<S,Vertex> mergeV(Map<Object,Object> searchCreate)
Description copied from interface:GraphTraversal
Performs a merge (i.e. upsert) style operation for anVertex
using aMap
as an argument. TheMap
represents search criteria and will match each of the supplied key/value pairs where the keys may beString
property values or a value ofT
. If a match is not made it will use that search criteria to create the newVertex
.- Specified by:
mergeV
in interfaceGraphTraversal<S,E>
- Parameters:
searchCreate
- ThisMap
can have a key ofT
or aString
.
-
mergeV
default CredentialTraversal<S,Vertex> mergeV(Traversal<?,Map<Object,Object>> searchCreate)
Description copied from interface:GraphTraversal
Performs a merge (i.e. upsert) style operation for anVertex
using aMap
as an argument. TheMap
represents search criteria and will match each of the supplied key/value pairs where the keys may beString
property values or a value ofT
. If a match is not made it will use that search criteria to create the newVertex
.
-
mergeE
default CredentialTraversal<S,Edge> mergeE()
Description copied from interface:GraphTraversal
Spawns aGraphTraversal
by doing a merge (i.e. upsert) style operation for anEdge
using an incomingMap
as an argument.- Specified by:
mergeE
in interfaceGraphTraversal<S,E>
-
mergeE
default CredentialTraversal<S,Edge> mergeE(Map<Object,Object> searchCreate)
Description copied from interface:GraphTraversal
Spawns aGraphTraversal
by doing a merge (i.e. upsert) style operation for anEdge
using aMap
as an argument.
-
mergeE
default CredentialTraversal<S,Edge> mergeE(Traversal<?,Map<Object,Object>> searchCreate)
Description copied from interface:GraphTraversal
Spawns aGraphTraversal
by doing a merge (i.e. upsert) style operation for anEdge
using aMap
as an argument.
-
addE
default CredentialTraversal<S,Edge> addE(String edgeLabel)
Description copied from interface:GraphTraversal
Adds anEdge
with the specified edge label.- Specified by:
addE
in interfaceGraphTraversal<S,E>
- Parameters:
edgeLabel
- the label of the newly added edge- Returns:
- the traversal with the
AddEdgeStep
added - See Also:
- Reference Documentation - AddEdge Step
-
addE
default CredentialTraversal<S,Edge> addE(Traversal<?,String> edgeLabelTraversal)
Description copied from interface:GraphTraversal
- Specified by:
addE
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the
AddEdgeStep
added - See Also:
- Reference Documentation - AddEdge Step
-
to
default CredentialTraversal<S,E> to(String toStepLabel)
Description copied from interface:GraphTraversal
Provideto()
-modulation to respective steps.- Specified by:
to
in interfaceGraphTraversal<S,E>
- Parameters:
toStepLabel
- the step label to modulate to.- Returns:
- the traversal with the modified
FromToModulating
step. - See Also:
- Reference Documentation - To Step
-
from
default CredentialTraversal<S,E> from(String fromStepLabel)
Description copied from interface:GraphTraversal
Providefrom()
-modulation to respective steps.- Specified by:
from
in interfaceGraphTraversal<S,E>
- Parameters:
fromStepLabel
- the step label to modulate to.- Returns:
- the traversal with the modified
FromToModulating
step. - See Also:
- Reference Documentation - From Step
-
to
default CredentialTraversal<S,E> to(Traversal<?,Vertex> toVertex)
Description copied from interface:GraphTraversal
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the incoming vertex of the newly addedEdge
.- Specified by:
to
in interfaceGraphTraversal<S,E>
- Parameters:
toVertex
- the traversal for selecting the incoming vertex- Returns:
- the traversal with the modified
AddEdgeStep
- See Also:
- Reference Documentation - From Step
-
from
default CredentialTraversal<S,E> from(Traversal<?,Vertex> fromVertex)
Description copied from interface:GraphTraversal
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the outgoing vertex of the newly addedEdge
.- Specified by:
from
in interfaceGraphTraversal<S,E>
- Parameters:
fromVertex
- the traversal for selecting the outgoing vertex- Returns:
- the traversal with the modified
AddEdgeStep
- See Also:
- Reference Documentation - From Step
-
to
default CredentialTraversal<S,E> to(Vertex toVertex)
Description copied from interface:GraphTraversal
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the incoming vertex of the newly addedEdge
.- Specified by:
to
in interfaceGraphTraversal<S,E>
- Parameters:
toVertex
- the vertex for selecting the incoming vertex- Returns:
- the traversal with the modified
AddEdgeStep
- See Also:
- Reference Documentation - From Step
-
from
default CredentialTraversal<S,E> from(Vertex fromVertex)
Description copied from interface:GraphTraversal
When used as a modifier toGraphTraversal.addE(String)
this method specifies the traversal to use for selecting the outgoing vertex of the newly addedEdge
.- Specified by:
from
in interfaceGraphTraversal<S,E>
- Parameters:
fromVertex
- the vertex for selecting the outgoing vertex- Returns:
- the traversal with the modified
AddEdgeStep
- See Also:
- Reference Documentation - From Step
-
math
default CredentialTraversal<S,Double> math(String expression)
Description copied from interface:GraphTraversal
- Specified by:
math
in interfaceGraphTraversal<S,E>
- Parameters:
expression
- the mathematical expression with variables refering to scope variables.- Returns:
- the traversal with the
MathStep
added.
-
element
default CredentialTraversal<S,Element> element()
Description copied from interface:GraphTraversal
- Specified by:
element
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ElementStep
. - See Also:
- Reference Documentation - Element Step
-
call
default <E> CredentialTraversal<S,E> call(String service)
Description copied from interface:GraphTraversal
Perform the specified service call with no parameters.- Specified by:
call
in interfaceGraphTraversal<S,E>
- Parameters:
service
- the name of the service call- Returns:
- the traversal with an appended
CallStep
. - See Also:
- Reference Documentation - Call Step
-
call
default <E> CredentialTraversal<S,E> call(String service, Map params)
Description copied from interface:GraphTraversal
Perform the specified service call with the specified static parameters.- Specified by:
call
in interfaceGraphTraversal<S,E>
- Parameters:
service
- the name of the service callparams
- static parameter map (no nested traversals)- Returns:
- the traversal with an appended
CallStep
. - See Also:
- Reference Documentation - Call Step
-
call
default <E> CredentialTraversal<S,E> call(String service, Traversal<?,Map<?,?>> childTraversal)
Description copied from interface:GraphTraversal
Perform the specified service call with dynamic parameters produced by the specified child traversal.- Specified by:
call
in interfaceGraphTraversal<S,E>
- Parameters:
service
- the name of the service callchildTraversal
- a traversal that will produce a Map of parameters for the service call when invoked.- Returns:
- the traversal with an appended
CallStep
. - See Also:
- Reference Documentation - Call Step
-
call
default <E> CredentialTraversal<S,E> call(String service, Map params, Traversal<?,Map<?,?>> childTraversal)
Description copied from interface:GraphTraversal
Perform the specified service call with both static and dynamic parameters produced by the specified child traversal. These parameters will be merged at execution time per the provider implementation. Reference implementation merges dynamic into static (dynamic will overwrite static).- Specified by:
call
in interfaceGraphTraversal<S,E>
- Parameters:
service
- the name of the service callparams
- static parameter map (no nested traversals)childTraversal
- a traversal that will produce a Map of parameters for the service call when invoked.- Returns:
- the traversal with an appended
CallStep
. - See Also:
- Reference Documentation - Call Step
-
concat
default CredentialTraversal<S,String> concat(Traversal<?,String> concatTraversal, Traversal<?,String>... otherConcatTraversals)
Description copied from interface:GraphTraversal
Concatenate values of an arbitrary number of string traversals to the incoming traverser.- Specified by:
concat
in interfaceGraphTraversal<S,E>
- Parameters:
concatTraversal
- the traversal to concatenate.otherConcatTraversals
- additional traversals to concatenate.- Returns:
- the traversal with an appended
ConcatStep
. - See Also:
- Reference Documentation - Concat Step
-
concat
default CredentialTraversal<S,String> concat(String... concatStrings)
Description copied from interface:GraphTraversal
Concatenate an arbitrary number of strings to the incoming traverser.- Specified by:
concat
in interfaceGraphTraversal<S,E>
- Parameters:
concatStrings
- the String values to concatenate.- Returns:
- the traversal with an appended
ConcatStep
. - See Also:
- Reference Documentation - Concat Step
-
asString
default CredentialTraversal<S,String> asString()
Description copied from interface:GraphTraversal
Returns the value of incoming traverser as strings. Null values are returned as a string value "null".- Specified by:
asString
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
AsStringGlobalStep
. - See Also:
- Reference Documentation - AsString Step
-
asString
default <E2> CredentialTraversal<S,E2> asString(Scope scope)
Description copied from interface:GraphTraversal
Returns the value of incoming traverser as strings. Null values are returned as a string value "null".- Specified by:
asString
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.- Returns:
- the traversal with an appended
AsStringGlobalStep
orAsStringLocalStep
depending on theScope
. - See Also:
- Reference Documentation - AsString Step
-
length
default CredentialTraversal<S,Integer> length()
Description copied from interface:GraphTraversal
Returns the length incoming string traverser. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
length
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
LengthGlobalStep
. - See Also:
- Reference Documentation - Length Step
-
length
default <E2> CredentialTraversal<S,E2> length(Scope scope)
Description copied from interface:GraphTraversal
Returns the length incoming string or list. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
length
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within lists, global will operate on current traversal as a single object.- Returns:
- the traversal with an appended
LengthGlobalStep
orLengthLocalStep
depending on theScope
. - See Also:
- Reference Documentation - Length Step
-
toLower
default CredentialTraversal<S,String> toLower()
Description copied from interface:GraphTraversal
Returns the lowercase representation of incoming string traverser. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
toLower
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ToLowerGlobalStep
. - See Also:
- Reference Documentation - ToLower Step
-
toLower
default <E2> CredentialTraversal<S,E2> toLower(Scope scope)
Description copied from interface:GraphTraversal
Returns the lowercase representation of incoming string or list of strings. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
toLower
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will accept lists of string and operate on individual strings within the list, global will only accept string objects.- Returns:
- the traversal with an appended
ToLowerGlobalStep
orToLowerLocalStep
depending on theScope
. - See Also:
- Reference Documentation - ToLower Step
-
toUpper
default CredentialTraversal<S,String> toUpper()
Description copied from interface:GraphTraversal
Returns the uppercase representation of incoming string traverser. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
toUpper
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ToUpperGlobalStep
. - See Also:
- Reference Documentation - ToUpper Step
-
toUpper
default <E2> CredentialTraversal<S,E2> toUpper(Scope scope)
Description copied from interface:GraphTraversal
Returns the uppercase representation of incoming string or list of strings. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
toUpper
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will accept lists of string and operate on individual strings within the list, global will only accept string objects.- Returns:
- the traversal with an appended
ToUpperGlobalStep
orToUpperLocalStep
depending on theScope
. - See Also:
- Reference Documentation - ToUpper Step
-
trim
default CredentialTraversal<S,String> trim()
Description copied from interface:GraphTraversal
Returns a string with leading and trailing whitespace removed. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
trim
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
TrimGlobalStep
. - See Also:
- Reference Documentation - Trim Step
-
trim
default <E2> CredentialTraversal<S,E2> trim(Scope scope)
Description copied from interface:GraphTraversal
Returns a string with leading and trailing whitespace removed. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
trim
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.- Returns:
- the traversal with an appended
TrimGlobalStep
orTrimLocalStep
depending on theScope
. - See Also:
- Reference Documentation - Trim Step
-
lTrim
default CredentialTraversal<S,String> lTrim()
Description copied from interface:GraphTraversal
Returns a string with leading whitespace removed. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
lTrim
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
LTrimGlobalStep
. - See Also:
- Reference Documentation - LTrim Step
-
lTrim
default <E2> CredentialTraversal<S,E2> lTrim(Scope scope)
Description copied from interface:GraphTraversal
Returns a string with leading whitespace removed. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
lTrim
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.- Returns:
- the traversal with an appended
LTrimGlobalStep
orLTrimLocalStep
depending on theScope
. - See Also:
- Reference Documentation - LTrim Step
-
rTrim
default CredentialTraversal<S,String> rTrim()
Description copied from interface:GraphTraversal
Returns a string with trailing whitespace removed. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
rTrim
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
RTrimGlobalStep
. - See Also:
- Reference Documentation - RTrim Step
-
rTrim
default <E2> CredentialTraversal<S,E2> rTrim(Scope scope)
Description copied from interface:GraphTraversal
Returns a string with trailing whitespace removed. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
rTrim
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.- Returns:
- the traversal with an appended
RTrimGlobalStep
orRTrimLocalStep
depending on theScope
. - See Also:
- Reference Documentation - RTrim Step
-
reverse
default <E2> CredentialTraversal<S,E2> reverse()
Description copied from interface:GraphTraversal
Returns the reverse of the incoming traverser. Null values are not processed and remain as null when returned.- Specified by:
reverse
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ReverseStep
. - See Also:
- Reference Documentation - Reverse Step
-
replace
default CredentialTraversal<S,String> replace(String oldChar, String newChar)
Description copied from interface:GraphTraversal
Returns a string with the specified characters in the original string replaced with the new characters. Any null arguments will be a no-op and the original string is returned. Null values from incoming traversers are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
replace
in interfaceGraphTraversal<S,E>
- Parameters:
oldChar
- the character to be replaced.newChar
- the character to replace.- Returns:
- the traversal with an appended
ReplaceGlobalStep
. - See Also:
- Reference Documentation - Replace Step
-
replace
default <E2> CredentialTraversal<S,E2> replace(Scope scope, String oldChar, String newChar)
Description copied from interface:GraphTraversal
Returns a string with the specified characters in the original string replaced with the new characters. Any null arguments will be a no-op and the original string is returned. Null values from incoming traversers are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
replace
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.oldChar
- the character to be replaced.newChar
- the character to replace.- Returns:
- the traversal with an appended
ReplaceGlobalStep
orReplaceLocalStep
depending on theScope
. - See Also:
- Reference Documentation - Replace Step
-
split
default CredentialTraversal<S,List<String>> split(String separator)
Description copied from interface:GraphTraversal
Returns a list of strings created by splitting the incoming string traverser around the matches of the given separator. A null separator will split the string by whitespaces. Null values from incoming traversers are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
split
in interfaceGraphTraversal<S,E>
- Parameters:
separator
- the character to split the string on.- Returns:
- the traversal with an appended
SplitGlobalStep
. - See Also:
- Reference Documentation - Split Step
-
split
default <E2> CredentialTraversal<S,List<E2>> split(Scope scope, String separator)
Description copied from interface:GraphTraversal
Returns a list of strings created by splitting the incoming string traverser around the matches of the given separator. A null separator will split the string by whitespaces. Null values from incoming traversers are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
split
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.separator
- the character to split the string on.- Returns:
- the traversal with an appended
SplitGlobalStep
orSplitLocalStep
depending on theScope
. - See Also:
- Reference Documentation - Split Step
-
substring
default CredentialTraversal<S,String> substring(int startIndex)
Description copied from interface:GraphTraversal
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) specified, to the end of the string. If the start index is negative then it will begin at the specified index counted from the end of the string, or 0 if exceeding the string length. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
substring
in interfaceGraphTraversal<S,E>
- Parameters:
startIndex
- the start index of the substring, inclusive.- Returns:
- the traversal with an appended
SubstringGlobalStep
. - See Also:
- Reference Documentation - Substring Step
-
substring
default <E2> CredentialTraversal<S,E2> substring(Scope scope, int startIndex)
Description copied from interface:GraphTraversal
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) specified, to the end of the string. If the start index is negative then it will begin at the specified index counted from the end of the string, or 0 if exceeding the string length. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
substring
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.startIndex
- the start index of the substring, inclusive.- Returns:
- the traversal with an appended
SubstringGlobalStep
orSubstringLocalStep
depending on theScope
. - See Also:
- Reference Documentation - Substring Step
-
substring
default CredentialTraversal<S,String> substring(int startIndex, int endIndex)
Description copied from interface:GraphTraversal
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) and end index (exclusive). If the start index is negative then it will begin at the specified index counted from the end of the string, or 0 if exceeding the string length. If the end index is negative then it will end at the specified index counted from the end, or at the end of the string if exceeding the string length. End index <= start index will return the empty string. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
substring
in interfaceGraphTraversal<S,E>
- Parameters:
startIndex
- the start index of the substring, inclusive.endIndex
- the end index of the substring, exclusive.- Returns:
- the traversal with an appended
SubstringGlobalStep
. - See Also:
- Reference Documentation - Substring Step
-
substring
default <E2> CredentialTraversal<S,E2> substring(Scope scope, int startIndex, int endIndex)
Description copied from interface:GraphTraversal
Returns a substring of the incoming string traverser with a 0-based start index (inclusive) and end index (exclusive). If the start index is negative then it will begin at the specified index counted from the end of the string, or 0 if exceeding the string length. If the end index is negative then it will end at the specified index counted from the end, or at the end of the string if exceeding the string length. End index <= start index will return the empty string. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then anIllegalArgumentException
will be thrown.- Specified by:
substring
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- local will operate on individual strings within incoming lists, global will operate on current traversal as a single object.startIndex
- the start index of the substring, inclusive.endIndex
- the end index of the substring, exclusive.- Returns:
- the traversal with an appended
SubstringGlobalStep
orSubstringLocalStep
depending on theScope
. - See Also:
- Reference Documentation - Substring Step
-
format
default CredentialTraversal<S,String> format(String format)
Description copied from interface:GraphTraversal
A mid-traversal step which will handle result formatting to string values.- Specified by:
format
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
FormatStep
. - See Also:
- Reference Documentation - format Step
-
asDate
default CredentialTraversal<S,Date> asDate()
Description copied from interface:GraphTraversal
Parse value of the incoming traverser as an ISO-8601Date
.- Specified by:
asDate
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
AsDateStep
. - See Also:
- Reference Documentation - asDate Step
-
dateAdd
default CredentialTraversal<S,Date> dateAdd(DT dateToken, int value)
Description copied from interface:GraphTraversal
Increase value of inputDate
.- Specified by:
dateAdd
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
DateAddStep
. - See Also:
- Reference Documentation - dateAdd Step
-
dateDiff
default CredentialTraversal<S,Long> dateDiff(Date value)
Description copied from interface:GraphTraversal
Returns the difference between twoDate
in epoch time.- Specified by:
dateDiff
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
DateDiffStep
. - See Also:
- Reference Documentation - dateDiff Step
-
dateDiff
default CredentialTraversal<S,Long> dateDiff(Traversal<?,Date> dateTraversal)
Description copied from interface:GraphTraversal
Returns the difference between twoDate
in epoch time.- Specified by:
dateDiff
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
DateDiffStep
. - See Also:
- Reference Documentation - dateDiff Step
-
difference
default CredentialTraversal<S,Set<?>> difference(Object values)
Description copied from interface:GraphTraversal
Calculates the difference between the list traverser and list argument.- Specified by:
difference
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
DifferenceStep
. - See Also:
- Reference Documentation - Difference Step
-
disjunct
default CredentialTraversal<S,Set<?>> disjunct(Object values)
Description copied from interface:GraphTraversal
Calculates the disjunction between the list traverser and list argument.- Specified by:
disjunct
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
DisjunctStep
. - See Also:
- Reference Documentation - Disjunct Step
-
intersect
default CredentialTraversal<S,Set<?>> intersect(Object values)
Description copied from interface:GraphTraversal
Calculates the intersection between the list traverser and list argument.- Specified by:
intersect
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
IntersectStep
. - See Also:
- Reference Documentation - Intersect Step
-
conjoin
default CredentialTraversal<S,String> conjoin(String delimiter)
Description copied from interface:GraphTraversal
Joins together the elements of the incoming list traverser together with the provided delimiter.- Specified by:
conjoin
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ConjoinStep
. - See Also:
- Reference Documentation - Conjoin Step
-
merge
default <E2> CredentialTraversal<S,E2> merge(Object values)
Description copied from interface:GraphTraversal
Merges the list traverser and list argument. Also known as union.- Specified by:
merge
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
TraversalMergeStep
. - See Also:
- Reference Documentation - Merge Step
-
combine
default CredentialTraversal<S,List<?>> combine(Object values)
Description copied from interface:GraphTraversal
Combines the list traverser and list argument. Also known as concatenation or append.- Specified by:
combine
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
CombineStep
. - See Also:
- Reference Documentation - Combine Step
-
product
default CredentialTraversal<S,List<List<?>>> product(Object values)
Description copied from interface:GraphTraversal
Calculates the cartesian product between the list traverser and list argument.- Specified by:
product
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
ProductStep
. - See Also:
- Reference Documentation - Product Step
-
filter
default CredentialTraversal<S,E> filter(Predicate<Traverser<E>> predicate)
Description copied from interface:GraphTraversal
Map theTraverser
to eithertrue
orfalse
, wherefalse
will not pass the traverser to the next step.- Specified by:
filter
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter function to apply- Returns:
- the traversal with the
LambdaFilterStep
added - See Also:
- Reference Documentation - General Steps
-
filter
default CredentialTraversal<S,E> filter(Traversal<?,?> filterTraversal)
Description copied from interface:GraphTraversal
Map theTraverser
to eithertrue
orfalse
, wherefalse
will not pass the traverser to the next step.- Specified by:
filter
in interfaceGraphTraversal<S,E>
- Parameters:
filterTraversal
- the filter traversal to apply- Returns:
- the traversal with the
TraversalFilterStep
added - See Also:
- Reference Documentation - General Steps
-
none
default CredentialTraversal<S,E> none()
Description copied from interface:Traversal
Filter all traversers in the traversal. This step has narrow use cases and is primarily intended for use as a signal to remote servers thatTraversal.iterate()
was called. While it may be directly used, it is often a sign that a traversal should be re-written in another form.
-
or
default CredentialTraversal<S,E> or(Traversal<?,?>... orTraversals)
Description copied from interface:GraphTraversal
Ensures that at least one of the provided traversals yield a result.- Specified by:
or
in interfaceGraphTraversal<S,E>
- Parameters:
orTraversals
- filter traversals where at least one must be satisfied- Returns:
- the traversal with an appended
OrStep
- See Also:
- Reference Documentation - Or Step
-
and
default CredentialTraversal<S,E> and(Traversal<?,?>... andTraversals)
Description copied from interface:GraphTraversal
Ensures that all of the provided traversals yield a result.- Specified by:
and
in interfaceGraphTraversal<S,E>
- Parameters:
andTraversals
- filter traversals that must be satisfied- Returns:
- the traversal with an appended
AndStep
- See Also:
- Reference Documentation - And Step
-
inject
default CredentialTraversal<S,E> inject(E... injections)
Description copied from interface:GraphTraversal
Provides a way to add arbitrary objects to a traversal stream.- Specified by:
inject
in interfaceGraphTraversal<S,E>
- Parameters:
injections
- the objects to add to the stream- Returns:
- the traversal with an appended
InjectStep
- See Also:
- Reference Documentation - Inject Step
-
dedup
default CredentialTraversal<S,E> dedup(Scope scope, String... dedupLabels)
Description copied from interface:GraphTraversal
Remove all duplicates in the traversal stream up to this point.- Specified by:
dedup
in interfaceGraphTraversal<S,E>
- 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
orDedupLocalStep
depending onscope
- See Also:
- Reference Documentation - Dedup Step
-
dedup
default CredentialTraversal<S,E> dedup(String... dedupLabels)
Description copied from interface:GraphTraversal
Remove all duplicates in the traversal stream up to this point.- Specified by:
dedup
in interfaceGraphTraversal<S,E>
- 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
. - See Also:
- Reference Documentation - Dedup Step
-
where
default CredentialTraversal<S,E> where(String startKey, P<String> predicate)
Description copied from interface:GraphTraversal
Filters the current object based on the object itself or the path history.- Specified by:
where
in interfaceGraphTraversal<S,E>
- Parameters:
startKey
- the key containing the object to filterpredicate
- the filter to apply- Returns:
- the traversal with an appended
WherePredicateStep
- See Also:
- Reference Documentation - Where Step, Reference Documentation - Where with Match, Reference Documentation - Where with Select
-
where
default CredentialTraversal<S,E> where(P<String> predicate)
Description copied from interface:GraphTraversal
Filters the current object based on the object itself or the path history.- Specified by:
where
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply- Returns:
- the traversal with an appended
WherePredicateStep
- See Also:
- Reference Documentation - Where Step, Reference Documentation - Where with Match, Reference Documentation - Where with Select
-
where
default CredentialTraversal<S,E> where(Traversal<?,?> whereTraversal)
Description copied from interface:GraphTraversal
Filters the current object based on the object itself or the path history.- Specified by:
where
in interfaceGraphTraversal<S,E>
- Parameters:
whereTraversal
- the filter to apply- Returns:
- the traversal with an appended
WherePredicateStep
- See Also:
- Reference Documentation - Where Step, Reference Documentation - Where with Match, Reference Documentation - Where with Select
-
has
default CredentialTraversal<S,E> has(String propertyKey, P<?> predicate)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their properties.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
propertyKey
- the key of the property to filter onpredicate
- the filter to apply to the key's value- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(T accessor, P<?> predicate)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their properties.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
accessor
- theT
accessor of the property to filter onpredicate
- the filter to apply to the key's value- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(String propertyKey, Object value)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their properties.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
propertyKey
- the key of the property to filter onvalue
- the value to compare the property value to for equality- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(T accessor, Object value)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their properties.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
accessor
- theT
accessor of the property to filter onvalue
- the value to compare the accessor value to for equality- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(String label, String propertyKey, P<?> predicate)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their properties.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
label
- the label of theElement
propertyKey
- the key of the property to filter onpredicate
- the filter to apply to the key's value- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(String label, String propertyKey, Object value)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their properties.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
label
- the label of theElement
propertyKey
- the key of the property to filter onvalue
- the value to compare the accessor value to for equality- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(T accessor, Traversal<?,?> propertyTraversal)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their value ofT
where onlyT.id
andT.label
are supported.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
accessor
- theT
accessor of the property to filter onpropertyTraversal
- the traversal to filter the accessor value by- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(String propertyKey, Traversal<?,?> propertyTraversal)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on the value of the specified property key.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
propertyKey
- the key of the property to filter onpropertyTraversal
- the traversal to filter the property value by- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
has
default CredentialTraversal<S,E> has(String propertyKey)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on the existence of properties.- Specified by:
has
in interfaceGraphTraversal<S,E>
- Parameters:
propertyKey
- the key of the property to filter on for existence- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasNot
default CredentialTraversal<S,E> hasNot(String propertyKey)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on the non-existence of properties.- Specified by:
hasNot
in interfaceGraphTraversal<S,E>
- Parameters:
propertyKey
- the key of the property to filter on for existence- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasLabel
default CredentialTraversal<S,E> hasLabel(String label, String... otherLabels)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their label.- Specified by:
hasLabel
in interfaceGraphTraversal<S,E>
- Parameters:
label
- the label of theElement
otherLabels
- additional labels of theElement
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasLabel
default CredentialTraversal<S,E> hasLabel(P<String> predicate)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their label. Note that calling this step withnull
is the same as callingGraphTraversal.hasLabel(String, String...)
with a singlenull
.- Specified by:
hasLabel
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply to the label of theElement
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasId
default CredentialTraversal<S,E> hasId(Object id, Object... otherIds)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their identifier.- Specified by:
hasId
in interfaceGraphTraversal<S,E>
- Parameters:
id
- the identifier of theElement
otherIds
- additional identifiers of theElement
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasId
default CredentialTraversal<S,E> hasId(P<Object> predicate)
Description copied from interface:GraphTraversal
Filters vertices, edges and vertex properties based on their identifier. Calling this step with anull
value will result in effectively callingGraphTraversal.hasId(Object, Object...)
wit a singlenull
identifier and therefore filter all results since aT.id
cannot benull
.- Specified by:
hasId
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply to the identifier of theElement
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasKey
default CredentialTraversal<S,E> hasKey(String label, String... otherLabels)
Description copied from interface:GraphTraversal
FiltersProperty
objects based on their key. It is not meant to test key existence on anEdge
or aVertex
. In that case, preferGraphTraversal.has(String)
.- Specified by:
hasKey
in interfaceGraphTraversal<S,E>
- Parameters:
label
- the key of theProperty
otherLabels
- additional key of theProperty
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasKey
default CredentialTraversal<S,E> hasKey(P<String> predicate)
Description copied from interface:GraphTraversal
FiltersProperty
objects based on their key. It is not meant to test key existence on anEdge
or aVertex
. In that case, preferGraphTraversal.has(String)
. Note that calling this step withnull
is the same as callingGraphTraversal.hasKey(String, String...)
with a singlenull
.- Specified by:
hasKey
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply to the key of theProperty
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasValue
default CredentialTraversal<S,E> hasValue(Object value, Object... otherValues)
Description copied from interface:GraphTraversal
FiltersProperty
objects based on their value.- Specified by:
hasValue
in interfaceGraphTraversal<S,E>
- Parameters:
value
- the value of theElement
otherValues
- additional values of theElement
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
hasValue
default CredentialTraversal<S,E> hasValue(P<Object> predicate)
Description copied from interface:GraphTraversal
FiltersProperty
objects based on their value.Note that calling this step withnull
is the same as callingGraphTraversal.hasValue(Object, Object...)
with a singlenull
.- Specified by:
hasValue
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply to the value of theElement
- Returns:
- the traversal with an appended
HasStep
- See Also:
- Reference Documentation - Has Step
-
is
default CredentialTraversal<S,E> is(P<E> predicate)
Description copied from interface:GraphTraversal
FiltersE
object values given the providedpredicate
.- Specified by:
is
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply- Returns:
- the traversal with an appended
IsStep
- See Also:
- Reference Documentation - Is Step
-
is
default CredentialTraversal<S,E> is(Object value)
Description copied from interface:GraphTraversal
Filter theE
object if it is notP.eq(V)
to the provided value.- Specified by:
is
in interfaceGraphTraversal<S,E>
- Parameters:
value
- the value that the object must equal.- Returns:
- the traversal with an appended
IsStep
. - See Also:
- Reference Documentation - Is Step
-
not
default CredentialTraversal<S,E> not(Traversal<?,?> notTraversal)
Description copied from interface:GraphTraversal
Removes objects from the traversal stream when the traversal provided as an argument returns any objects.- Specified by:
not
in interfaceGraphTraversal<S,E>
- Parameters:
notTraversal
- the traversal to filter by.- Returns:
- the traversal with an appended
NotStep
. - See Also:
- Reference Documentation - Not Step
-
coin
default CredentialTraversal<S,E> coin(double probability)
Description copied from interface:GraphTraversal
Filter theE
object given a biased coin toss.- Specified by:
coin
in interfaceGraphTraversal<S,E>
- Parameters:
probability
- the probability that the object will pass through- Returns:
- the traversal with an appended
CoinStep
. - See Also:
- Reference Documentation - Coin Step
-
range
default CredentialTraversal<S,E> range(long low, long high)
Description copied from interface:GraphTraversal
Filter the objects in the traversal by the number of them to pass through the stream. Those before the value oflow
do not pass through and those that exceed the value ofhigh
will end the iteration.- Specified by:
range
in interfaceGraphTraversal<S,E>
- Parameters:
low
- the number at which to start allowing objects through the streamhigh
- the number at which to end the stream - use-1
to emit all remaining objects- Returns:
- the traversal with an appended
RangeGlobalStep
- See Also:
- Reference Documentation - Range Step
-
range
default <E2> CredentialTraversal<S,E2> range(Scope scope, long low, long high)
Description copied from interface:GraphTraversal
Filter the objects in the traversal by the number of them to pass through the stream as constrained by theScope
. Those before the value oflow
do not pass through and those that exceed the value ofhigh
will end the iteration.- Specified by:
range
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- the scope of how to apply therange
low
- the number at which to start allowing objects through the streamhigh
- the number at which to end the stream - use-1
to emit all remaining objects- Returns:
- the traversal with an appended
RangeGlobalStep
orRangeLocalStep
depending onscope
- See Also:
- Reference Documentation - Range Step
-
limit
default CredentialTraversal<S,E> limit(long limit)
Description copied from interface:GraphTraversal
Filter the objects in the traversal by the number of them to pass through the stream, where only the firstn
objects are allowed as defined by thelimit
argument.- Specified by:
limit
in interfaceGraphTraversal<S,E>
- Parameters:
limit
- the number at which to end the stream- Returns:
- the traversal with an appended
RangeGlobalStep
- See Also:
- Reference Documentation - Limit Step
-
limit
default <E2> CredentialTraversal<S,E2> limit(Scope scope, long limit)
Description copied from interface:GraphTraversal
Filter the objects in the traversal by the number of them to pass through the stream given theScope
, where only the firstn
objects are allowed as defined by thelimit
argument.- Specified by:
limit
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- the scope of how to apply thelimit
limit
- the number at which to end the stream- Returns:
- the traversal with an appended
RangeGlobalStep
orRangeLocalStep
depending onscope
- See Also:
- Reference Documentation - Limit Step
-
tail
default CredentialTraversal<S,E> tail()
Description copied from interface:GraphTraversal
Filters the objects in the traversal emitted as being last objects in the stream. In this case, only the last object will be returned.- Specified by:
tail
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
TailGlobalStep
- See Also:
- Reference Documentation - Tail Step
-
tail
default CredentialTraversal<S,E> tail(long limit)
Description copied from interface:GraphTraversal
Filters the objects in the traversal emitted as being last objects in the stream. In this case, only the lastn
objects will be returned as defined by thelimit
.- Specified by:
tail
in interfaceGraphTraversal<S,E>
- Parameters:
limit
- the number at which to end the stream- Returns:
- the traversal with an appended
TailGlobalStep
- See Also:
- Reference Documentation - Tail Step
-
tail
default <E2> CredentialTraversal<S,E2> tail(Scope scope)
Description copied from interface:GraphTraversal
Filters the objects in the traversal emitted as being last objects in the stream given theScope
. In this case, only the last object in the stream will be returned.- Specified by:
tail
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- the scope of how to apply thetail
- Returns:
- the traversal with an appended
TailGlobalStep
orTailLocalStep
depending onscope
- See Also:
- Reference Documentation - Tail Step
-
tail
default <E2> CredentialTraversal<S,E2> tail(Scope scope, long limit)
Description copied from interface:GraphTraversal
Filters the objects in the traversal emitted as being last objects in the stream given theScope
. In this case, only the lastn
objects will be returned as defined by thelimit
.- Specified by:
tail
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- the scope of how to apply thetail
limit
- the number at which to end the stream- Returns:
- the traversal with an appended
TailGlobalStep
orTailLocalStep
depending onscope
- See Also:
- Reference Documentation - Tail Step
-
skip
default CredentialTraversal<S,E> skip(long skip)
Description copied from interface:GraphTraversal
Filters out the firstn
objects in the traversal.- Specified by:
skip
in interfaceGraphTraversal<S,E>
- Parameters:
skip
- the number of objects to skip- Returns:
- the traversal with an appended
RangeGlobalStep
- See Also:
- Reference Documentation - Skip Step
-
skip
default <E2> CredentialTraversal<S,E2> skip(Scope scope, long skip)
Description copied from interface:GraphTraversal
Filters out the firstn
objects in the traversal.- Specified by:
skip
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- the scope of how to apply thetail
skip
- the number of objects to skip- Returns:
- the traversal with an appended
RangeGlobalStep
orRangeLocalStep
depending onscope
- See Also:
- Reference Documentation - Skip Step
-
timeLimit
default CredentialTraversal<S,E> timeLimit(long timeLimit)
Description copied from interface:GraphTraversal
Once the firstTraverser
hits this step, a count down is started. Once the time limit is up, all remaining traversers are filtered out.- Specified by:
timeLimit
in interfaceGraphTraversal<S,E>
- Parameters:
timeLimit
- the count down time- Returns:
- the traversal with an appended
TimeLimitStep
- See Also:
- Reference Documentation - TimeLimit Step
-
simplePath
default CredentialTraversal<S,E> simplePath()
Description copied from interface:GraphTraversal
- Specified by:
simplePath
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
PathFilterStep
. - See Also:
- Reference Documentation - SimplePath Step
-
cyclicPath
default CredentialTraversal<S,E> cyclicPath()
Description copied from interface:GraphTraversal
- Specified by:
cyclicPath
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
PathFilterStep
. - See Also:
- Reference Documentation - CyclicPath Step
-
sample
default CredentialTraversal<S,E> sample(int amountToSample)
Description copied from interface:GraphTraversal
Allow some specified number of objects to pass through the stream.- Specified by:
sample
in interfaceGraphTraversal<S,E>
- Parameters:
amountToSample
- the number of objects to allow- Returns:
- the traversal with an appended
SampleGlobalStep
- See Also:
- Reference Documentation - Sample Step
-
sample
default CredentialTraversal<S,E> sample(Scope scope, int amountToSample)
Description copied from interface:GraphTraversal
Allow some specified number of objects to pass through the stream.- Specified by:
sample
in interfaceGraphTraversal<S,E>
- Parameters:
scope
- the scope of how to apply thesample
amountToSample
- the number of objects to allow- Returns:
- the traversal with an appended
SampleGlobalStep
orSampleLocalStep
depending on thescope
- See Also:
- Reference Documentation - Sample Step
-
drop
default CredentialTraversal<S,E> drop()
Description copied from interface:GraphTraversal
Removes elements and properties from the graph. This step is not a terminating, in the sense that it does not automatically iterate the traversal. It is therefore necessary to do some form of iteration for the removal to actually take place. In most cases, iteration is best accomplished withg.V().drop().iterate()
.- Specified by:
drop
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the
DropStep
added - See Also:
- Reference Documentation - Drop Step
-
all
default <S2> CredentialTraversal<S,E> all(P<S2> predicate)
Description copied from interface:GraphTraversal
FiltersE
lists given the providedpredicate
.- Specified by:
all
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply- Returns:
- the traversal with an appended
AllStep
- See Also:
- Reference Documentation - All Step
-
any
default <S2> CredentialTraversal<S,E> any(P<S2> predicate)
Description copied from interface:GraphTraversal
FiltersE
lists given the providedpredicate
.- Specified by:
any
in interfaceGraphTraversal<S,E>
- Parameters:
predicate
- the filter to apply- Returns:
- the traversal with an appended
AnyStep
- See Also:
- Reference Documentation - Any Step
-
sideEffect
default CredentialTraversal<S,E> sideEffect(Consumer<Traverser<E>> consumer)
Description copied from interface:GraphTraversal
Perform some operation on theTraverser
and pass it to the next step unmodified.- Specified by:
sideEffect
in interfaceGraphTraversal<S,E>
- Parameters:
consumer
- the operation to perform at this step in relation to theTraverser
- Returns:
- the traversal with an appended
LambdaSideEffectStep
- See Also:
- Reference Documentation - General Steps
-
sideEffect
default CredentialTraversal<S,E> sideEffect(Traversal<?,?> sideEffectTraversal)
Description copied from interface:GraphTraversal
Perform some operation on theTraverser
and pass it to the next step unmodified.- Specified by:
sideEffect
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectTraversal
- the operation to perform at this step in relation to theTraverser
- Returns:
- the traversal with an appended
TraversalSideEffectStep
- See Also:
- Reference Documentation - General Steps
-
cap
default <E2> CredentialTraversal<S,E2> cap(String sideEffectKey, String... sideEffectKeys)
Description copied from interface:GraphTraversal
Iterates the traversal up to the itself and emits the side-effect referenced by the key. If multiple keys are supplied then the side-effects are emitted as aMap
.- Specified by:
cap
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the side-effect to emitsideEffectKeys
- other side-effects to emit- Returns:
- the traversal with an appended
SideEffectCapStep
- See Also:
- Reference Documentation - Cap Step
-
subgraph
default CredentialTraversal<S,Edge> subgraph(String sideEffectKey)
Description copied from interface:GraphTraversal
Extracts a portion of the graph being traversed into aGraph
object held in the specified side-effect key.- Specified by:
subgraph
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the name of the side-effect key that will hold the subgraph- Returns:
- the traversal with an appended
SubgraphStep
- See Also:
- Reference Documentation - Subgraph Step
-
aggregate
default CredentialTraversal<S,E> aggregate(String sideEffectKey)
Description copied from interface:GraphTraversal
Eagerly collects objects up to this step into a side-effect. Same as callingGraphTraversal.aggregate(Scope, String)
with aScope.global
.- Specified by:
aggregate
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the name of the side-effect key that will hold the aggregated objects- Returns:
- the traversal with an appended
AggregateGlobalStep
- See Also:
- Reference Documentation - Aggregate Step
-
aggregate
default CredentialTraversal<S,E> aggregate(Scope scope, String sideEffectKey)
Description copied from interface:GraphTraversal
Collects objects in a list using theScope
argument to determine whether it should be lazyScope.local
or eager (Scope.global
while gathering those objects.- Specified by:
aggregate
in interfaceGraphTraversal<S,E>
sideEffectKey
- the name of the side-effect key that will hold the aggregated objects- Returns:
- the traversal with an appended
AggregateGlobalStep
- See Also:
- Reference Documentation - Aggregate Step
-
group
default CredentialTraversal<S,E> group(String sideEffectKey)
Description copied from interface:GraphTraversal
Organize objects in the stream into aMap
. Calls togroup()
are typically accompanied withGraphTraversal.by()
modulators which help specify how the grouping should occur.- Specified by:
group
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the name of the side-effect key that will hold the aggregated grouping- Returns:
- the traversal with an appended
GroupStep
. - See Also:
- Reference Documentation - Group Step
-
groupCount
default CredentialTraversal<S,E> groupCount(String sideEffectKey)
Description copied from interface:GraphTraversal
Counts the number of times a particular objects has been part of a traversal, returning aMap
where the object is the key and the value is the count.- Specified by:
groupCount
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the name of the side-effect key that will hold the aggregated grouping- Returns:
- the traversal with an appended
GroupCountStep
. - See Also:
- Reference Documentation - GroupCount Step
-
fail
default CredentialTraversal<S,E> fail()
Description copied from interface:GraphTraversal
When triggered, immediately throws aRuntimeException
which implements theFailure
interface. The traversal will be terminated as a result.- Specified by:
fail
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
FailStep
. - See Also:
- Reference Documentation - Fail Step
-
fail
default CredentialTraversal<S,E> fail(String message)
Description copied from interface:GraphTraversal
When triggered, immediately throws aRuntimeException
which implements theFailure
interface. The traversal will be terminated as a result.- Specified by:
fail
in interfaceGraphTraversal<S,E>
- Parameters:
message
- the error message to include in the exception- Returns:
- the traversal with an appended
FailStep
. - See Also:
- Reference Documentation - Fail Step
-
tree
default CredentialTraversal<S,E> tree(String sideEffectKey)
Description copied from interface:GraphTraversal
Aggregates the emanating paths into aTree
data structure.- Specified by:
tree
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the name of the side-effect key that will hold the tree- Returns:
- the traversal with an appended
TreeStep
- See Also:
- Reference Documentation - Tree Step
-
sack
default <V,U> CredentialTraversal<S,E> sack(BiFunction<V,U,V> sackOperator)
Description copied from interface:GraphTraversal
Map theTraverser
to itsTraverser.sack()
value.- Specified by:
sack
in interfaceGraphTraversal<S,E>
- Parameters:
sackOperator
- the operator to apply to the sack value- Returns:
- the traversal with an appended
SackStep
. - See Also:
- Reference Documentation - Sack Step
-
store
default CredentialTraversal<S,E> store(String sideEffectKey)
Description copied from interface:GraphTraversal
Lazily aggregates objects in the stream into a side-effect collection.- Specified by:
store
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the name of the side-effect key that will hold the aggregate- Returns:
- the traversal with an appended
AggregateLocalStep
- See Also:
- Reference Documentation - Store Step
-
profile
default CredentialTraversal<S,E> profile(String sideEffectKey)
Description copied from interface:GraphTraversal
Allows developers to examine statistical information about a traversal providing data like execution times, counts, etc.- Specified by:
profile
in interfaceGraphTraversal<S,E>
- Parameters:
sideEffectKey
- the name of the side-effect key within which to hold the profile object- Returns:
- the traversal with an appended
ProfileSideEffectStep
- See Also:
- Reference Documentation - Profile Step
-
profile
default CredentialTraversal<S,TraversalMetrics> profile()
Description copied from interface:Traversal
Profile the traversal.- Specified by:
profile
in interfaceGraphTraversal<S,E>
- Specified by:
profile
in interfaceTraversal<S,E>
- Returns:
- the updated traversal with respective
ProfileSideEffectStep
. - See Also:
- Reference Documentation - Profile Step
-
property
default CredentialTraversal<S,E> property(VertexProperty.Cardinality cardinality, Object key, Object value, Object... keyValues)
Description copied from interface:GraphTraversal
Sets aProperty
value and related meta properties if supplied, if supported by theGraph
and if theElement
is aVertexProperty
. This method is the long-hand version ofGraphTraversal.property(Object, Object, Object...)
with the difference that theVertexProperty.Cardinality
can be supplied. * Generally speaking, this method will append anAddPropertyStep
to theTraversal
but when possible, this method will attempt to fold key/value pairs into anAddVertexStep
,AddEdgeStep
orAddVertexStartStep
. This potential optimization can only happen if cardinality is not supplied and when meta-properties are not included.- Specified by:
property
in interfaceGraphTraversal<S,E>
- Parameters:
cardinality
- the specified cardinality of the property wherenull
will allow theGraph
to use its default settingskey
- the key for the propertyvalue
- the value for the property which may not be null if thekey
is of typeT
keyValues
- any meta properties to be assigned to this property- Returns:
- the traversal with the last step modified to add a property
- See Also:
- AddProperty Step
-
property
default CredentialTraversal<S,E> property(Object key, Object value, Object... keyValues)
Description copied from interface:GraphTraversal
Sets the key and value of aProperty
. If theElement
is aVertexProperty
and theGraph
supports it, meta properties can be set. Use of this method assumes that theVertexProperty.Cardinality
is defaulted tonull
which means that the default cardinality for theGraph
will be used. If aMap
is supplied then each of the key/value pairs in the map will be added as property. This method is the long-hand version of looping through theGraphTraversal.property(Object, Object, Object...)
method for each key/value pair supplied. If aCardinalityValueTraversal
is specified as a value then it will override anyVertexProperty.Cardinality
specified for thekey
. This method is effectively callsGraphTraversal.property(VertexProperty.Cardinality, Object, Object, Object...)
asproperty(null, key, value, keyValues
.- Specified by:
property
in interfaceGraphTraversal<S,E>
- Parameters:
key
- the key for the propertyvalue
- the value for the propertykeyValues
- any meta properties to be assigned to this property- Returns:
- the traversal with the last step modified to add a property
- See Also:
- AddProperty Step
-
property
default CredentialTraversal<S,E> property(Map<Object,Object> value)
Description copied from interface:GraphTraversal
When aMap
is supplied then each of the key/value pairs in the map will be added as property. This method is the long-hand version of looping through theGraphTraversal.property(Object, Object, Object...)
method for each key/value pair supplied. A value may use aCardinalityValueTraversal
to allow specification of theVertexProperty.Cardinality
along with the property value itself. If aMap
is not supplied then an exception is thrown. This method is effectively callsGraphTraversal.property(VertexProperty.Cardinality, Object, Object, Object...)
asproperty(null, key, value, keyValues
.- Specified by:
property
in interfaceGraphTraversal<S,E>
- Parameters:
value
- the value for the property- Returns:
- the traversal with the last step modified to add a property
- See Also:
- AddProperty Step
-
branch
default <M,E2> CredentialTraversal<S,E2> branch(Traversal<?,M> branchTraversal)
Description copied from interface:GraphTraversal
Split theTraverser
to all the specified traversals.- Specified by:
branch
in interfaceGraphTraversal<S,E>
- Parameters:
branchTraversal
- the traversal to branch theTraverser
to- Returns:
- the
Traversal
with theBranchStep
added - See Also:
- Reference Documentation - General Steps
-
branch
default <M,E2> CredentialTraversal<S,E2> branch(Function<Traverser<E>,M> function)
Description copied from interface:GraphTraversal
Split theTraverser
to all the specified functions.- Specified by:
branch
in interfaceGraphTraversal<S,E>
- Parameters:
function
- the traversal to branch theTraverser
to- Returns:
- the
Traversal
with theBranchStep
added - See Also:
- Reference Documentation - General Steps
-
choose
default <M,E2> CredentialTraversal<S,E2> choose(Traversal<?,M> choiceTraversal)
Description copied from interface:GraphTraversal
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal. Achoose
is modified byGraphTraversal.option(M, org.apache.tinkerpop.gremlin.process.traversal.Traversal<?, E2>)
which provides the various branch choices.- Specified by:
choose
in interfaceGraphTraversal<S,E>
- Parameters:
choiceTraversal
- the traversal used to determine the value for the branch- Returns:
- the traversal with the appended
ChooseStep
- See Also:
- Reference Documentation - Choose Step
-
choose
default <E2> CredentialTraversal<S,E2> choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
Description copied from interface:GraphTraversal
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.- Specified by:
choose
in interfaceGraphTraversal<S,E>
- Parameters:
traversalPredicate
- the traversal used to determine the "if" portion of the if-then-elsetrueChoice
- the traversal to execute in the event thetraversalPredicate
returns truefalseChoice
- the traversal to execute in the event thetraversalPredicate
returns false- Returns:
- the traversal with the appended
ChooseStep
- See Also:
- Reference Documentation - Choose Step
-
choose
default <E2> CredentialTraversal<S,E2> choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice)
Description copied from interface:GraphTraversal
Routes the current traverser to a particular traversal branch option which allows the creation of if-then like semantics within a traversal.- Specified by:
choose
in interfaceGraphTraversal<S,E>
- Parameters:
traversalPredicate
- the traversal used to determine the "if" portion of the if-then-elsetrueChoice
- the traversal to execute in the event thetraversalPredicate
returns true- Returns:
- the traversal with the appended
ChooseStep
- See Also:
- Reference Documentation - Choose Step
-
choose
default <M,E2> CredentialTraversal<S,E2> choose(Function<E,M> choiceFunction)
Description copied from interface:GraphTraversal
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal. Achoose
is modified byGraphTraversal.option(M, org.apache.tinkerpop.gremlin.process.traversal.Traversal<?, E2>)
which provides the various branch choices.- Specified by:
choose
in interfaceGraphTraversal<S,E>
- Parameters:
choiceFunction
- the function used to determine the value for the branch- Returns:
- the traversal with the appended
ChooseStep
- See Also:
- Reference Documentation - Choose Step
-
choose
default <E2> CredentialTraversal<S,E2> choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
Description copied from interface:GraphTraversal
Routes the current traverser to a particular traversal branch option which allows the creation of if-then-else like semantics within a traversal.- Specified by:
choose
in interfaceGraphTraversal<S,E>
- Parameters:
choosePredicate
- the function used to determine the "if" portion of the if-then-elsetrueChoice
- the traversal to execute in the event thetraversalPredicate
returns truefalseChoice
- the traversal to execute in the event thetraversalPredicate
returns false- Returns:
- the traversal with the appended
ChooseStep
- See Also:
- Reference Documentation - Choose Step
-
choose
default <E2> CredentialTraversal<S,E2> choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice)
Description copied from interface:GraphTraversal
Routes the current traverser to a particular traversal branch option which allows the creation of if-then like semantics within a traversal.- Specified by:
choose
in interfaceGraphTraversal<S,E>
- Parameters:
choosePredicate
- the function used to determine the "if" portion of the if-then-elsetrueChoice
- the traversal to execute in the event thetraversalPredicate
returns true- Returns:
- the traversal with the appended
ChooseStep
- See Also:
- Reference Documentation - Choose Step
-
optional
default <E2> CredentialTraversal<S,E2> optional(Traversal<?,E2> optionalTraversal)
Description copied from interface:GraphTraversal
Returns the result of the specified traversal if it yields a result, otherwise it returns the calling element.- Specified by:
optional
in interfaceGraphTraversal<S,E>
- Parameters:
optionalTraversal
- the traversal to execute for a potential result- Returns:
- the traversal with the appended
ChooseStep
- See Also:
- Reference Documentation - Optional Step
-
union
default <E2> CredentialTraversal<S,E2> union(Traversal<?,E2>... unionTraversals)
Description copied from interface:GraphTraversal
Merges the results of an arbitrary number of traversals.- Specified by:
union
in interfaceGraphTraversal<S,E>
- Parameters:
unionTraversals
- the traversals to merge- Returns:
- the traversal with the appended
UnionStep
- See Also:
- Reference Documentation - Union Step
-
coalesce
default <E2> CredentialTraversal<S,E2> coalesce(Traversal<?,E2>... coalesceTraversals)
Description copied from interface:GraphTraversal
Evaluates the provided traversals and returns the result of the first traversal to emit at least one object.- Specified by:
coalesce
in interfaceGraphTraversal<S,E>
- Parameters:
coalesceTraversals
- the traversals to coalesce- Returns:
- the traversal with the appended
CoalesceStep
- See Also:
- Reference Documentation - Coalesce Step
-
repeat
default CredentialTraversal<S,E> repeat(Traversal<?,E> repeatTraversal)
Description copied from interface:GraphTraversal
This step is used for looping over a traversal given some break predicate.- Specified by:
repeat
in interfaceGraphTraversal<S,E>
- Parameters:
repeatTraversal
- the traversal to repeat over- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
repeat
default CredentialTraversal<S,E> repeat(String loopName, Traversal<?,E> repeatTraversal)
Description copied from interface:GraphTraversal
This step is used for looping over a traversal given some break predicate and with a specified loop name.- Specified by:
repeat
in interfaceGraphTraversal<S,E>
- Parameters:
loopName
- The name given to the looprepeatTraversal
- the traversal to repeat over- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
emit
default CredentialTraversal<S,E> emit(Traversal<?,?> emitTraversal)
Description copied from interface:GraphTraversal
Emit is used in conjunction withGraphTraversal.repeat(Traversal)
to determine what objects get emit from the loop.- Specified by:
emit
in interfaceGraphTraversal<S,E>
- Parameters:
emitTraversal
- the emit predicate defined as a traversal- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
emit
default CredentialTraversal<S,E> emit(Predicate<Traverser<E>> emitPredicate)
Description copied from interface:GraphTraversal
Emit is used in conjunction withGraphTraversal.repeat(Traversal)
to determine what objects get emit from the loop.- Specified by:
emit
in interfaceGraphTraversal<S,E>
- Parameters:
emitPredicate
- the emit predicate- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
emit
default CredentialTraversal<S,E> emit()
Description copied from interface:GraphTraversal
Emit is used in conjunction withGraphTraversal.repeat(Traversal)
to emit all objects from the loop.- Specified by:
emit
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
until
default CredentialTraversal<S,E> until(Traversal<?,?> untilTraversal)
Description copied from interface:GraphTraversal
Modifies aGraphTraversal.repeat(Traversal)
to determine when the loop should exit.- Specified by:
until
in interfaceGraphTraversal<S,E>
- Parameters:
untilTraversal
- the traversal that determines when the loop exits- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
until
default CredentialTraversal<S,E> until(Predicate<Traverser<E>> untilPredicate)
Description copied from interface:GraphTraversal
Modifies aGraphTraversal.repeat(Traversal)
to determine when the loop should exit.- Specified by:
until
in interfaceGraphTraversal<S,E>
- Parameters:
untilPredicate
- the predicate that determines when the loop exits- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
times
default CredentialTraversal<S,E> times(int maxLoops)
Description copied from interface:GraphTraversal
Modifies aGraphTraversal.repeat(Traversal)
to specify how many loops should occur before exiting.- Specified by:
times
in interfaceGraphTraversal<S,E>
- Parameters:
maxLoops
- the number of loops to execute prior to exiting- Returns:
- the traversal with the appended
RepeatStep
- See Also:
- Reference Documentation - Repeat Step
-
local
default <E2> CredentialTraversal<S,E2> local(Traversal<?,E2> localTraversal)
Description copied from interface:GraphTraversal
Provides a execute a specified traversal on a single element within a stream.- Specified by:
local
in interfaceGraphTraversal<S,E>
- Parameters:
localTraversal
- the traversal to execute locally- Returns:
- the traversal with the appended
LocalStep
- See Also:
- Reference Documentation - Local Step
-
pageRank
default CredentialTraversal<S,E> pageRank()
Description copied from interface:GraphTraversal
Calculates a PageRank over the graph using a 0.85 for thealpha
value.- Specified by:
pageRank
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the appended
PageRankVertexProgramStep
- See Also:
- Reference Documentation - PageRank Step
-
pageRank
default CredentialTraversal<S,E> pageRank(double alpha)
Description copied from interface:GraphTraversal
Calculates a PageRank over the graph.- Specified by:
pageRank
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the appended
PageRankVertexProgramStep
- See Also:
- Reference Documentation - PageRank Step
-
peerPressure
default CredentialTraversal<S,E> peerPressure()
Description copied from interface:GraphTraversal
Executes a Peer Pressure community detection algorithm over the graph.- Specified by:
peerPressure
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the appended
PeerPressureVertexProgramStep
- See Also:
- Reference Documentation - PeerPressure Step
-
connectedComponent
default CredentialTraversal<S,E> connectedComponent()
Description copied from interface:GraphTraversal
Executes a Connected Component algorithm over the graph.- Specified by:
connectedComponent
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the appended
ConnectedComponentVertexProgram
- See Also:
- Reference Documentation - ConnectedComponent Step
-
shortestPath
default CredentialTraversal<S,Path> shortestPath()
Description copied from interface:GraphTraversal
Executes a Shortest Path algorithm over the graph.- Specified by:
shortestPath
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the appended
ShortestPathVertexProgramStep
- See Also:
- Reference Documentation - ShortestPath Step
-
program
default CredentialTraversal<S,E> program(VertexProgram<?> vertexProgram)
Description copied from interface:GraphTraversal
Executes an arbitraryVertexProgram
over the graph.- Specified by:
program
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the appended
ProgramVertexProgramStep
- See Also:
- Reference Documentation - Program Step
-
as
default CredentialTraversal<S,E> as(String stepLabel, String... stepLabels)
Description copied from interface:GraphTraversal
A step modulator that provides a label to the step that can be accessed later in the traversal by other steps.- Specified by:
as
in interfaceGraphTraversal<S,E>
- Parameters:
stepLabel
- the name of the stepstepLabels
- additional names for the label- Returns:
- the traversal with the modified end step
- See Also:
- Reference Documentation - As Step
-
barrier
default CredentialTraversal<S,E> barrier()
Description copied from interface:GraphTraversal
Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to the size of the barrier. In this case, it iterates the entire thing as the default barrier size is set toInteger.MAX_VALUE
.- Specified by:
barrier
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
NoOpBarrierStep
- See Also:
- Reference Documentation - Barrier Step
-
barrier
default CredentialTraversal<S,E> barrier(int maxBarrierSize)
Description copied from interface:GraphTraversal
Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to the size of the barrier.- Specified by:
barrier
in interfaceGraphTraversal<S,E>
- Parameters:
maxBarrierSize
- the size of the barrier- Returns:
- the traversal with an appended
NoOpBarrierStep
- See Also:
- Reference Documentation - Barrier Step
-
index
default <E2> CredentialTraversal<S,E2> index()
Description copied from interface:GraphTraversal
Indexes all items of the current collection. The indexing format can be configured using theGraphTraversal.with(String, Object)
andWithOptions.indexer
. Indexed as list: ["a","b","c"] => [["a",0],["b",1],["c",2]] Indexed as map: ["a","b","c"] => {0:"a",1:"b",2:"c"} If the current object is not a collection, this step will map the object to a single item collection/map: Indexed as list: "a" => ["a",0] Indexed as map: "a" => {0:"a"}- Specified by:
index
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with an appended
IndexStep
- See Also:
- Reference Documentation - Index Step
-
barrier
default CredentialTraversal<S,E> barrier(Consumer<TraverserSet<Object>> barrierConsumer)
Description copied from interface:GraphTraversal
Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to the size of the barrier. In this case, it iterates the entire thing as the default barrier size is set toInteger.MAX_VALUE
.- Specified by:
barrier
in interfaceGraphTraversal<S,E>
- Parameters:
barrierConsumer
- a consumer function that is applied to the objects aggregated to the barrier- Returns:
- the traversal with an appended
NoOpBarrierStep
- See Also:
- Reference Documentation - Barrier Step
-
with
default CredentialTraversal<S,E> with(String key)
Description copied from interface:GraphTraversal
Provides a configuration to a step in the form of a key which is the same aswith(key, true)
. The key of the configuration must be step specific and therefore a configuration could be supplied that is not known to be valid until execution.- Specified by:
with
in interfaceGraphTraversal<S,E>
- Parameters:
key
- the key of the configuration to apply to a step- Returns:
- the traversal with a modulated step
- See Also:
- Reference Documentation - With Step
-
with
default CredentialTraversal<S,E> with(String key, Object value)
Description copied from interface:GraphTraversal
Provides a configuration to a step in the form of a key and value pair. The key of the configuration must be step specific and therefore a configuration could be supplied that is not known to be valid until execution.- Specified by:
with
in interfaceGraphTraversal<S,E>
- Parameters:
key
- the key of the configuration to apply to a stepvalue
- the value of the configuration to apply to a step- Returns:
- the traversal with a modulated step
- See Also:
- Reference Documentation - With Step
-
by
default CredentialTraversal<S,E> by()
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. This form is essentially anGraphTraversal.identity()
modulation.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default CredentialTraversal<S,E> by(Traversal<?,?> traversal)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified traversal.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
traversal
- the traversal to apply- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default CredentialTraversal<S,E> by(T token)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified token ofT
.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
token
- the token to apply- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default CredentialTraversal<S,E> by(String key)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified key.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
key
- the key to apply- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default <V> CredentialTraversal<S,E> by(Function<V,Object> function)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified function.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
function
- the function to apply- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default <V> CredentialTraversal<S,E> by(Traversal<?,?> traversal, Comparator<V> comparator)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified function.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
traversal
- the traversal to applycomparator
- the comparator to apply typically for someGraphTraversal.order()
- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default CredentialTraversal<S,E> by(Comparator<E> comparator)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified function.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
comparator
- the comparator to apply typically for someGraphTraversal.order()
- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default CredentialTraversal<S,E> by(Order order)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified function.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
order
- the comparator to apply typically for someGraphTraversal.order()
- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default <V> CredentialTraversal<S,E> by(String key, Comparator<V> comparator)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified function.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
key
- the key to apply traversalcomparator
- the comparator to apply typically for someGraphTraversal.order()
- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
by
default <U> CredentialTraversal<S,E> by(Function<U,Object> function, Comparator comparator)
Description copied from interface:GraphTraversal
Theby()
can be applied to a number of different step to alter their behaviors. Modifies the previous step with the specified function.- Specified by:
by
in interfaceGraphTraversal<S,E>
- Parameters:
function
- the function to applycomparator
- the comparator to apply typically for someGraphTraversal.order()
- Returns:
- the traversal with a modulated step.
- See Also:
- Reference Documentation - By Step
-
option
default <M,E2> CredentialTraversal<S,E> option(M token, Traversal<?,E2> traversalOption)
Description copied from interface:GraphTraversal
This is a step modulator to aTraversalOptionParent
likechoose()
ormergeV()
where the provided argument associated to thetoken
is applied according to the semantics of the step. Please see the documentation of such steps to understand the usage context.- Specified by:
option
in interfaceGraphTraversal<S,E>
- Parameters:
token
- the token that would trigger this option which may be aPick
,Merge
, aTraversal
,Predicate
, or object depending on the step being modulated.traversalOption
- the option as a traversal- Returns:
- the traversal with the modulated step
- See Also:
- Reference Documentation - Choose Step, Reference Documentation - MergeV Step, Reference Documentation - MergeE Step
-
option
default <M,E2> CredentialTraversal<S,E> option(M token, Map<Object,Object> m)
Description copied from interface:GraphTraversal
This is a step modulator to aTraversalOptionParent
likechoose()
ormergeV()
where the provided argument associated to thetoken
is applied according to the semantics of the step. Please see the documentation of such steps to understand the usage context.- Specified by:
option
in interfaceGraphTraversal<S,E>
m
- Provides aMap
as the option which is the same as doingconstant(m)
.- Returns:
- the traversal with the modulated step
- See Also:
- Reference Documentation - MergeV Step, Reference Documentation - MergeE Step
-
option
default <M,E2> CredentialTraversal<S,E> option(Merge merge, Map<Object,Object> m, VertexProperty.Cardinality cardinality)
Description copied from interface:GraphTraversal
This is a step modulator to aTraversalOptionParent
likechoose()
ormergeV()
where the provided argument associated to thetoken
is applied according to the semantics of the step. Please see the documentation of such steps to understand the usage context.- Specified by:
option
in interfaceGraphTraversal<S,E>
m
- Provides aMap
as the option which is the same as doingconstant(m)
.- Returns:
- the traversal with the modulated step
- See Also:
- Reference Documentation - MergeV Step, Reference Documentation - MergeE Step
-
option
default <E2> CredentialTraversal<S,E> option(Traversal<?,E2> traversalOption)
Description copied from interface:GraphTraversal
This step modifiesGraphTraversal.choose(Function)
to specifies the available choices that might be executed.- Specified by:
option
in interfaceGraphTraversal<S,E>
- Parameters:
traversalOption
- the option as a traversal- Returns:
- the traversal with the modulated step
- See Also:
- Reference Documentation - Choose Step
-
read
default CredentialTraversal<S,E> read()
Description copied from interface:GraphTraversal
This step is technically a step modulator for the theGraphTraversalSource.io(String)
step which instructs the step to perform a read with its given configuration.- Specified by:
read
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the
IoStep
modulated to read - See Also:
- Reference Documentation - IO Step, Reference Documentation - Read Step
-
write
default CredentialTraversal<S,E> write()
Description copied from interface:GraphTraversal
This step is technically a step modulator for the theGraphTraversalSource.io(String)
step which instructs the step to perform a write with its given configuration.- Specified by:
write
in interfaceGraphTraversal<S,E>
- Returns:
- the traversal with the
IoStep
modulated to write - See Also:
- Reference Documentation - IO Step, Reference Documentation - Write Step
-
iterate
default CredentialTraversal<S,E> iterate()
Description copied from interface:Traversal
Iterate all theTraverser
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.
-
-