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

Class UnionStep<S,E>

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,Pick>

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

All Implemented Interfaces:

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

public class UnionStep<S,E>
extends BranchStep<S,E,Pick>

Author:

Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Nested Class Summary

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

Modifier and Type	Field	Description
protected boolean	first	Is this the first iteration through the step.

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

branchTraversal, 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
UnionStep(Traversal.Admin traversal, boolean isStart, Traversal.Admin<?,E>... unionTraversals)
UnionStep(Traversal.Admin traversal, Traversal.Admin<?,E>... unionTraversals)

Method Summary

Modifier and Type	Method	Description
void	addChildOption(Pick pickToken, Traversal.Admin<S,E> traversalOption)	The child as defined by the token it takes, like Pick or Merge.
boolean	isStart()
protected Traverser.Admin<E>	processNextStart()
void	reset()	Reset the state of the step such that it has no incoming starts.
String	toString()

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

clone, computerAlgorithm, getGlobalChildren, getLocalChildren, getRequirements, hashCode, setBranchTraversal, setTraversal, standardAlgorithm

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

onGraphComputer

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

Field Detail

first

protected boolean first

Is this the first iteration through the step.

Constructor Detail

UnionStep

public UnionStep(Traversal.Admin traversal,
                 boolean isStart,
                 Traversal.Admin<?,E>... unionTraversals)

UnionStep

public UnionStep(Traversal.Admin traversal,
                 Traversal.Admin<?,E>... unionTraversals)

Method Detail

isStart

public boolean isStart()

processNextStart

protected Traverser.Admin<E> processNextStart()

Overrides:

processNextStart in class ComputerAwareStep<S,E>

addChildOption

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

Description copied from interface: TraversalOptionParent

The child as defined by the token it takes, like Pick or Merge. This traversal may be of local or global scope depending on the step implementation that works with option().

Specified by:

addChildOption in interface TraversalOptionParent<Pick,S,E>

Overrides:

addChildOption in class BranchStep<S,E,Pick>

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 BranchStep<S,E,Pick>

toString

public String toString()

Overrides:

toString in class BranchStep<S,E,Pick>