Traversal.Admin (Apache TinkerPop 3.0.2-incubating API)

All Superinterfaces:

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

All Known Subinterfaces:

GraphTraversal.Admin<S,E>

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 org.apache.tinkerpop.gremlin.process.traversal.Traversal
  Traversal.Admin<S,E>, Traversal.Exceptions

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addStart(Traverser<S> start)` Add a single `Traverser` object to the head of the traversal.
`default void`	`addStarts(Iterator<Traverser<S>> starts)` Add an iterator of `Traverser` objects to the head/start of the traversal.
`<S2,E2> Traversal.Admin<S2,E2>`	`addStep(int index, Step<?,?> step)` Add a `Step` to an arbitrary point in the traversal.
`default <E2> Traversal.Admin<S,E2>`	`addStep(Step<?,E2> step)` Add a `Step` to the end of the traversal.
`void`	`applyStrategies()` Apply the registered `TraversalStrategies` to the traversal.
`Traversal.Admin<S,E>`	`clone()` Cloning is used to duplicate the traversal typically in OLAP environments.
`default boolean`	`equals(Traversal.Admin<S,E> other)`
`default Step<?,E>`	`getEndStep()` Get the end/tail of the traversal.
`TraversalEngine`	`getEngine()` Get the `TraversalEngine` that will be used to execute this traversal.
`Optional<Graph>`	`getGraph()`
`org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent`	`getParent()` Get the `TraversalParent` `Step` that is the parent of this traversal.
`TraversalSideEffects`	`getSideEffects()` Get the `TraversalSideEffects` associated with the traversal.
`default Step<S,?>`	`getStartStep()` Get the start/head of the traversal.
`List<Step>`	`getSteps()` Get the `Step` instances associated with this traversal.
`TraversalStrategies`	`getStrategies()` Get the `TraversalStrategies` associated with this traversal.
`default TraverserGenerator`	`getTraverserGenerator()` Get the `TraverserGenerator` associated with this traversal.
`default Set<org.apache.tinkerpop.gremlin.process.traversal.traverser.TraverserRequirement>`	`getTraverserRequirements()` Get the set of all `TraverserRequirement`s for this traversal.
`boolean`	`isLocked()` When the traversal has had its `TraversalStrategies` applied to it, it is locked.
`<S2,E2> Traversal.Admin<S2,E2>`	`removeStep(int index)` Remove a `Step` from the traversal.
`default <S2,E2> Traversal.Admin<S2,E2>`	`removeStep(Step<?,?> step)` Remove a `Step` from the traversal.
`default void`	`reset()` Call the `Step.reset()` method on every step in the traversal.
`void`	`setEngine(TraversalEngine engine)` Set the `TraversalEngine` to be used for executing this traversal.
`void`	`setGraph(Graph graph)`
`void`	`setParent(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent step)` Set the `TraversalParent` `Step` that is the parent of this traversal.
`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.

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal
asAdmin, fill, forEachRemaining, forEachRemaining, iterate, next, toBulkSet, toList, toSet, toStream, tryNext

Methods inherited from interface java.util.Iterator
hasNext, next, remove

- Method Detail
  - addStarts
```
default void addStarts(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
```
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.Admin<S,E2> addStep(Step<?,E2> step)
                                    throws IllegalStateException
```
    Add a Step to the end of the traversal. This method should link the step to its next and previous step accordingly.
    
    Type Parameters:
    
    E2 - the output of the step
    
    Parameters:
    
    step - the step to add
    
    Returns:
    
    the updated traversal
    
    Throws:
    
    IllegalStateException - if the TraversalStrategies have already been applied
  - addStep
```
<S2,E2> Traversal.Admin<S2,E2> addStep(int index,
                                       Step<?,?> step)
                                throws IllegalStateException
```
    Add a Step to an arbitrary point in the traversal.
    
    Type Parameters:
    
    S2 - the new start type of the traversal (if the added step was a start step)
    
    E2 - the new end type of the traversal (if the added step was an end step)
    
    Parameters:
    
    index - the location in the traversal to insert the step
    
    step - the step to add
    
    Returns:
    
    the newly modulated traversal
    
    Throws:
    
    IllegalStateException - if the TraversalStrategies have already been applied
  - removeStep
```
default <S2,E2> Traversal.Admin<S2,E2> removeStep(Step<?,?> step)
                                           throws IllegalStateException
