com.tinkerpop.gremlin.process.graph.step.branch

Class ChooseStep<S,E,M>

java.lang.Object

com.tinkerpop.gremlin.process.util.AbstractStep<S,E>

com.tinkerpop.gremlin.process.graph.step.util.ComputerAwareStep<S,E>

com.tinkerpop.gremlin.process.graph.step.branch.ChooseStep<S,E,M>

All Implemented Interfaces:

EngineDependent, TraversalHolder<S,E>, Step<S,E>, java.lang.Cloneable, java.util.Iterator<Traverser<E>>

public final class ChooseStep<S,E,M>
extends ComputerAwareStep<S,E>
implements TraversalHolder<S,E>

A step which offers a choice of two or more Traversals to take.

Author:

Joshua Shinavier (http://fortytwo.net), Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.gremlin.process.graph.marker.TraversalHolder

TraversalHolder.Child

Field Summary

Fields inherited from class com.tinkerpop.gremlin.process.graph.step.util.ComputerAwareStep

onGraphComputer

Fields inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

id, label, nextEnd, nextStep, previousStep, PROFILING_ENABLED, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
ChooseStep(Traversal traversal, java.util.function.Function<S,M> mapFunction, java.util.Map<M,Traversal<S,E>> choices)
ChooseStep(Traversal traversal, java.util.function.Predicate<S> predicate, Traversal<S,E> trueChoice, Traversal<S,E> falseChoice)

Method Summary

Modifier and Type	Method and Description
ChooseStep<S,E,M>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
protected java.util.Iterator<Traverser<E>>	computerAlgorithm()
TraversalStrategies	getChildStrategies()
java.util.Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
java.util.List<Traversal<S,E>>	getTraversals()
void	reset() Reset the state of the step such that it has no incoming starts.
protected java.util.Iterator<Traverser<E>>	standardAlgorithm()
java.lang.String	toString()

Methods inherited from class com.tinkerpop.gremlin.process.graph.step.util.ComputerAwareStep

onEngine, processNextStart

Methods inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

addStart, addStarts, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, setId, setLabel, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tinkerpop.gremlin.process.graph.marker.TraversalHolder

asStep, executeTraversalOperations, getTraversalRequirements, resetTraversals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

ChooseStep

public ChooseStep(Traversal traversal,
                  java.util.function.Predicate<S> predicate,
                  Traversal<S,E> trueChoice,
                  Traversal<S,E> falseChoice)

ChooseStep

public ChooseStep(Traversal traversal,
                  java.util.function.Function<S,M> mapFunction,
                  java.util.Map<M,Traversal<S,E>> choices)

Method Detail

getChildStrategies

public TraversalStrategies getChildStrategies()

Specified by:

getChildStrategies in interface TraversalHolder<S,E>

getRequirements

public java.util.Set<TraverserRequirement> getRequirements()

Description copied from interface: Step

Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.

Specified by:

getRequirements in interface Step<S,E>

Returns:

the set of requirements

getTraversals

public java.util.List<Traversal<S,E>> getTraversals()

Specified by:

getTraversals in interface TraversalHolder<S,E>

standardAlgorithm

protected java.util.Iterator<Traverser<E>> standardAlgorithm()

Specified by:

standardAlgorithm in class ComputerAwareStep<S,E>

computerAlgorithm

protected java.util.Iterator<Traverser<E>> computerAlgorithm()

Specified by:

computerAlgorithm in class ComputerAwareStep<S,E>

clone

public ChooseStep<S,E,M> clone()
                        throws java.lang.CloneNotSupportedException

Description copied from interface: Step

Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication. When cloning a step, it is important that the steps, the cloned step is equivalent to the state of the step when reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<S,E>

Overrides:

clone in class ComputerAwareStep<S,E>

Returns:

The cloned step

Throws:

java.lang.CloneNotSupportedException

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,E>

reset

public void reset()

Description copied from interface: Step

Reset the state of the step such that it has no incoming starts. Internal states are to be reset, but any sideEffect data structures are not to be recreated.

Specified by:

reset in interface Step<S,E>

Overrides:

reset in class AbstractStep<S,E>