public interface CredentialTraversal<S,E> extends CredentialTraversalDsl<S,E>
GraphTraversal.Admin<S,E>, GraphTraversal.SymbolsTraversal.ExceptionsBCRYPT_ROUNDS| Modifier and Type | Method and Description |
|---|---|
default CredentialTraversal<S,Edge> |
addE(String edgeLabel)
Adds an
Edge with the specified edge label. |
default CredentialTraversal<S,Edge> |
addE(Traversal<?,String> edgeLabelTraversal)
|
default CredentialTraversal<S,Vertex> |
addV()
Adds a
Vertex with a default vertex label. |
default CredentialTraversal<S,Vertex> |
addV(String vertexLabel)
Adds a
Vertex. |
default CredentialTraversal<S,Vertex> |
addV(Traversal<?,String> vertexLabelTraversal)
|
default CredentialTraversal<S,E> |
aggregate(Scope scope,
String sideEffectKey)
Collects objects in a list using the
Scope argument to determine whether it should be lazy
Scope.local or eager (Scope.global while gathering those objects. |
default CredentialTraversal<S,E> |
aggregate(String sideEffectKey)
Eagerly collects objects up to this step into a side-effect.
|
default CredentialTraversal<S,E> |
and(Traversal<?,?>... andTraversals)
Ensures that all of the provided traversals yield a result.
|
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,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(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,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,Vertex> |
both(String... edgeLabels)
Map the
Vertex to its adjacent vertices given the edge labels. |
default CredentialTraversal<S,Edge> |
bothE(String... edgeLabels)
Map the
Vertex to its incident edges given the edge labels. |
default CredentialTraversal<S,Vertex> |
bothV()
Map the
Edge to its incident vertices. |
default <M,E2> CredentialTraversal<S,E2> |
branch(Function<Traverser<E>,M> function)
Split the
Traverser to all the specified functions. |
default <M,E2> CredentialTraversal<S,E2> |
branch(Traversal<?,M> branchTraversal)
Split the
Traverser to all the specified traversals. |
default CredentialTraversal<S,E> |
by()
The
by() can be applied to a number of different step to alter their behaviors. |
default CredentialTraversal<S,E> |
by(Comparator<E> comparator)
The
by() 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)
The
by() can be applied to a number of different step to alter their behaviors. |
default <V> CredentialTraversal<S,E> |
by(Function<V,Object> function)
The
by() can be applied to a number of different step to alter their behaviors. |
default CredentialTraversal<S,E> |
by(Order order)
The
by() can be applied to a number of different step to alter their behaviors. |
default CredentialTraversal<S,E> |
by(String key)
The
by() can be applied to a number of different step to alter their behaviors. |
default <V> CredentialTraversal<S,E> |
by(String key,
Comparator<V> comparator)
The
by() can be applied to a number of different step to alter their behaviors. |
default CredentialTraversal<S,E> |
by(T token)
The
by() can be applied to a number of different step to alter their behaviors. |
default CredentialTraversal<S,E> |
by(Traversal<?,?> traversal)
The
by() can be applied to a number of different step to alter their behaviors. |
default <V> CredentialTraversal<S,E> |
by(Traversal<?,?> traversal,
Comparator<V> comparator)
The
by() can be applied to a number of different step to alter their behaviors. |
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 the
E object given a biased coin toss. |
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 fixed
E value. |
default CredentialTraversal<S,Long> |
count()
Map the traversal stream to its reduction as a sum of the
Traverser.bulk() values (i.e. |
default CredentialTraversal<S,Long> |
count(Scope scope)
Map the traversal stream to its reduction as a sum of the
Traverser.bulk() values given the specified
Scope (i.e. |
default CredentialTraversal<S,E> |
cyclicPath()
|
default CredentialTraversal<S,E> |
dedup(Scope scope,
String... dedupLabels)
Remove all duplicates in the traversal stream up to this point.
|
default CredentialTraversal<S,E> |
dedup(String... dedupLabels)
Remove all duplicates in the traversal stream up to this point.
|
default CredentialTraversal<S,E> |
drop()
Removes elements and properties from the graph.
|
default <E2> CredentialTraversal<S,Map<Object,E2>> |
elementMap(String... propertyKeys)
|
default CredentialTraversal<S,E> |
emit()
Emit is used in conjunction with
GraphTraversal.repeat(Traversal) to emit all objects from the loop. |
default CredentialTraversal<S,E> |
emit(Predicate<Traverser<E>> emitPredicate)
Emit is used in conjunction with
GraphTraversal.repeat(Traversal) to determine what objects get emit from the loop. |
default CredentialTraversal<S,E> |
emit(Traversal<?,?> emitTraversal)
Emit is used in conjunction with
GraphTraversal.repeat(Traversal) to determine what objects get emit from the loop. |
default CredentialTraversal<S,E> |
filter(Predicate<Traverser<E>> predicate)
Map the
Traverser to either true or false, where false will not pass the
traverser to the next step. |
default CredentialTraversal<S,E> |
filter(Traversal<?,?> filterTraversal)
Map the
Traverser to either true or false, where false 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 a
seed and BiFunction. |
default CredentialTraversal<S,E> |
from(String fromStepLabel)
Provide
from()-modulation to respective steps. |
default CredentialTraversal<S,E> |
from(Traversal<?,Vertex> fromVertex)
When used as a modifier to
GraphTraversal.addE(String) this method specifies the traversal to use for selecting the
outgoing vertex of the newly added Edge. |
default CredentialTraversal<S,E> |
from(Vertex fromVertex)
When used as a modifier to
GraphTraversal.addE(String) this method specifies the traversal to use for selecting the
outgoing vertex of the newly added Edge. |
default <K,V> CredentialTraversal<S,Map<K,V>> |
group()
Organize objects in the stream into a
Map. |
default CredentialTraversal<S,E> |
group(String sideEffectKey)
Organize objects in the stream into a
Map. |
default <K> CredentialTraversal<S,Map<K,Long>> |
groupCount()
Counts the number of times a particular objects has been part of a traversal, returning a
Map 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 a
Map 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 propertyKey,
P<?> predicate)
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,
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(P<String> predicate)
Filters
Property objects based on their key. |
default CredentialTraversal<S,E> |
hasKey(String label,
String... otherLabels)
Filters
Property objects based on their key. |
default CredentialTraversal<S,E> |
hasLabel(P<String> predicate)
Filters vertices, edges and vertex properties based on their label.
|
default CredentialTraversal<S,E> |
hasLabel(String label,
String... otherLabels)
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)
Filters
Property objects based on their value. |
default CredentialTraversal<S,E> |
hasValue(P<Object> predicate)
Filters
Property objects based on their value.Note that calling this step with null is the same
as calling GraphTraversal.hasValue(Object, Object...) with a single null. |
default CredentialTraversal<S,Object> |
id()
Map the
Element to its Element.id(). |
default CredentialTraversal<S,E> |
identity()
Map the
E object to itself. |
default CredentialTraversal<S,Vertex> |
in(String... edgeLabels)
Map the
Vertex 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 the
Vertex 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,Vertex> |
inV()
|
default CredentialTraversal<S,E> |
is(Object value)
Filter the
E object if it is not P.eq(V) to the provided value. |
default CredentialTraversal<S,E> |
is(P<E> predicate)
Filters
E object values given the provided predicate. |
default CredentialTraversal<S,E> |
iterate()
Iterate all the
Traverser instances in the traversal. |
default CredentialTraversal<S,String> |
key()
Map the
Property to its Property.key(). |
default CredentialTraversal<S,String> |
label()
Map the
Element to its Element.label(). |
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 first
n objects are allowed as defined by the limit 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 the
Scope,
where only the first n objects are allowed as defined by the limit 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 the
Traverser supports looping then calling this method will extract the number of loops for that
traverser. |
default CredentialTraversal<S,Integer> |
loops(String loopName)
If the
Traverser supports looping then calling this method will extract the number of loops for that
traverser for the named loop. |
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> |
max()
Determines the largest value in the stream.
|
default <E2 extends Comparable> |
max(Scope scope)
Determines the largest value in the stream given the
Scope. |
default <E2 extends Number> |
mean()
Determines the mean value in the stream.
|
default <E2 extends Number> |
mean(Scope scope)
Determines the mean value in the stream given the
Scope. |
default <E2 extends Comparable> |
min()
Determines the smallest value in the stream.
|
default <E2 extends Comparable> |
min(Scope scope)
Determines the smallest value in the stream given the
Scope. |
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 does not return any objects.
|
default <M,E2> CredentialTraversal<S,E> |
option(M pick,
Traversal<?,E2> traversalOption)
This step modifies
GraphTraversal.choose(Function) to specifies the available choices that might be executed. |
default <E2> CredentialTraversal<S,E> |
option(Traversal<?,E2> traversalOption)
This step modifies
GraphTraversal.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 the
Scope.local object (e.g. |
default CredentialTraversal<S,Vertex> |
otherV()
Map the
Edge to the incident vertex that was not just traversed from in the path history. |
default CredentialTraversal<S,Vertex> |
out(String... edgeLabels)
Map the
Vertex to its outgoing adjacent vertices given the edge labels. |
default CredentialTraversal<S,Edge> |
outE(String... edgeLabels)
Map the
Vertex 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 the
alpha 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,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 arbitrary
VertexProgram over the graph. |
default <E2> CredentialTraversal<S,Map<String,E2>> |
project(String projectKey,
String... otherProjectKeys)
Projects the current object in the stream into a
Map that is keyed by the provided labels. |
default <E2> CredentialTraversal<S,? extends Property<E2>> |
properties(String... propertyKeys)
Map the
Element 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 a
Property. |
default CredentialTraversal<S,E> |
property(VertexProperty.Cardinality cardinality,
Object key,
Object value,
Object... keyValues)
Sets a
Property value and related meta properties if supplied, if supported by the Graph
and if the Element is a VertexProperty. |
default <E2> CredentialTraversal<S,Map<String,E2>> |
propertyMap(String... propertyKeys)
|
default CredentialTraversal<S,E> |
range(long low,
long arg1)
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 arg2)
Filter the objects in the traversal by the number of them to pass through the stream as constrained by the
Scope. |
default CredentialTraversal<S,E> |
read()
This step is technically a step modulator for the the
GraphTraversalSource.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 <E2> CredentialTraversal<S,E2> |
sack()
Map the
Traverser to its Traverser.sack() value. |
default <V,U> CredentialTraversal<S,E> |
sack(BiFunction<V,U,V> sackOperator)
Map the
Traverser to its Traverser.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,Collection<E2>> |
select(Column column)
A version of
select that allows for the extraction of a Column from objects in the traversal. |
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(String selectKey)
Map the
Traverser to the object specified by the selectKey. |
default <E2> CredentialTraversal<S,Map<String,E2>> |
select(String selectKey1,
String selectKey2,
String... otherSelectKeys)
|
default <E2> CredentialTraversal<S,E2> |
select(Traversal<S,E2> keyTraversal)
Map the
Traverser to the object specified by the key returned by the keyTraversal. |
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 the
Traverser and pass it to the next step unmodified. |
default CredentialTraversal<S,E> |
sideEffect(Traversal<?,?> sideEffectTraversal)
Perform some operation on the
Traverser and pass it to the next step unmodified. |
default CredentialTraversal<S,E> |
simplePath()
|
default CredentialTraversal<S,E> |
skip(long skip)
Filters out the first
n objects in the traversal. |
default <E2> CredentialTraversal<S,E2> |
skip(Scope scope,
long skip)
Filters out the first
n objects in the traversal. |
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 a
Graph object held in the specified side-effect
key. |
default <E2 extends Number> |
sum()
Map the traversal stream to its reduction as a sum of the
Traverser.get() values multiplied by their
Traverser.bulk() (i.e. |
default <E2 extends Number> |
sum(Scope scope)
Map the traversal stream to its reduction as a sum of the
Traverser.get() values multiplied by their
Traverser.bulk() given the specified Scope (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 the
Scope. |
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 the
Scope. |
default CredentialTraversal<S,E> |
timeLimit(long timeLimit)
Once the first
Traverser hits this step, a count down is started. |
default CredentialTraversal<S,E> |
times(int maxLoops)
Modifies a
GraphTraversal.repeat(Traversal) to specify how many loops should occur before exiting. |
default CredentialTraversal<S,Vertex> |
to(Direction direction,
String... edgeLabels)
Map the
Vertex to its adjacent vertices given a direction and edge labels. |
default CredentialTraversal<S,E> |
to(String toStepLabel)
Provide
to()-modulation to respective steps. |
default CredentialTraversal<S,E> |
to(Traversal<?,Vertex> toVertex)
When used as a modifier to
GraphTraversal.addE(String) this method specifies the traversal to use for selecting the
incoming vertex of the newly added Edge. |
default CredentialTraversal<S,E> |
to(Vertex toVertex)
When used as a modifier to
GraphTraversal.addE(String) this method specifies the traversal to use for selecting the
incoming vertex of the newly added Edge. |
default CredentialTraversal<S,Edge> |
toE(Direction direction,
String... edgeLabels)
Map the
Vertex to its incident edges given the direction and edge labels. |
default CredentialTraversal<S,Vertex> |
toV(Direction direction)
Map the
Edge to its incident vertices given the direction. |
default CredentialTraversal<S,Tree> |
tree()
Aggregates the emanating paths into a
Tree data structure. |
default CredentialTraversal<S,E> |
tree(String sideEffectKey)
Aggregates the emanating paths into a
Tree data structure. |
default <E2> CredentialTraversal<S,E2> |
unfold()
Unrolls a
Iterator, Iterable or Map 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 a
GraphTraversal.repeat(Traversal) to determine when the loop should exit. |
default CredentialTraversal<S,E> |
until(Traversal<?,?> untilTraversal)
Modifies a
GraphTraversal.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)
A
V step is usually used to start a traversal but it may also be used mid-traversal. |
default <E2> CredentialTraversal<S,E2> |
value()
Map the
Property to its Property.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 the
Element to the values of the associated properties given the provide property keys. |
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(String startKey,
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 as
with(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 the
GraphTraversalSource.io(String) step which
instructs the step to perform a write with its given configuration. |
addStep, cloneaddStart, addStarts, addStep, applyStrategies, equals, getBytecode, getEndStep, getGraph, getParent, getSideEffects, getStartStep, getSteps, getStrategies, getTraversalSource, getTraverserGenerator, getTraverserRequirements, getTraverserSetSupplier, isLocked, isRoot, nextTraverser, removeStep, removeStep, reset, setGraph, setParent, setSideEffects, setStrategiesasAdminclose, explain, fill, forEachRemaining, forEachRemaining, next, notifyClose, promise, toBulkSet, toList, toSet, toStream, tryNextdefault CredentialTraversal<S,Vertex> users()
CredentialTraversalDslusers in interface CredentialTraversalDsl<S,E>default CredentialTraversal<S,Vertex> users(String username, String... more)
CredentialTraversalDslusers in interface CredentialTraversalDsl<S,E>default CredentialTraversal<S,Vertex> user(String username, String password)
CredentialTraversalDsluser in interface CredentialTraversalDsl<S,E>default <E2> CredentialTraversal<S,E2> map(Function<Traverser<E>,E2> function)
GraphTraversalmap in interface GraphTraversal<S,E>function - the lambda expression that does the functional mappingLambdaMapStep.default <E2> CredentialTraversal<S,E2> map(Traversal<?,E2> mapTraversal)
GraphTraversalmap in interface GraphTraversal<S,E>mapTraversal - the traversal expression that does the functional mappingLambdaMapStep.default <E2> CredentialTraversal<S,E2> flatMap(Function<Traverser<E>,Iterator<E2>> function)
GraphTraversalTraverser referencing an object of type E to an iterator of objects of type E2.
The resultant iterator is drained one-by-one before a new E object is pulled in for processing.flatMap in interface GraphTraversal<S,E>E2 - the type of the returned iterator objectsfunction - the lambda expression that does the functional mappingLambdaFlatMapStep.default <E2> CredentialTraversal<S,E2> flatMap(Traversal<?,E2> flatMapTraversal)
GraphTraversalTraverser referencing an object of type E to an iterator of objects of type E2.
The internal traversal is drained one-by-one before a new E object is pulled in for processing.flatMap in interface GraphTraversal<S,E>E2 - the end type of the internal traversalflatMapTraversal - the traversal generating objects of type E2TraversalFlatMapStep.default CredentialTraversal<S,Object> id()
GraphTraversalElement to its Element.id().id in interface GraphTraversal<S,E>IdStep.default CredentialTraversal<S,String> label()
GraphTraversalElement to its Element.label().label in interface GraphTraversal<S,E>LabelStep.default CredentialTraversal<S,E> identity()
GraphTraversalE object to itself. In other words, a "no op."identity in interface GraphTraversal<S,E>IdentityStep.default <E2> CredentialTraversal<S,E2> constant(E2 e)
GraphTraversalE value.constant in interface GraphTraversal<S,E>ConstantStep.default CredentialTraversal<S,Vertex> V(Object... vertexIdsOrElements)
GraphTraversalV step is usually used to start a traversal but it may also be used mid-traversal.V in interface GraphTraversal<S,E>vertexIdsOrElements - vertices to inject into the traversalGraphStepdefault CredentialTraversal<S,Vertex> to(Direction direction, String... edgeLabels)
GraphTraversalVertex to its adjacent vertices given a direction and edge labels.to in interface GraphTraversal<S,E>direction - the direction to traverse from the current vertexedgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Vertex> out(String... edgeLabels)
GraphTraversalVertex to its outgoing adjacent vertices given the edge labels.out in interface GraphTraversal<S,E>edgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Vertex> in(String... edgeLabels)
GraphTraversalVertex to its incoming adjacent vertices given the edge labels.in in interface GraphTraversal<S,E>edgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Vertex> both(String... edgeLabels)
GraphTraversalVertex to its adjacent vertices given the edge labels.both in interface GraphTraversal<S,E>edgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Edge> toE(Direction direction, String... edgeLabels)
GraphTraversalVertex to its incident edges given the direction and edge labels.toE in interface GraphTraversal<S,E>direction - the direction to traverse from the current vertexedgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Edge> outE(String... edgeLabels)
GraphTraversalVertex to its outgoing incident edges given the edge labels.outE in interface GraphTraversal<S,E>edgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Edge> inE(String... edgeLabels)
GraphTraversalVertex to its incoming incident edges given the edge labels.inE in interface GraphTraversal<S,E>edgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Edge> bothE(String... edgeLabels)
GraphTraversalVertex to its incident edges given the edge labels.bothE in interface GraphTraversal<S,E>edgeLabels - the edge labels to traverseVertexStep.default CredentialTraversal<S,Vertex> toV(Direction direction)
GraphTraversalEdge to its incident vertices given the direction.toV in interface GraphTraversal<S,E>direction - the direction to traverser from the current edgeEdgeVertexStep.default CredentialTraversal<S,Vertex> inV()
GraphTraversalinV in interface GraphTraversal<S,E>EdgeVertexStep.default CredentialTraversal<S,Vertex> outV()
GraphTraversaloutV in interface GraphTraversal<S,E>EdgeVertexStep.default CredentialTraversal<S,Vertex> bothV()
GraphTraversalEdge to its incident vertices.bothV in interface GraphTraversal<S,E>EdgeVertexStep.default CredentialTraversal<S,Vertex> otherV()
GraphTraversalEdge to the incident vertex that was not just traversed from in the path history.otherV in interface GraphTraversal<S,E>EdgeOtherVertexStep.default CredentialTraversal<S,E> order()
GraphTraversalorder in interface GraphTraversal<S,E>OrderGlobalStep.default CredentialTraversal<S,E> order(Scope scope)
GraphTraversalScope.local object (e.g. a list, map, etc.) or the entire Scope.global traversal stream.order in interface GraphTraversal<S,E>scope - whether the ordering is the current local object or the entire global stream.OrderGlobalStep or OrderLocalStep depending on the scope.default <E2> CredentialTraversal<S,? extends Property<E2>> properties(String... propertyKeys)
GraphTraversalElement to its associated properties given the provide property keys.
If no property keys are provided, then all properties are emitted.properties in interface GraphTraversal<S,E>E2 - the value type of the returned propertiespropertyKeys - the properties to retrievePropertiesStep.default <E2> CredentialTraversal<S,E2> values(String... propertyKeys)
GraphTraversalElement to the values of the associated properties given the provide property keys.
If no property keys are provided, then all property values are emitted.values in interface GraphTraversal<S,E>E2 - the value type of the propertiespropertyKeys - the properties to retrieve their value fromPropertiesStep.default <E2> CredentialTraversal<S,Map<String,E2>> propertyMap(String... propertyKeys)
GraphTraversalElement to a Map of the properties key'd according to their Property.key().
If no property keys are provided, then all properties are retrieved.propertyMap in interface GraphTraversal<S,E>E2 - the value type of the returned propertiespropertyKeys - the properties to retrievePropertyMapStep.default <E2> CredentialTraversal<S,Map<Object,E2>> elementMap(String... propertyKeys)
GraphTraversalElement to a Map of the property values key'd according to their Property.key().
If no property keys are provided, then all property values are retrieved. For vertices, the Map will
be returned with the assumption of single property values along with T.id and T.label. Prefer
GraphTraversal.valueMap(String...) if multi-property processing is required. For edges, keys will include additional
related edge structure of Direction.IN and Direction.OUT which themselves are Map
instances of the particular Vertex represented by T.id and T.label.elementMap in interface GraphTraversal<S,E>E2 - the value type of the returned propertiespropertyKeys - the properties to retrieveElementMapStep.default <E2> CredentialTraversal<S,Map<Object,E2>> valueMap(String... propertyKeys)
GraphTraversalElement to a Map of the property values key'd according to their Property.key().
If no property keys are provided, then all property values are retrieved.valueMap in interface GraphTraversal<S,E>E2 - the value type of the returned propertiespropertyKeys - the properties to retrievePropertyMapStep.default <E2> CredentialTraversal<S,Map<Object,E2>> valueMap(boolean includeTokens, String... propertyKeys)
GraphTraversalElement to a Map of the property values key'd according to their Property.key().
If no property keys are provided, then all property values are retrieved.valueMap in interface GraphTraversal<S,E>E2 - the value type of the returned propertiesincludeTokens - whether to include T tokens in the emitted map.propertyKeys - the properties to retrievePropertyMapStep.default CredentialTraversal<S,String> key()
GraphTraversalProperty to its Property.key().key in interface GraphTraversal<S,E>PropertyKeyStep.default <E2> CredentialTraversal<S,E2> value()
GraphTraversalProperty to its Property.value().value in interface GraphTraversal<S,E>PropertyValueStep.default CredentialTraversal<S,Path> path()
GraphTraversalpath in interface GraphTraversal<S,E>PathStep.default <E2> CredentialTraversal<S,Map<String,E2>> match(Traversal<?,?>... matchTraversals)
GraphTraversalmatch in interface GraphTraversal<S,E>E2 - the type of the objects bound in the variablesmatchTraversals - the traversal that maintain variables which must hold for the life of the traverserMatchStep.default <E2> CredentialTraversal<S,E2> sack()
GraphTraversalTraverser to its Traverser.sack() value.sack in interface GraphTraversal<S,E>E2 - the sack value typeSackStep.default CredentialTraversal<S,Integer> loops()
GraphTraversalTraverser supports looping then calling this method will extract the number of loops for that
traverser.loops in interface GraphTraversal<S,E>LoopsStepdefault CredentialTraversal<S,Integer> loops(String loopName)
GraphTraversalTraverser supports looping then calling this method will extract the number of loops for that
traverser for the named loop.loops in interface GraphTraversal<S,E>LoopsStepdefault <E2> CredentialTraversal<S,Map<String,E2>> project(String projectKey, String... otherProjectKeys)
GraphTraversalMap that is keyed by the provided labels.project in interface GraphTraversal<S,E>ProjectStepdefault <E2> CredentialTraversal<S,Map<String,E2>> select(Pop pop, String selectKey1, String selectKey2, String... otherSelectKeys)
GraphTraversalselect in interface GraphTraversal<S,E>E2 - the type of the objects projectedpop - if there are multiple objects referenced in the path, the Pop to use.selectKey1 - the first key to projectselectKey2 - the second key to projectotherSelectKeys - the third+ keys to projectSelectStep.default <E2> CredentialTraversal<S,Map<String,E2>> select(String selectKey1, String selectKey2, String... otherSelectKeys)
GraphTraversalselect in interface GraphTraversal<S,E>E2 - the type of the objects projectedselectKey1 - the first key to projectselectKey2 - the second key to projectotherSelectKeys - the third+ keys to projectSelectStep.default <E2> CredentialTraversal<S,E2> select(Pop pop, String selectKey)
GraphTraversalselect in interface GraphTraversal<S,E>selectKey - the key to projectSelectStep.default <E2> CredentialTraversal<S,E2> select(String selectKey)
GraphTraversalTraverser to the object specified by the selectKey. Note that unlike other uses of
select where there are multiple keys, this use of select with a single key does not produce a
Map.select in interface GraphTraversal<S,E>selectKey - the key to projectSelectStep.default <E2> CredentialTraversal<S,E2> select(Pop pop, Traversal<S,E2> keyTraversal)
GraphTraversalTraverser to the object specified by the key returned by the keyTraversal and apply the Pop operation
to it.select in interface GraphTraversal<S,E>keyTraversal - the traversal expression that selects the key to projectSelectStep.default <E2> CredentialTraversal<S,E2> select(Traversal<S,E2> keyTraversal)
GraphTraversalTraverser to the object specified by the key returned by the keyTraversal. Note that unlike other uses of
select where there are multiple keys, this use of select with a traversal does not produce a
Map.select in interface GraphTraversal<S,E>keyTraversal - the traversal expression that selects the key to projectTraversalSelectStep.default <E2> CredentialTraversal<S,Collection<E2>> select(Column column)
GraphTraversalselect that allows for the extraction of a Column from objects in the traversal.select in interface GraphTraversal<S,E>column - the column to extractTraversalMapStepdefault <E2> CredentialTraversal<S,E2> unfold()
GraphTraversalIterator, Iterable or Map into a linear form or simply emits the object if it
is not one of those types.unfold in interface GraphTraversal<S,E>UnfoldStepdefault CredentialTraversal<S,List<E>> fold()
GraphTraversalfold in interface GraphTraversal<S,E>FoldStepdefault <E2> CredentialTraversal<S,E2> fold(E2 seed, BiFunction<E2,E,E2> foldFunction)
GraphTraversalseed and BiFunction.fold in interface GraphTraversal<S,E>seed - the value to provide as the first argument to the foldFunctionfoldFunction - the function to fold by where the first argument is the seed or the value returned from subsequent class and
the second argument is the value from the streamFoldStepdefault CredentialTraversal<S,Long> count()
GraphTraversalTraverser.bulk() values (i.e. count the number
of traversers up to this point).count in interface GraphTraversal<S,E>CountGlobalStep.default CredentialTraversal<S,Long> count(Scope scope)
GraphTraversalTraverser.bulk() values given the specified
Scope (i.e. count the number of traversers up to this point).count in interface GraphTraversal<S,E>CountGlobalStep or CountLocalStep depending on the Scopedefault <E2 extends Number> CredentialTraversal<S,E2> sum()
GraphTraversalTraverser.get() values multiplied by their
Traverser.bulk() (i.e. sum the traverser values up to this point).sum in interface GraphTraversal<S,E>SumGlobalStep.default <E2 extends Number> CredentialTraversal<S,E2> sum(Scope scope)
GraphTraversalTraverser.get() values multiplied by their
Traverser.bulk() given the specified Scope (i.e. sum the traverser values up to this point).sum in interface GraphTraversal<S,E>SumGlobalStep or SumLocalStep depending on the Scope.default <E2 extends Comparable> CredentialTraversal<S,E2> max()
GraphTraversalmax in interface GraphTraversal<S,E>MaxGlobalStep.default <E2 extends Comparable> CredentialTraversal<S,E2> max(Scope scope)
GraphTraversalScope.max in interface GraphTraversal<S,E>MaxGlobalStep or MaxLocalStep depending on the Scopedefault <E2 extends Comparable> CredentialTraversal<S,E2> min()
GraphTraversalmin in interface GraphTraversal<S,E>MinGlobalStep.default <E2 extends Comparable> CredentialTraversal<S,E2> min(Scope scope)
GraphTraversalScope.min in interface GraphTraversal<S,E>MinGlobalStep or MinLocalStep depending on the Scopedefault <E2 extends Number> CredentialTraversal<S,E2> mean()
GraphTraversalmean in interface GraphTraversal<S,E>MeanGlobalStep.default <E2 extends Number> CredentialTraversal<S,E2> mean(Scope scope)
GraphTraversalScope.mean in interface GraphTraversal<S,E>MeanGlobalStep or MeanLocalStep depending on the Scopedefault <K,V> CredentialTraversal<S,Map<K,V>> group()
GraphTraversalMap. Calls to group() are typically accompanied with
GraphTraversal.by() modulators which help specify how the grouping should occur.group in interface GraphTraversal<S,E>GroupStep.default <K> CredentialTraversal<S,Map<K,Long>> groupCount()
GraphTraversalMap where the
object is the key and the value is the count.groupCount in interface GraphTraversal<S,E>GroupCountStep.default CredentialTraversal<S,Tree> tree()
GraphTraversalTree data structure.tree in interface GraphTraversal<S,E>TreeStepdefault CredentialTraversal<S,Vertex> addV(String vertexLabel)
GraphTraversalVertex.addV in interface GraphTraversal<S,E>vertexLabel - the label of the Vertex to addAddVertexStep addeddefault CredentialTraversal<S,Vertex> addV(Traversal<?,String> vertexLabelTraversal)
GraphTraversaladdV in interface GraphTraversal<S,E>AddVertexStep addeddefault CredentialTraversal<S,Vertex> addV()
GraphTraversalVertex with a default vertex label.addV in interface GraphTraversal<S,E>AddVertexStep addeddefault CredentialTraversal<S,Edge> addE(String edgeLabel)
GraphTraversalEdge with the specified edge label.addE in interface GraphTraversal<S,E>edgeLabel - the label of the newly added edgeAddEdgeStep addeddefault CredentialTraversal<S,Edge> addE(Traversal<?,String> edgeLabelTraversal)
GraphTraversaladdE in interface GraphTraversal<S,E>AddEdgeStep addeddefault CredentialTraversal<S,E> to(String toStepLabel)
GraphTraversalto()-modulation to respective steps.to in interface GraphTraversal<S,E>toStepLabel - the step label to modulate to.FromToModulating step.default CredentialTraversal<S,E> from(String fromStepLabel)
GraphTraversalfrom()-modulation to respective steps.from in interface GraphTraversal<S,E>fromStepLabel - the step label to modulate to.FromToModulating step.default CredentialTraversal<S,E> to(Traversal<?,Vertex> toVertex)
GraphTraversalGraphTraversal.addE(String) this method specifies the traversal to use for selecting the
incoming vertex of the newly added Edge.to in interface GraphTraversal<S,E>toVertex - the traversal for selecting the incoming vertexAddEdgeStepdefault CredentialTraversal<S,E> from(Traversal<?,Vertex> fromVertex)
GraphTraversalGraphTraversal.addE(String) this method specifies the traversal to use for selecting the
outgoing vertex of the newly added Edge.from in interface GraphTraversal<S,E>fromVertex - the traversal for selecting the outgoing vertexAddEdgeStepdefault CredentialTraversal<S,E> to(Vertex toVertex)
GraphTraversalGraphTraversal.addE(String) this method specifies the traversal to use for selecting the
incoming vertex of the newly added Edge.to in interface GraphTraversal<S,E>toVertex - the vertex for selecting the incoming vertexAddEdgeStepdefault CredentialTraversal<S,E> from(Vertex fromVertex)
GraphTraversalGraphTraversal.addE(String) this method specifies the traversal to use for selecting the
outgoing vertex of the newly added Edge.from in interface GraphTraversal<S,E>fromVertex - the vertex for selecting the outgoing vertexAddEdgeStepdefault CredentialTraversal<S,Double> math(String expression)
GraphTraversalmath in interface GraphTraversal<S,E>expression - the mathematical expression with variables refering to scope variables.MathStep added.default CredentialTraversal<S,E> filter(Predicate<Traverser<E>> predicate)
GraphTraversalTraverser to either true or false, where false will not pass the
traverser to the next step.filter in interface GraphTraversal<S,E>predicate - the filter function to applyLambdaFilterStep addeddefault CredentialTraversal<S,E> filter(Traversal<?,?> filterTraversal)
GraphTraversalTraverser to either true or false, where false will not pass the
traverser to the next step.filter in interface GraphTraversal<S,E>filterTraversal - the filter traversal to applyTraversalFilterStep addeddefault CredentialTraversal<S,E> or(Traversal<?,?>... orTraversals)
GraphTraversalor in interface GraphTraversal<S,E>orTraversals - filter traversals where at least one must be satisfiedOrStepdefault CredentialTraversal<S,E> and(Traversal<?,?>... andTraversals)
GraphTraversaland in interface GraphTraversal<S,E>andTraversals - filter traversals that must be satisfiedAndStepdefault CredentialTraversal<S,E> inject(E... injections)
GraphTraversalinject in interface GraphTraversal<S,E>injections - the objects to add to the streamInjectStepdefault CredentialTraversal<S,E> dedup(Scope scope, String... dedupLabels)
GraphTraversaldedup in interface GraphTraversal<S,E>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.DedupGlobalStep or DedupLocalStep depending on scopedefault CredentialTraversal<S,E> dedup(String... dedupLabels)
GraphTraversaldedup in interface GraphTraversal<S,E>dedupLabels - if labels are provided, then the scoped object's labels determine de-duplication. No labels implies current object.DedupGlobalStep.default CredentialTraversal<S,E> where(String startKey, P<String> predicate)
GraphTraversalwhere in interface GraphTraversal<S,E>startKey - the key containing the object to filterpredicate - the filter to applyWherePredicateStepdefault CredentialTraversal<S,E> where(P<String> predicate)
GraphTraversalwhere in interface GraphTraversal<S,E>predicate - the filter to applyWherePredicateStepdefault CredentialTraversal<S,E> where(Traversal<?,?> whereTraversal)
GraphTraversalwhere in interface GraphTraversal<S,E>whereTraversal - the filter to applyWherePredicateStepdefault CredentialTraversal<S,E> has(String propertyKey, P<?> predicate)
GraphTraversalhas in interface GraphTraversal<S,E>propertyKey - the key of the property to filter onpredicate - the filter to apply to the key's valueHasStepdefault CredentialTraversal<S,E> has(T accessor, P<?> predicate)
GraphTraversalhas in interface GraphTraversal<S,E>accessor - the T accessor of the property to filter onpredicate - the filter to apply to the key's valueHasStepdefault CredentialTraversal<S,E> has(String propertyKey, Object value)
GraphTraversalhas in interface GraphTraversal<S,E>propertyKey - the key of the property to filter onvalue - the value to compare the property value to for equalityHasStepdefault CredentialTraversal<S,E> has(T accessor, Object value)
GraphTraversalhas in interface GraphTraversal<S,E>accessor - the T accessor of the property to filter onvalue - the value to compare the accessor value to for equalityHasStepdefault CredentialTraversal<S,E> has(String label, String propertyKey, P<?> predicate)
GraphTraversalhas in interface GraphTraversal<S,E>label - the label of the ElementpropertyKey - the key of the property to filter onpredicate - the filter to apply to the key's valueHasStepdefault CredentialTraversal<S,E> has(String label, String propertyKey, Object value)
GraphTraversalhas in interface GraphTraversal<S,E>label - the label of the ElementpropertyKey - the key of the property to filter onvalue - the value to compare the accessor value to for equalityHasStepdefault CredentialTraversal<S,E> has(T accessor, Traversal<?,?> propertyTraversal)
GraphTraversalT where only T.id and
T.label are supported.has in interface GraphTraversal<S,E>accessor - the T accessor of the property to filter onpropertyTraversal - the traversal to filter the accessor value byHasStepdefault CredentialTraversal<S,E> has(String propertyKey, Traversal<?,?> propertyTraversal)
GraphTraversalhas in interface GraphTraversal<S,E>propertyKey - the key of the property to filter onpropertyTraversal - the traversal to filter the property value byHasStepdefault CredentialTraversal<S,E> has(String propertyKey)
GraphTraversalhas in interface GraphTraversal<S,E>propertyKey - the key of the property to filter on for existenceHasStepdefault CredentialTraversal<S,E> hasNot(String propertyKey)
GraphTraversalhasNot in interface GraphTraversal<S,E>propertyKey - the key of the property to filter on for existenceHasStepdefault CredentialTraversal<S,E> hasLabel(String label, String... otherLabels)
GraphTraversalhasLabel in interface GraphTraversal<S,E>label - the label of the ElementotherLabels - additional labels of the ElementHasStepdefault CredentialTraversal<S,E> hasLabel(P<String> predicate)
GraphTraversalnull is the same as calling GraphTraversal.hasLabel(String, String...) with a single null.hasLabel in interface GraphTraversal<S,E>predicate - the filter to apply to the label of the ElementHasStepdefault CredentialTraversal<S,E> hasId(Object id, Object... otherIds)
GraphTraversalhasId in interface GraphTraversal<S,E>id - the identifier of the ElementotherIds - additional identifiers of the ElementHasStepdefault CredentialTraversal<S,E> hasId(P<Object> predicate)
GraphTraversalhasId in interface GraphTraversal<S,E>predicate - the filter to apply to the identifier of the ElementHasStepdefault CredentialTraversal<S,E> hasKey(String label, String... otherLabels)
GraphTraversalProperty objects based on their key. It is not meant to test key existence on an Edge or
a Vertex. In that case, prefer GraphTraversal.has(String).hasKey in interface GraphTraversal<S,E>label - the key of the PropertyotherLabels - additional key of the PropertyHasStepdefault CredentialTraversal<S,E> hasKey(P<String> predicate)
GraphTraversalProperty objects based on their key. It is not meant to test key existence on an Edge or
a Vertex. In that case, prefer GraphTraversal.has(String). Note that calling this step with null is
the same as calling GraphTraversal.hasKey(String, String...) with a single null.hasKey in interface GraphTraversal<S,E>predicate - the filter to apply to the key of the PropertyHasStepdefault CredentialTraversal<S,E> hasValue(Object value, Object... otherValues)
GraphTraversalProperty objects based on their value.hasValue in interface GraphTraversal<S,E>value - the value of the ElementotherValues - additional values of the ElementHasStepdefault CredentialTraversal<S,E> hasValue(P<Object> predicate)
GraphTraversalProperty objects based on their value.Note that calling this step with null is the same
as calling GraphTraversal.hasValue(Object, Object...) with a single null.hasValue in interface GraphTraversal<S,E>predicate - the filter to apply to the value of the ElementHasStepdefault CredentialTraversal<S,E> is(P<E> predicate)
GraphTraversalE object values given the provided predicate.is in interface GraphTraversal<S,E>predicate - the filter to applyIsStepdefault CredentialTraversal<S,E> is(Object value)
GraphTraversalE object if it is not P.eq(V) to the provided value.is in interface GraphTraversal<S,E>value - the value that the object must equal.IsStep.default CredentialTraversal<S,E> not(Traversal<?,?> notTraversal)
GraphTraversalnot in interface GraphTraversal<S,E>notTraversal - the traversal to filter by.NotStep.default CredentialTraversal<S,E> coin(double probability)
GraphTraversalE object given a biased coin toss.coin in interface GraphTraversal<S,E>probability - the probability that the object will pass throughCoinStep.default CredentialTraversal<S,E> range(long low, long arg1)
GraphTraversallow do not pass through and those that exceed the value of high will end the iteration.range in interface GraphTraversal<S,E>low - the number at which to start allowing objects through the streamarg1 - the number at which to end the stream - use -1 to emit all remaining objectsRangeGlobalStepdefault <E2> CredentialTraversal<S,E2> range(Scope scope, long low, long arg2)
GraphTraversalScope. Those before the value of low do not pass through and those that exceed the value of
high will end the iteration.range in interface GraphTraversal<S,E>scope - the scope of how to apply the rangelow - the number at which to start allowing objects through the streamarg2 - the number at which to end the stream - use -1 to emit all remaining objectsRangeGlobalStep or RangeLocalStep depending on scopedefault CredentialTraversal<S,E> limit(long limit)
GraphTraversaln objects are allowed as defined by the limit argument.limit in interface GraphTraversal<S,E>limit - the number at which to end the streamRangeGlobalStepdefault <E2> CredentialTraversal<S,E2> limit(Scope scope, long limit)
GraphTraversalScope,
where only the first n objects are allowed as defined by the limit argument.limit in interface GraphTraversal<S,E>scope - the scope of how to apply the limitlimit - the number at which to end the streamRangeGlobalStep or RangeLocalStep depending on scopedefault CredentialTraversal<S,E> tail()
GraphTraversaltail in interface GraphTraversal<S,E>TailGlobalStepdefault CredentialTraversal<S,E> tail(long limit)
GraphTraversaln objects will be returned as defined by the limit.tail in interface GraphTraversal<S,E>limit - the number at which to end the streamTailGlobalStepdefault <E2> CredentialTraversal<S,E2> tail(Scope scope)
GraphTraversalScope. In
this case, only the last object in the stream will be returned.tail in interface GraphTraversal<S,E>scope - the scope of how to apply the tailTailGlobalStep or TailLocalStep depending on scopedefault <E2> CredentialTraversal<S,E2> tail(Scope scope, long limit)
GraphTraversalScope. In
this case, only the last n objects will be returned as defined by the limit.tail in interface GraphTraversal<S,E>scope - the scope of how to apply the taillimit - the number at which to end the streamTailGlobalStep or TailLocalStep depending on scopedefault CredentialTraversal<S,E> skip(long skip)
GraphTraversaln objects in the traversal.skip in interface GraphTraversal<S,E>skip - the number of objects to skipRangeGlobalStepdefault <E2> CredentialTraversal<S,E2> skip(Scope scope, long skip)
GraphTraversaln objects in the traversal.skip in interface GraphTraversal<S,E>scope - the scope of how to apply the tailskip - the number of objects to skipRangeGlobalStep or RangeLocalStep depending on scopedefault CredentialTraversal<S,E> timeLimit(long timeLimit)
GraphTraversalTraverser hits this step, a count down is started. Once the time limit is up, all remaining traversers are filtered out.timeLimit in interface GraphTraversal<S,E>timeLimit - the count down timeTimeLimitStepdefault CredentialTraversal<S,E> simplePath()
GraphTraversalsimplePath in interface GraphTraversal<S,E>PathFilterStep.default CredentialTraversal<S,E> cyclicPath()
GraphTraversalcyclicPath in interface GraphTraversal<S,E>PathFilterStep.default CredentialTraversal<S,E> sample(int amountToSample)
GraphTraversalsample in interface GraphTraversal<S,E>amountToSample - the number of objects to allowSampleGlobalStepdefault CredentialTraversal<S,E> sample(Scope scope, int amountToSample)
GraphTraversalsample in interface GraphTraversal<S,E>scope - the scope of how to apply the sampleamountToSample - the number of objects to allowSampleGlobalStep or SampleLocalStep depending on the scopedefault CredentialTraversal<S,E> drop()
GraphTraversalg.V().drop().iterate().drop in interface GraphTraversal<S,E>DropStep addeddefault CredentialTraversal<S,E> sideEffect(Consumer<Traverser<E>> consumer)
GraphTraversalTraverser and pass it to the next step unmodified.sideEffect in interface GraphTraversal<S,E>consumer - the operation to perform at this step in relation to the TraverserLambdaSideEffectStepdefault CredentialTraversal<S,E> sideEffect(Traversal<?,?> sideEffectTraversal)
GraphTraversalTraverser and pass it to the next step unmodified.sideEffect in interface GraphTraversal<S,E>sideEffectTraversal - the operation to perform at this step in relation to the TraverserTraversalSideEffectStepdefault <E2> CredentialTraversal<S,E2> cap(String sideEffectKey, String... sideEffectKeys)
GraphTraversalMap.cap in interface GraphTraversal<S,E>sideEffectKey - the side-effect to emitsideEffectKeys - other side-effects to emitSideEffectCapStepdefault CredentialTraversal<S,Edge> subgraph(String sideEffectKey)
GraphTraversalGraph object held in the specified side-effect
key.subgraph in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key that will hold the subgraphSubgraphStepdefault CredentialTraversal<S,E> aggregate(String sideEffectKey)
GraphTraversalGraphTraversal.aggregate(Scope, String)
with a Scope.global.aggregate in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key that will hold the aggregated objectsAggregateGlobalStepdefault CredentialTraversal<S,E> aggregate(Scope scope, String sideEffectKey)
GraphTraversalScope argument to determine whether it should be lazy
Scope.local or eager (Scope.global while gathering those objects.aggregate in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key that will hold the aggregated objectsAggregateGlobalStepdefault CredentialTraversal<S,E> group(String sideEffectKey)
GraphTraversalMap. Calls to group() are typically accompanied with
GraphTraversal.by() modulators which help specify how the grouping should occur.group in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key that will hold the aggregated groupingGroupStep.default CredentialTraversal<S,E> groupCount(String sideEffectKey)
GraphTraversalMap where the
object is the key and the value is the count.groupCount in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key that will hold the aggregated groupingGroupCountStep.default CredentialTraversal<S,E> tree(String sideEffectKey)
GraphTraversalTree data structure.tree in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key that will hold the treeTreeStepdefault <V,U> CredentialTraversal<S,E> sack(BiFunction<V,U,V> sackOperator)
GraphTraversalTraverser to its Traverser.sack() value.sack in interface GraphTraversal<S,E>sackOperator - the operator to apply to the sack valueSackStep.default CredentialTraversal<S,E> store(String sideEffectKey)
GraphTraversalstore in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key that will hold the aggregateAggregateLocalStepdefault CredentialTraversal<S,E> profile(String sideEffectKey)
GraphTraversalprofile in interface GraphTraversal<S,E>sideEffectKey - the name of the side-effect key within which to hold the profile objectProfileSideEffectStepdefault CredentialTraversal<S,TraversalMetrics> profile()
Traversalprofile in interface GraphTraversal<S,E>profile in interface Traversal<S,E>ProfileSideEffectStep.default CredentialTraversal<S,E> none()
TraversalTraversal.iterate() was called. While it may be directly used, it is often a sign
that a traversal should be re-written in another form.default CredentialTraversal<S,E> property(VertexProperty.Cardinality cardinality, Object key, Object value, Object... keyValues)
GraphTraversalProperty value and related meta properties if supplied, if supported by the Graph
and if the Element is a VertexProperty. This method is the long-hand version of
GraphTraversal.property(Object, Object, Object...) with the difference that the VertexProperty.Cardinality
can be supplied.
Generally speaking, this method will append an AddPropertyStep to the Traversal but when
possible, this method will attempt to fold key/value pairs into an AddVertexStep, AddEdgeStep or
AddVertexStartStep. This potential optimization can only happen if cardinality is not supplied
and when meta-properties are not included.property in interface GraphTraversal<S,E>cardinality - the specified cardinality of the property where null will allow the Graph
to use its default settingskey - the key for the propertyvalue - the value for the propertykeyValues - any meta properties to be assigned to this propertydefault CredentialTraversal<S,E> property(Object key, Object value, Object... keyValues)
GraphTraversalProperty. If the Element is a VertexProperty and the
Graph supports it, meta properties can be set. Use of this method assumes that the
VertexProperty.Cardinality is defaulted to null which means that the default cardinality for
the Graph will be used.
This method is effectively calls GraphTraversal.property(VertexProperty.Cardinality, Object, Object, Object...)
as property(null, key, value, keyValues.property in interface GraphTraversal<S,E>key - the key for the propertyvalue - the value for the propertykeyValues - any meta properties to be assigned to this propertydefault <M,E2> CredentialTraversal<S,E2> branch(Traversal<?,M> branchTraversal)
GraphTraversalTraverser to all the specified traversals.branch in interface GraphTraversal<S,E>branchTraversal - the traversal to branch the Traverser toTraversal with the BranchStep addeddefault <M,E2> CredentialTraversal<S,E2> branch(Function<Traverser<E>,M> function)
GraphTraversalTraverser to all the specified functions.branch in interface GraphTraversal<S,E>function - the traversal to branch the Traverser toTraversal with the BranchStep addeddefault <M,E2> CredentialTraversal<S,E2> choose(Traversal<?,M> choiceTraversal)
GraphTraversalchoose is modified by GraphTraversal.option(M, org.apache.tinkerpop.gremlin.process.traversal.Traversal<?, E2>) which provides the various
branch choices.choose in interface GraphTraversal<S,E>choiceTraversal - the traversal used to determine the value for the branchChooseStepdefault <E2> CredentialTraversal<S,E2> choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
GraphTraversalchoose in interface GraphTraversal<S,E>traversalPredicate - the traversal used to determine the "if" portion of the if-then-elsetrueChoice - the traversal to execute in the event the traversalPredicate returns truefalseChoice - the traversal to execute in the event the traversalPredicate returns falseChooseStepdefault <E2> CredentialTraversal<S,E2> choose(Traversal<?,?> traversalPredicate, Traversal<?,E2> trueChoice)
GraphTraversalchoose in interface GraphTraversal<S,E>traversalPredicate - the traversal used to determine the "if" portion of the if-then-elsetrueChoice - the traversal to execute in the event the traversalPredicate returns trueChooseStepdefault <M,E2> CredentialTraversal<S,E2> choose(Function<E,M> choiceFunction)
GraphTraversalchoose is modified by GraphTraversal.option(M, org.apache.tinkerpop.gremlin.process.traversal.Traversal<?, E2>) which provides the various
branch choices.choose in interface GraphTraversal<S,E>choiceFunction - the function used to determine the value for the branchChooseStepdefault <E2> CredentialTraversal<S,E2> choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice, Traversal<?,E2> falseChoice)
GraphTraversalchoose in interface GraphTraversal<S,E>choosePredicate - the function used to determine the "if" portion of the if-then-elsetrueChoice - the traversal to execute in the event the traversalPredicate returns truefalseChoice - the traversal to execute in the event the traversalPredicate returns falseChooseStepdefault <E2> CredentialTraversal<S,E2> choose(Predicate<E> choosePredicate, Traversal<?,E2> trueChoice)
GraphTraversalchoose in interface GraphTraversal<S,E>choosePredicate - the function used to determine the "if" portion of the if-then-elsetrueChoice - the traversal to execute in the event the traversalPredicate returns trueChooseStepdefault <E2> CredentialTraversal<S,E2> optional(Traversal<?,E2> optionalTraversal)
GraphTraversaloptional in interface GraphTraversal<S,E>optionalTraversal - the traversal to execute for a potential resultChooseStepdefault <E2> CredentialTraversal<S,E2> union(Traversal<?,E2>... unionTraversals)
GraphTraversalunion in interface GraphTraversal<S,E>unionTraversals - the traversals to mergeUnionStepdefault <E2> CredentialTraversal<S,E2> coalesce(Traversal<?,E2>... coalesceTraversals)
GraphTraversalcoalesce in interface GraphTraversal<S,E>coalesceTraversals - the traversals to coalesceCoalesceStepdefault CredentialTraversal<S,E> repeat(Traversal<?,E> repeatTraversal)
GraphTraversalrepeat in interface GraphTraversal<S,E>repeatTraversal - the traversal to repeat overRepeatStepdefault CredentialTraversal<S,E> repeat(String loopName, Traversal<?,E> repeatTraversal)
GraphTraversalrepeat in interface GraphTraversal<S,E>loopName - The name given to the looprepeatTraversal - the traversal to repeat overRepeatStepdefault CredentialTraversal<S,E> emit(Traversal<?,?> emitTraversal)
GraphTraversalGraphTraversal.repeat(Traversal) to determine what objects get emit from the loop.emit in interface GraphTraversal<S,E>emitTraversal - the emit predicate defined as a traversalRepeatStepdefault CredentialTraversal<S,E> emit(Predicate<Traverser<E>> emitPredicate)
GraphTraversalGraphTraversal.repeat(Traversal) to determine what objects get emit from the loop.emit in interface GraphTraversal<S,E>emitPredicate - the emit predicateRepeatStepdefault CredentialTraversal<S,E> emit()
GraphTraversalGraphTraversal.repeat(Traversal) to emit all objects from the loop.emit in interface GraphTraversal<S,E>RepeatStepdefault CredentialTraversal<S,E> until(Traversal<?,?> untilTraversal)
GraphTraversalGraphTraversal.repeat(Traversal) to determine when the loop should exit.until in interface GraphTraversal<S,E>untilTraversal - the traversal that determines when the loop exitsRepeatStepdefault CredentialTraversal<S,E> until(Predicate<Traverser<E>> untilPredicate)
GraphTraversalGraphTraversal.repeat(Traversal) to determine when the loop should exit.until in interface GraphTraversal<S,E>untilPredicate - the predicate that determines when the loop exitsRepeatStepdefault CredentialTraversal<S,E> times(int maxLoops)
GraphTraversalGraphTraversal.repeat(Traversal) to specify how many loops should occur before exiting.times in interface GraphTraversal<S,E>maxLoops - the number of loops to execute prior to exitingRepeatStepdefault <E2> CredentialTraversal<S,E2> local(Traversal<?,E2> localTraversal)
GraphTraversallocal in interface GraphTraversal<S,E>localTraversal - the traversal to execute locallyLocalStepdefault CredentialTraversal<S,E> pageRank()
GraphTraversalalpha value.pageRank in interface GraphTraversal<S,E>PageRankVertexProgramStepdefault CredentialTraversal<S,E> pageRank(double alpha)
GraphTraversalpageRank in interface GraphTraversal<S,E>PageRankVertexProgramStepdefault CredentialTraversal<S,E> peerPressure()
GraphTraversalpeerPressure in interface GraphTraversal<S,E>PeerPressureVertexProgramStepdefault CredentialTraversal<S,E> connectedComponent()
GraphTraversalconnectedComponent in interface GraphTraversal<S,E>ConnectedComponentVertexProgramdefault CredentialTraversal<S,Path> shortestPath()
GraphTraversalshortestPath in interface GraphTraversal<S,E>ShortestPathVertexProgramStepdefault CredentialTraversal<S,E> program(VertexProgram<?> vertexProgram)
GraphTraversalVertexProgram over the graph.program in interface GraphTraversal<S,E>ProgramVertexProgramStepdefault CredentialTraversal<S,E> as(String stepLabel, String... stepLabels)
GraphTraversalas in interface GraphTraversal<S,E>stepLabel - the name of the stepstepLabels - additional names for the labeldefault CredentialTraversal<S,E> barrier()
GraphTraversalInteger.MAX_VALUE.barrier in interface GraphTraversal<S,E>NoOpBarrierStepdefault CredentialTraversal<S,E> barrier(int maxBarrierSize)
GraphTraversalbarrier in interface GraphTraversal<S,E>maxBarrierSize - the size of the barrierNoOpBarrierStepdefault <E2> CredentialTraversal<S,E2> index()
GraphTraversalGraphTraversal.with(String, Object)
and WithOptions.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"}index in interface GraphTraversal<S,E>IndexStepdefault CredentialTraversal<S,E> barrier(Consumer<TraverserSet<Object>> barrierConsumer)
GraphTraversalInteger.MAX_VALUE.barrier in interface GraphTraversal<S,E>barrierConsumer - a consumer function that is applied to the objects aggregated to the barrierNoOpBarrierStepdefault CredentialTraversal<S,E> with(String key)
GraphTraversalwith(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.with in interface GraphTraversal<S,E>key - the key of the configuration to apply to a stepdefault CredentialTraversal<S,E> with(String key, Object value)
GraphTraversalwith in interface GraphTraversal<S,E>key - the key of the configuration to apply to a stepvalue - the value of the configuration to apply to a stepdefault CredentialTraversal<S,E> by()
GraphTraversalby() can be applied to a number of different step to alter their behaviors. This form is essentially
an GraphTraversal.identity() modulation.by in interface GraphTraversal<S,E>default CredentialTraversal<S,E> by(Traversal<?,?> traversal)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified traversal.by in interface GraphTraversal<S,E>traversal - the traversal to applydefault CredentialTraversal<S,E> by(T token)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified token of T.by in interface GraphTraversal<S,E>token - the token to applydefault CredentialTraversal<S,E> by(String key)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified key.by in interface GraphTraversal<S,E>key - the key to applydefault <V> CredentialTraversal<S,E> by(Function<V,Object> function)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified function.by in interface GraphTraversal<S,E>function - the function to applydefault <V> CredentialTraversal<S,E> by(Traversal<?,?> traversal, Comparator<V> comparator)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified function.by in interface GraphTraversal<S,E>traversal - the traversal to applycomparator - the comparator to apply typically for some GraphTraversal.order()default CredentialTraversal<S,E> by(Comparator<E> comparator)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified function.by in interface GraphTraversal<S,E>comparator - the comparator to apply typically for some GraphTraversal.order()default CredentialTraversal<S,E> by(Order order)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified function.by in interface GraphTraversal<S,E>order - the comparator to apply typically for some GraphTraversal.order()default <V> CredentialTraversal<S,E> by(String key, Comparator<V> comparator)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified function.by in interface GraphTraversal<S,E>key - the key to apply traversalcomparator - the comparator to apply typically for some GraphTraversal.order()default <U> CredentialTraversal<S,E> by(Function<U,Object> function, Comparator comparator)
GraphTraversalby() can be applied to a number of different step to alter their behaviors. Modifies the previous
step with the specified function.by in interface GraphTraversal<S,E>function - the function to applycomparator - the comparator to apply typically for some GraphTraversal.order()default <M,E2> CredentialTraversal<S,E> option(M pick, Traversal<?,E2> traversalOption)
GraphTraversalGraphTraversal.choose(Function) to specifies the available choices that might be executed.option in interface GraphTraversal<S,E>pick - the token that would trigger this option which may be a TraversalOptionParent.Pick,
a Traversal, Predicate, or object depending on the step being modulated.traversalOption - the option as a traversaldefault <E2> CredentialTraversal<S,E> option(Traversal<?,E2> traversalOption)
GraphTraversalGraphTraversal.choose(Function) to specifies the available choices that might be executed.option in interface GraphTraversal<S,E>traversalOption - the option as a traversaldefault CredentialTraversal<S,E> read()
GraphTraversalGraphTraversalSource.io(String) step which
instructs the step to perform a read with its given configuration.read in interface GraphTraversal<S,E>IoStep modulated to readdefault CredentialTraversal<S,E> write()
GraphTraversalGraphTraversalSource.io(String) step which
instructs the step to perform a write with its given configuration.write in interface GraphTraversal<S,E>IoStep modulated to writedefault CredentialTraversal<S,E> iterate()
TraversalTraverser 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.Copyright © 2013–2022 Apache Software Foundation. All rights reserved.