public static interface Traversal.Admin<S,E> extends Traversal<S,E>
Traversal.Admin<S,E>, Traversal.Exceptions| Modifier and Type | Method and Description | 
|---|---|
| default void | addStart(Traverser<S> start)Add a single  Traverserobject to the head of the traversal. | 
| default void | addStarts(Iterator<Traverser<S>> starts)Add an iterator of  Traverserobjects to the head/start of the traversal. | 
| <S2,E2> Traversal.Admin<S2,E2> | addStep(int index,
       Step<?,?> step)Add a  Stepto an arbitrary point in the traversal. | 
| default <E2> Traversal.Admin<S,E2> | addStep(Step<?,E2> step)Add a  Stepto the end of the traversal. | 
| void | addTraverserRequirement(TraverserRequirement traverserRequirement)Add a  TraverserRequirementto this traversal and respective nested sub-traversals. | 
| void | applyStrategies()Apply the registered  TraversalStrategiesto 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  TraversalEnginethat will be used to execute this traversal. | 
| Optional<Graph> | getGraph() | 
| TraversalParent | getParent()Get the  TraversalParentStepthat is the parent of this traversal. | 
| TraversalSideEffects | getSideEffects()Get the  TraversalSideEffectsassociated with the traversal. | 
| default Step<S,?> | getStartStep()Get the start/head of the traversal. | 
| List<Step> | getSteps()Get the  Stepinstances associated with this traversal. | 
| TraversalStrategies | getStrategies()Get the  TraversalStrategiesassociated with this traversal. | 
| default TraverserGenerator | getTraverserGenerator()Get the  TraverserGeneratorassociated with this traversal. | 
| default Set<TraverserRequirement> | getTraverserRequirements()Get the set of all  TraverserRequirements for this traversal. | 
| boolean | isLocked()When the traversal has had its  TraversalStrategiesapplied to it, it is locked. | 
| <S2,E2> Traversal.Admin<S2,E2> | removeStep(int index)Remove a  Stepfrom the traversal. | 
| default <S2,E2> Traversal.Admin<S2,E2> | removeStep(Step<?,?> step)Remove a  Stepfrom the traversal. | 
| default void | reset()Call the  Step.reset()method on every step in the traversal. | 
| void | setEngine(TraversalEngine engine)Set the  TraversalEngineto be used for executing this traversal. | 
| void | setGraph(Graph graph) | 
| void | setParent(TraversalParent step)Set the  TraversalParentStepthat is the parent of this traversal. | 
| void | setSideEffects(TraversalSideEffects sideEffects)Set the  TraversalSideEffectsof this traversal. | 
| void | setStrategies(TraversalStrategies strategies)Set the  TraversalStrategiesto be used by this traversal at evaluation time. | 
default void addStarts(Iterator<Traverser<S>> starts)
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.starts - an iterators of traversersdefault void addStart(Traverser<S> start)
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.start - a traverser to add to the traversalList<Step> getSteps()
Step instances associated with this traversal.
 The steps are ordered according to their linked list structure as defined by Step.getPreviousStep() and Step.getNextStep().default <E2> Traversal.Admin<S,E2> addStep(Step<?,E2> step) throws IllegalStateException
Step to the end of the traversal. This method should link the step to its next and previous step accordingly.E2 - the output of the stepstep - the step to addIllegalStateException - if the TraversalStrategies have already been applied<S2,E2> Traversal.Admin<S2,E2> addStep(int index, Step<?,?> step) throws IllegalStateException
Step to an arbitrary point in the traversal.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)index - the location in the traversal to insert the stepstep - the step to addIllegalStateException - if the TraversalStrategies have already been applieddefault <S2,E2> Traversal.Admin<S2,E2> removeStep(Step<?,?> step) throws IllegalStateException
Step from the traversal.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)step - the step to removeIllegalStateException - if the TraversalStrategies have already been applied<S2,E2> Traversal.Admin<S2,E2> removeStep(int index) throws IllegalStateException
Step from the traversal.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)index - the location in the traversal of the step to be evictedIllegalStateException - if the TraversalStrategies have already been applieddefault Step<S,?> getStartStep()
EmptyStep instance is returned.default Step<?,E> getEndStep()
EmptyStep instance is returned.void applyStrategies()
              throws IllegalStateException
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.IllegalStateException - if the TraversalStrategies have already been appliedTraversalEngine getEngine()
TraversalEngine that will be used to execute this traversal.void setEngine(TraversalEngine engine)
TraversalEngine to be used for executing this traversal.engine - the engine to execute the traversal with.default TraverserGenerator getTraverserGenerator()
TraverserGenerator associated with this traversal.
 The traversal generator creates Traverser instances that are respective of the traversal's TraverserRequirement.default Set<TraverserRequirement> getTraverserRequirements()
TraverserRequirements for this traversal.void addTraverserRequirement(TraverserRequirement traverserRequirement)
TraverserRequirement to this traversal and respective nested sub-traversals.
 This is here to allow TraversalStrategy and TraversalSource instances to insert requirements.traverserRequirement - the traverser requirement to adddefault void reset()
Step.reset() method on every step in the traversal.void setSideEffects(TraversalSideEffects sideEffects)
TraversalSideEffects of this traversal.sideEffects - the sideEffects to set for this traversal.TraversalSideEffects getSideEffects()
TraversalSideEffects associated with the traversal.void setStrategies(TraversalStrategies strategies)
TraversalStrategies to be used by this traversal at evaluation time.strategies - the strategies to use on this traversalTraversalStrategies getStrategies()
TraversalStrategies associated with this traversal.void setParent(TraversalParent step)
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.step - the traversal holder parent stepTraversalParent getParent()
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.Traversal.Admin<S,E> clone()
boolean isLocked()
TraversalStrategies applied to it, it is locked.void setGraph(Graph graph)
default boolean equals(Traversal.Admin<S,E> other)
Copyright © 2013–2015 Apache Software Foundation. All rights reserved.