public class GraphTraversalSource extends Object implements TraversalSource
GraphTraversalSource
is the primary DSL of the Gremlin traversal machine.
It provides access to all the configurations and steps for Turing complete graph computing.
Any DSL can be constructed based on the methods of both GraphTraversalSource
and GraphTraversal
.Modifier and Type | Class and Description |
---|---|
static class |
GraphTraversalSource.Symbols |
Modifier and Type | Field and Description |
---|---|
protected Bytecode |
bytecode |
protected org.apache.tinkerpop.gremlin.process.remote.RemoteConnection |
connection |
protected Graph |
graph |
protected TraversalStrategies |
strategies |
Constructor and Description |
---|
GraphTraversalSource(Graph graph) |
GraphTraversalSource(Graph graph,
TraversalStrategies traversalStrategies) |
GraphTraversalSource(org.apache.tinkerpop.gremlin.process.remote.RemoteConnection connection) |
Modifier and Type | Method and Description |
---|---|
GraphTraversal<Edge,Edge> |
addE(String label)
Spawns a
GraphTraversal by adding a edge with the specified label. |
GraphTraversal<Edge,Edge> |
addE(Traversal<?,String> edgeLabelTraversal)
Spawns a
GraphTraversal by adding a edge with a label as specified by the provided Traversal . |
GraphTraversal<Vertex,Vertex> |
addV()
Spawns a
GraphTraversal by adding a vertex with the default label. |
GraphTraversal<Vertex,Vertex> |
addV(String label)
Spawns a
GraphTraversal by adding a vertex with the specified label. |
GraphTraversal<Vertex,Vertex> |
addV(Traversal<?,String> vertexLabelTraversal)
Spawns a
GraphTraversal by adding a vertex with the label as determined by a Traversal . |
GraphTraversalSource |
clone()
The clone-method should be used to create immutable traversal sources with each call to a configuration "withXXX"-method.
|
void |
close()
If there is an underlying
RemoteConnection it will be closed by this method. |
GraphTraversal<Edge,Edge> |
E(Object... edgesIds)
Spawns a
GraphTraversal starting with all edges or some subset of edges as specified by their unique
identifier. |
Optional<Class> |
getAnonymousTraversalClass() |
Bytecode |
getBytecode()
Get the
Bytecode associated with the current state of this traversal source. |
Graph |
getGraph()
Get the
Graph associated with this traversal source. |
TraversalStrategies |
getStrategies()
Get the
TraversalStrategies associated with this traversal source. |
<S> GraphTraversal<S,S> |
inject(S... starts)
Spawns a
GraphTraversal starting it with arbitrary values. |
<S> GraphTraversal<S,S> |
io(String file)
Performs a read or write based operation on the
Graph backing this GraphTraversalSource . |
String |
toString() |
Transaction |
tx()
Proxies calls through to the underlying
Graph.tx() . |
GraphTraversal<Vertex,Vertex> |
V(Object... vertexIds)
Spawns a
GraphTraversal starting with all vertices or some subset of vertices as specified by their
unique identifier. |
GraphTraversalSource |
with(String key)
Provides a configuration to a traversal in the form of a key which is the same as
with(key, true) . |
GraphTraversalSource |
with(String key,
Object value)
Provides a configuration to a traversal in the form of a key value pair.
|
GraphTraversalSource |
withBulk(boolean useBulk) |
GraphTraversalSource |
withComputer()
Add the standard
GraphComputer of the graph that will be used to execute the traversal. |
GraphTraversalSource |
withComputer(Class<? extends GraphComputer> graphComputerClass)
Add a
GraphComputer class used to execute the traversal. |
GraphTraversalSource |
withComputer(Computer computer)
Add a
Computer that will generate a GraphComputer from the Graph that will be used to execute the traversal. |
GraphTraversalSource |
withoutStrategies(Class<? extends TraversalStrategy>... traversalStrategyClasses)
Remove an arbitrary collection of
TraversalStrategy classes from the traversal source. |
GraphTraversalSource |
withPath() |
GraphTraversalSource |
withRemote(org.apache.commons.configuration.Configuration conf)
Deprecated.
As of release 3.3.5, replaced by
AnonymousTraversalSource.withRemote(Configuration) . |
GraphTraversalSource |
withRemote(org.apache.tinkerpop.gremlin.process.remote.RemoteConnection connection)
Deprecated.
As of release 3.3.5, replaced by
AnonymousTraversalSource.withRemote(RemoteConnection) . |
GraphTraversalSource |
withRemote(String configFile)
Deprecated.
As of release 3.3.5, replaced by
AnonymousTraversalSource.withRemote(String) . |
<A> GraphTraversalSource |
withSack(A initialValue)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSack(A initialValue,
BinaryOperator<A> mergeOperator)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSack(A initialValue,
UnaryOperator<A> splitOperator)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSack(A initialValue,
UnaryOperator<A> splitOperator,
BinaryOperator<A> mergeOperator)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSack(Supplier<A> initialValue)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSack(Supplier<A> initialValue,
BinaryOperator<A> mergeOperator)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSack(Supplier<A> initialValue,
UnaryOperator<A> splitOperator)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSack(Supplier<A> initialValue,
UnaryOperator<A> splitOperator,
BinaryOperator<A> mergeOperator)
Add a sack to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSideEffect(String key,
A initialValue)
Add a sideEffect to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSideEffect(String key,
A initialValue,
BinaryOperator<A> reducer)
Add a sideEffect to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSideEffect(String key,
Supplier<A> initialValue)
Add a sideEffect to be used throughout the life of a spawned
Traversal . |
<A> GraphTraversalSource |
withSideEffect(String key,
Supplier<A> initialValue,
BinaryOperator<A> reducer)
Add a sideEffect to be used throughout the life of a spawned
Traversal . |
GraphTraversalSource |
withStrategies(TraversalStrategy... traversalStrategies)
Add an arbitrary collection of
TraversalStrategy instances to the traversal source. |
protected transient org.apache.tinkerpop.gremlin.process.remote.RemoteConnection connection
protected final Graph graph
protected TraversalStrategies strategies
protected Bytecode bytecode
public GraphTraversalSource(Graph graph, TraversalStrategies traversalStrategies)
public GraphTraversalSource(Graph graph)
public GraphTraversalSource(org.apache.tinkerpop.gremlin.process.remote.RemoteConnection connection)
public Optional<Class> getAnonymousTraversalClass()
getAnonymousTraversalClass
in interface TraversalSource
public TraversalStrategies getStrategies()
TraversalSource
TraversalStrategies
associated with this traversal source.getStrategies
in interface TraversalSource
public Graph getGraph()
TraversalSource
Graph
associated with this traversal source.getGraph
in interface TraversalSource
public Bytecode getBytecode()
TraversalSource
Bytecode
associated with the current state of this traversal source.getBytecode
in interface TraversalSource
public GraphTraversalSource clone()
TraversalSource
Bytecode
, TraversalStrategies
, mutate the cloned strategies accordingly,
and then return the cloned traversal source leaving the original unaltered.clone
in interface TraversalSource
clone
in class Object
public GraphTraversalSource with(String key)
with(key, true)
. The
key of the configuration must be graph provider specific and therefore a configuration could be supplied that
is not known to be valid until execution.with
in interface TraversalSource
key
- the key of the configuration to apply to a traversalpublic GraphTraversalSource with(String key, Object value)
OptionsStrategy
manually and then add with
TraversalSource.withStrategies(TraversalStrategy[])
.with
in interface TraversalSource
key
- the key of the configuration to apply to a traversalvalue
- the value of the configuration to apply to a traversalpublic GraphTraversalSource withStrategies(TraversalStrategy... traversalStrategies)
TraversalStrategy
instances to the traversal source.withStrategies
in interface TraversalSource
traversalStrategies
- a collection of traversal strategies to addpublic GraphTraversalSource withoutStrategies(Class<? extends TraversalStrategy>... traversalStrategyClasses)
TraversalStrategy
classes from the traversal source.withoutStrategies
in interface TraversalSource
traversalStrategyClasses
- a collection of traversal strategy classes to removepublic GraphTraversalSource withComputer(Computer computer)
Computer
that will generate a GraphComputer
from the Graph
that will be used to execute the traversal.
This adds a VertexProgramStrategy
to the strategies.withComputer
in interface TraversalSource
computer
- a builder to generate a graph computer from the graphpublic GraphTraversalSource withComputer(Class<? extends GraphComputer> graphComputerClass)
GraphComputer
class used to execute the traversal.
This adds a VertexProgramStrategy
to the strategies.withComputer
in interface TraversalSource
graphComputerClass
- the graph computer classpublic GraphTraversalSource withComputer()
GraphComputer
of the graph that will be used to execute the traversal.
This adds a VertexProgramStrategy
to the strategies.withComputer
in interface TraversalSource
public <A> GraphTraversalSource withSideEffect(String key, Supplier<A> initialValue, BinaryOperator<A> reducer)
Traversal
.
This adds a SideEffectStrategy
to the strategies.withSideEffect
in interface TraversalSource
key
- the key of the sideEffectinitialValue
- a supplier that produces the initial value of the sideEffectreducer
- a reducer to merge sideEffect mutations into a single resultpublic <A> GraphTraversalSource withSideEffect(String key, A initialValue, BinaryOperator<A> reducer)
Traversal
.
This adds a SideEffectStrategy
to the strategies.withSideEffect
in interface TraversalSource
key
- the key of the sideEffectinitialValue
- the initial value of the sideEffectreducer
- a reducer to merge sideEffect mutations into a single resultpublic <A> GraphTraversalSource withSideEffect(String key, A initialValue)
Traversal
.
This adds a SideEffectStrategy
to the strategies.withSideEffect
in interface TraversalSource
key
- the key of the sideEffectinitialValue
- the initial value of the sideEffectpublic <A> GraphTraversalSource withSideEffect(String key, Supplier<A> initialValue)
Traversal
.
This adds a SideEffectStrategy
to the strategies.withSideEffect
in interface TraversalSource
key
- the key of the sideEffectinitialValue
- a supplier that produces the initial value of the sideEffectpublic <A> GraphTraversalSource withSack(Supplier<A> initialValue, UnaryOperator<A> splitOperator, BinaryOperator<A> mergeOperator)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- a supplier that produces the initial value of the sideEffectsplitOperator
- the sack split operatormergeOperator
- the sack merge operatorpublic <A> GraphTraversalSource withSack(A initialValue, UnaryOperator<A> splitOperator, BinaryOperator<A> mergeOperator)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- the initial value of the sideEffectsplitOperator
- the sack split operatormergeOperator
- the sack merge operatorpublic <A> GraphTraversalSource withSack(A initialValue)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- the initial value of the sideEffectpublic <A> GraphTraversalSource withSack(Supplier<A> initialValue)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- a supplier that produces the initial value of the sideEffectpublic <A> GraphTraversalSource withSack(Supplier<A> initialValue, UnaryOperator<A> splitOperator)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- a supplier that produces the initial value of the sideEffectsplitOperator
- the sack split operatorpublic <A> GraphTraversalSource withSack(A initialValue, UnaryOperator<A> splitOperator)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- the initial value of the sideEffectsplitOperator
- the sack split operatorpublic <A> GraphTraversalSource withSack(Supplier<A> initialValue, BinaryOperator<A> mergeOperator)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- a supplier that produces the initial value of the sideEffectmergeOperator
- the sack merge operatorpublic <A> GraphTraversalSource withSack(A initialValue, BinaryOperator<A> mergeOperator)
Traversal
.
This adds a SackStrategy
to the strategies.withSack
in interface TraversalSource
initialValue
- the initial value of the sideEffectmergeOperator
- the sack merge operatorpublic GraphTraversalSource withBulk(boolean useBulk)
public GraphTraversalSource withPath()
@Deprecated public GraphTraversalSource withRemote(org.apache.commons.configuration.Configuration conf)
AnonymousTraversalSource.withRemote(Configuration)
.TraversalSource
as a "remote" to issue the Traversal
for execution elsewhere.
Expects key for #GREMLIN_REMOTE_CONNECTION_CLASS
as well as any configuration required by
the underlying RemoteConnection
which will be instantiated. Note that the Configuration
object
is passed down without change to the creation of the RemoteConnection
instance.withRemote
in interface TraversalSource
@Deprecated public GraphTraversalSource withRemote(String configFile) throws Exception
AnonymousTraversalSource.withRemote(String)
.TraversalSource
as a "remote" to issue the Traversal
for execution elsewhere.
Calls TraversalSource.withRemote(Configuration)
after reading the properties file specified.withRemote
in interface TraversalSource
Exception
@Deprecated public GraphTraversalSource withRemote(org.apache.tinkerpop.gremlin.process.remote.RemoteConnection connection)
AnonymousTraversalSource.withRemote(RemoteConnection)
.TraversalSource
as a "remote" to issue the Traversal
for execution elsewhere.
Implementations should track RemoteConnection
instances that are created and call
AutoCloseable.close()
on them when the TraversalSource
itself is closed.withRemote
in interface TraversalSource
connection
- the RemoteConnection
instance to use to submit the Traversal
.public GraphTraversal<Vertex,Vertex> addV(String label)
GraphTraversal
by adding a vertex with the specified label.public GraphTraversal<Vertex,Vertex> addV(Traversal<?,String> vertexLabelTraversal)
GraphTraversal
by adding a vertex with the label as determined by a Traversal
.public GraphTraversal<Vertex,Vertex> addV()
GraphTraversal
by adding a vertex with the default label.public GraphTraversal<Edge,Edge> addE(String label)
GraphTraversal
by adding a edge with the specified label.public GraphTraversal<Edge,Edge> addE(Traversal<?,String> edgeLabelTraversal)
GraphTraversal
by adding a edge with a label as specified by the provided Traversal
.public <S> GraphTraversal<S,S> inject(S... starts)
GraphTraversal
starting it with arbitrary values.public GraphTraversal<Vertex,Vertex> V(Object... vertexIds)
GraphTraversal
starting with all vertices or some subset of vertices as specified by their
unique identifier.public GraphTraversal<Edge,Edge> E(Object... edgesIds)
GraphTraversal
starting with all edges or some subset of edges as specified by their unique
identifier.public <S> GraphTraversal<S,S> io(String file)
Graph
backing this GraphTraversalSource
. This
step can be accompanied by the GraphTraversal.with(String, Object)
modulator for further configuration
and must be accompanied by a GraphTraversal.read()
or GraphTraversal.write()
modulator step
which will terminate the traversal.file
- the name of file for which the read or write will apply - note that the context of how this
parameter is used is wholly dependent on the implementationIoStep
addedpublic Transaction tx()
Graph.tx()
.public void close() throws Exception
RemoteConnection
it will be closed by this method.close
in interface AutoCloseable
close
in interface TraversalSource
Exception
Copyright © 2013–2020 Apache Software Foundation. All rights reserved.