com.tinkerpop.gremlin.process

Interface Traversal.Admin<S,E>

All Superinterfaces:

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

All Known Subinterfaces:

GraphTraversal.Admin<S,E>

All Known Implementing Classes:

DefaultGraphTraversal, DefaultTraversal, EmptyGraphTraversal, EmptyTraversal

Enclosing interface:

Traversal<S,E>

public static interface Traversal.Admin<S,E>
extends Traversal<S,E>

Nested Class Summary

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

Traversal.Admin<S,E>, Traversal.Exceptions

Field Summary

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

OF

Method Summary

Modifier and Type	Method and Description
default void	addStart(Traverser<S> start) Add a single Traverser object to the head of the traversal.
void	addStarts(java.util.Iterator<Traverser<S>> starts) Add an iterator of Traverser objects to the head/start of the traversal.
<S2,E2> Traversal<S2,E2>	addStep(int index, Step<?,?> step)
default <E2> Traversal<S,E2>	addStep(Step<?,E2> step) Add a Step to the end of the traversal.
void	applyStrategies(TraversalEngine engine) Apply the registered TraversalStrategies to the traversal.
TraversalSideEffects	getSideEffects() Get the TraversalSideEffects associated with the traversal.
java.util.List<Step>	getSteps() Get the Step instances associated with this traversal.
TraversalStrategies	getStrategies() Get the TraversalStrategies associated with this traversal.
java.util.Optional<TraversalEngine>	getTraversalEngine() When the TraversalStrategies have been applied, the destined TraversalEngine has been declared.
TraversalHolder<?,?>	getTraversalHolder()
default TraverserGenerator	getTraverserGenerator() Get the TraverserGenerator associated with this traversal.
<S2,E2> Traversal<S2,E2>	removeStep(int index)
default <S2,E2> Traversal<S2,E2>	removeStep(Step<?,?> step)
default void	reset() Call the Step.reset() method on every step in the traversal.
default Traversal<S,E>	reverse() Assume the every Step implements Reversible and call Reversible.reverse() for each.
void	setSideEffects(TraversalSideEffects sideEffects) Set the TraversalSideEffects of this traversal.
void	setStrategies(TraversalStrategies strategies) Set the TraversalStrategies to be used by this traversal at evaluation time.
void	setTraversalHolder(TraversalHolder<?,?> step)

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

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

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

addStarts

void addStarts(java.util.Iterator<Traverser<S>> starts)

Add an iterator of Traverser objects to the head/start of the traversal. Users should typically not need to call this method. For dynamic inject of data, they should use InjectStep.

Parameters:

starts - an iterators of traversers

addStart

default void addStart(Traverser<S> start)

Add a single Traverser object to the head of the traversal. Users should typically not need to call this method. For dynamic inject of data, they should use InjectStep.

Parameters:

start - a traverser to add to the traversal

getSteps

java.util.List<Step> getSteps()

Get the Step instances associated with this traversal. The steps are ordered according to their linked list structure as defined by Step.getPreviousStep() and Step.getNextStep().

Returns:

the ordered steps of the traversal

addStep

default <E2> Traversal<S,E2> addStep(Step<?,E2> step)
                              throws java.lang.IllegalStateException

Add a Step to the end of the traversal. This method should automatically re-link the step accordingly (see TraversalHelper.reLinkSteps(com.tinkerpop.gremlin.process.Traversal.Admin<?, ?>)). If the TraversalStrategies have already been applied, then an IllegalStateException is throw stating the traversal is locked.

Type Parameters:

E2 - the output of the step

Parameters:

step - the step to add

Returns:

the updated traversal

Throws:

java.lang.IllegalStateException

addStep

<S2,E2> Traversal<S2,E2> addStep(int index,
                                 Step<?,?> step)
                          throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

removeStep

default <S2,E2> Traversal<S2,E2> removeStep(Step<?,?> step)
                                     throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

removeStep

<S2,E2> Traversal<S2,E2> removeStep(int index)
                             throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

applyStrategies

void applyStrategies(TraversalEngine engine)

Apply the registered TraversalStrategies to the traversal. Once the strategies are applied, the traversal is "locked" and can no longer have steps added to it. The order of operations for strategy applications should be: globally id steps, apply strategies to root traversal, then to nested traversals.

Parameters:

engine - the engine that will ultimately execute the traversal.

getTraversalEngine

java.util.Optional<TraversalEngine> getTraversalEngine()

When the TraversalStrategies have been applied, the destined TraversalEngine has been declared. Once a traversal engine has been declared, the traversal can no longer be extended, only executed.

Returns:

whether the traversal engine has been defined or not.

getTraverserGenerator

default TraverserGenerator getTraverserGenerator()

Get the TraverserGenerator associated with this traversal. The traversal generator creates Traverser instances that are respective of the traversal definition.

Returns:

the generator of traversers

reset

default void reset()

Call the Step.reset() method on every step in the traversal.

reverse

default Traversal<S,E> reverse()
                        throws java.lang.IllegalStateException

Assume the every Step implements Reversible and call Reversible.reverse() for each.

Returns:

the traversal with its steps reversed

Throws:

java.lang.IllegalStateException

setSideEffects

void setSideEffects(TraversalSideEffects sideEffects)

Set the TraversalSideEffects of this traversal.

Parameters:

sideEffects - the sideEffects to set for this traversal.

getSideEffects

TraversalSideEffects getSideEffects()

Get the TraversalSideEffects associated with the traversal.

Returns:

The traversal sideEffects

setStrategies

void setStrategies(TraversalStrategies strategies)

Set the TraversalStrategies to be used by this traversal at evaluation time.

Parameters:

strategies - the strategies to use on this traversal

getStrategies

TraversalStrategies getStrategies()

Get the TraversalStrategies associated with this traversal.

Returns:

the strategies associated with this traversal

setTraversalHolder

void setTraversalHolder(TraversalHolder<?,?> step)

getTraversalHolder

TraversalHolder<?,?> getTraversalHolder()