Package org.apache.tinkerpop.gremlin.process.traversal.step.branch

Class ChooseStep<S,E,M>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.util.ComputerAwareStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.branch.BranchStep<S,E,M>

org.apache.tinkerpop.gremlin.process.traversal.step.branch.ChooseStep<S,E,M>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<E>>, Step<S,E>, GraphComputing, PopContaining, TraversalOptionParent<M,S,E>, TraversalParent

public final class ChooseStep<S,E,M>
extends BranchStep<S,E,M>

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)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChooseStep.ChooseSemantics	Defines the manner in which the ChooseStep is configured to work.

Nested classes/interfaces inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.ComputerAwareStep

ComputerAwareStep.EndStep<S>

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

PopContaining.PopInstruction

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.branch.BranchStep

branchTraversal, hasBarrier, traversalOptions, traversalPickOptions

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
ChooseStep(Traversal.Admin traversal, Traversal.Admin<S,?> predicateTraversal, Traversal.Admin<S,E> trueChoice, Traversal.Admin<S,E> falseChoice)
ChooseStep(Traversal.Admin traversal, Traversal.Admin<S,M> choiceTraversal)

Method Summary

Modifier and Type	Method	Description
void	addChildOption(M pickToken, Traversal.Admin<S,E> traversalOption)	Adds a child option to this ChooseStep.This method overrides the parent implementation to provide special handling for Pick tokens.
ChooseStep.ChooseSemantics	getChooseSemantics()	Step metadata that informs on how choose() is configured to work.
protected List<Traversal.Admin<S,E>>	pickBranches(M choice)	Selects which branches to execute based on the choice value.

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.branch.BranchStep

applyCurrentTraverser, clone, computerAlgorithm, getBranchTraversal, getGlobalChildren, getLocalChildren, getRequirements, getTraversalOptions, getTraversalPickOptions, hashCode, reset, setBranchTraversal, setTraversal, standardAlgorithm, toString

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.ComputerAwareStep

onGraphComputer, processNextStart

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addLabel, addStart, addStarts, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, setId, setNextStep, setPreviousStep

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.GraphComputing

atMaster

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

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

equals

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent

addGlobalChild, addLocalChild, asStep, close, getPopInstructions, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild

Constructor Details

ChooseStep

public ChooseStep(Traversal.Admin traversal,
 Traversal.Admin<S,M> choiceTraversal)

ChooseStep

public ChooseStep(Traversal.Admin traversal,
 Traversal.Admin<S,?> predicateTraversal,
 Traversal.Admin<S,E> trueChoice,
 Traversal.Admin<S,E> falseChoice)

Method Details

getChooseSemantics

public ChooseStep.ChooseSemantics getChooseSemantics()

Step metadata that informs on how choose() is configured to work.

addChildOption

public void addChildOption(M pickToken,
 Traversal.Admin<S,E> traversalOption)

Adds a child option to this ChooseStep.This method overrides the parent implementation to provide special handling for Pick tokens.

Specified by:

addChildOption in interface TraversalOptionParent<S,E,M>

Overrides:

addChildOption in class BranchStep<S,E,M>

pickBranches

protected List<Traversal.Admin<S,E>> pickBranches(M choice)

Selects which branches to execute based on the choice value.

Overrides:

pickBranches in class BranchStep<S,E,M>