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

Class RepeatStep<S>

java.lang.Object

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

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

com.tinkerpop.gremlin.process.graph.step.branch.RepeatStep<S>

All Implemented Interfaces:

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

public final class RepeatStep<S>
extends ComputerAwareStep<S,S>
implements TraversalHolder<S,S>

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepeatStep.LoopPredicate<S>
static class	RepeatStep.TraversalPredicate<S>

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
RepeatStep(Traversal traversal)

Method Summary

Modifier and Type	Method and Description
static <A,B,C extends Traversal<A,B>> C	addEmitToTraversal(C traversal, java.util.function.Predicate<Traverser<B>> emitPredicate)
static <A,B,C extends Traversal<A,B>> C	addRepeatToTraversal(C traversal, Traversal<B,B> repeatTraversal)
static <A,B,C extends Traversal<A,B>> C	addUntilToTraversal(C traversal, java.util.function.Predicate<Traverser<B>> untilPredicate)
RepeatStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
protected java.util.Iterator<Traverser<S>>	computerAlgorithm()
boolean	doEmit(Traverser<S> traverser)
boolean	doUntil(Traverser<S> traverser)
TraversalStrategies	getChildStrategies()
java.util.function.Predicate<Traverser<S>>	getEmitPredicate()
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,S>>	getTraversals()
java.util.function.Predicate<Traverser<S>>	getUntilPredicate()
boolean	isEmitFirst()
boolean	isUntilFirst()
void	setEmitPredicate(java.util.function.Predicate<Traverser<S>> emitPredicate)
void	setRepeatTraversal(Traversal<S,S> repeatTraversal)
void	setUntilPredicate(java.util.function.Predicate<Traverser<S>> untilPredicate)
protected java.util.Iterator<Traverser<S>>	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, reset, 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

RepeatStep

public RepeatStep(Traversal traversal)

Method Detail

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

Returns:

the set of requirements

getChildStrategies

public TraversalStrategies getChildStrategies()

Specified by:

getChildStrategies in interface TraversalHolder<S,S>

setRepeatTraversal

public void setRepeatTraversal(Traversal<S,S> repeatTraversal)

setUntilPredicate

public void setUntilPredicate(java.util.function.Predicate<Traverser<S>> untilPredicate)

setEmitPredicate

public void setEmitPredicate(java.util.function.Predicate<Traverser<S>> emitPredicate)

getTraversals

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

Specified by:

getTraversals in interface TraversalHolder<S,S>

getUntilPredicate

public java.util.function.Predicate<Traverser<S>> getUntilPredicate()

getEmitPredicate

public java.util.function.Predicate<Traverser<S>> getEmitPredicate()

isUntilFirst

public boolean isUntilFirst()

isEmitFirst

public boolean isEmitFirst()

doUntil

public final boolean doUntil(Traverser<S> traverser)

doEmit

public final boolean doEmit(Traverser<S> traverser)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,S>

clone

public RepeatStep<S> 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,S>

Overrides:

clone in class ComputerAwareStep<S,S>

Returns:

The cloned step

Throws:

java.lang.CloneNotSupportedException

standardAlgorithm

protected java.util.Iterator<Traverser<S>> standardAlgorithm()
                                                      throws java.util.NoSuchElementException

Specified by:

standardAlgorithm in class ComputerAwareStep<S,S>

Throws:

java.util.NoSuchElementException

computerAlgorithm

protected java.util.Iterator<Traverser<S>> computerAlgorithm()
                                                      throws java.util.NoSuchElementException

Specified by:

computerAlgorithm in class ComputerAwareStep<S,S>

Throws:

java.util.NoSuchElementException

addRepeatToTraversal

public static <A,B,C extends Traversal<A,B>> C addRepeatToTraversal(C traversal,
                                                                    Traversal<B,B> repeatTraversal)

addUntilToTraversal

public static <A,B,C extends Traversal<A,B>> C addUntilToTraversal(C traversal,
                                                                   java.util.function.Predicate<Traverser<B>> untilPredicate)

addEmitToTraversal

public static <A,B,C extends Traversal<A,B>> C addEmitToTraversal(C traversal,
                                                                  java.util.function.Predicate<Traverser<B>> emitPredicate)