```
    Remove a Step from the traversal.
    
    Type Parameters:
    
    S2 - the new start type of the traversal (if the removed step was a start step)
    
    E2 - the new end type of the traversal (if the removed step was an end step)
    
    Parameters:
    
    step - the step to remove
    
    Returns:
    
    the newly modulated traversal
    
    Throws:
    
    IllegalStateException - if the TraversalStrategies have already been applied
  - removeStep
```
<S2,E2> Traversal.Admin<S2,E2> removeStep(int index)
                                   throws IllegalStateException
```
    Remove a Step from the traversal.
    
    Type Parameters:
    
    S2 - the new start type of the traversal (if the removed step was a start step)
    
    E2 - the new end type of the traversal (if the removed step was an end step)
    
    Parameters:
    
    index - the location in the traversal of the step to be evicted
    
    Returns:
    
    the newly modulated traversal
    
    Throws:
    
    IllegalStateException - if the TraversalStrategies have already been applied
  - getStartStep
```
default Step<S,?> getStartStep()
```
    Get the start/head of the traversal. If the traversal is empty, then an EmptyStep instance is returned.
    
    Returns:
    
    the start step of the traversal
  - getEndStep
```
default Step<?,E> getEndStep()
```
    Get the end/tail of the traversal. If the traversal is empty, then an EmptyStep instance is returned.
    
    Returns:
    
    the end step of the traversal
  - applyStrategies
```
void applyStrategies()
              throws IllegalStateException
```
    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.
    
    Throws:
    
    IllegalStateException - if the TraversalStrategies have already been applied
  - getEngine
```
TraversalEngine getEngine()
```
    Get the TraversalEngine that will be used to execute this traversal.
    
    Returns:
    
    get the traversal engine associated with this traversal.
  - setEngine
```
void setEngine(TraversalEngine engine)
```
    Set the TraversalEngine to be used for executing this traversal.
    
    Parameters:
    
    engine - the engine to execute the traversal with.
  - getTraverserGenerator
```
default TraverserGenerator getTraverserGenerator()
```
    Get the TraverserGenerator associated with this traversal. The traversal generator creates Traverser instances that are respective of the traversal's TraverserRequirement.
    
    Returns:
    
    the generator of traversers
  - getTraverserRequirements
```
default Set<org.apache.tinkerpop.gremlin.process.traversal.traverser.TraverserRequirement> getTraverserRequirements()
```
    Get the set of all TraverserRequirements for this traversal.
    
    Returns:
    
    the features of a traverser that are required to execute properly in this traversal
  - reset
```
default void reset()
```
    Call the Step.reset() method on every step in the traversal.
  - 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
  - setParent
```
void setParent(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent step)
```
    Set the TraversalParent Step that is the parent of this traversal. Traversals can be nested and this is the means by which the traversal tree is connected.
    
    Parameters:
    
    step - the traversal holder parent step
  - getParent
```
org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent getParent()
```
    Get the TraversalParent Step that is the parent of this traversal. Traversals can be nested and this is the means by which the traversal tree is walked.
    
    Returns:
    
    the traversal holder parent step
  - clone
```
Traversal.Admin<S,E> clone()
```
    Cloning is used to duplicate the traversal typically in OLAP environments.
    
    Returns:
    
    The cloned traversal
  - isLocked
```
boolean isLocked()
```
    When the traversal has had its TraversalStrategies applied to it, it is locked.
    
    Returns:
    
    whether the traversal is locked
  - getGraph
```
Optional<Graph> getGraph()
```
  - setGraph
```
void setGraph(Graph graph)
```
  - equals
```
default boolean equals(Traversal.Admin<S,E> other)
```

Interface Traversal.Admin<S,E>

Nested Class Summary

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

Method Summary

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

Methods inherited from interface java.util.Iterator

Method Detail

addStarts

addStart

getSteps

addStep

addStep

removeStep

removeStep

getStartStep

getEndStep

applyStrategies

getEngine

setEngine

getTraverserGenerator

getTraverserRequirements

reset

setSideEffects

getSideEffects

setStrategies

getStrategies

setParent

getParent

clone

isLocked

getGraph

setGraph

equals