com.tinkerpop.gremlin.process.graph.step.util

Class BarrierStep<S>

java.lang.Object

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

com.tinkerpop.gremlin.process.graph.step.util.BarrierStep<S>

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregateStep, OrderStep, SampleStep, ShuffleStep

public abstract class BarrierStep<S>
extends AbstractStep<S,S>
implements Barrier

Author:

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

Field Summary

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

Method Summary

Modifier and Type	Method and Description
BarrierStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
java.util.Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
Traverser<S>	processNextStart()
void	reset() Reset the state of the step such that it has no incoming starts.
void	setConsumer(java.util.function.Consumer<TraverserSet<S>> barrierConsumer)

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

BarrierStep

public BarrierStep(Traversal traversal)

Method Detail

setConsumer

public void setConsumer(java.util.function.Consumer<TraverserSet<S>> barrierConsumer)

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

processNextStart

public Traverser<S> processNextStart()

Specified by:

processNextStart in class AbstractStep<S,S>

clone

public BarrierStep<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 AbstractStep<S,S>

Returns:

The cloned step

Throws:

java.lang.CloneNotSupportedException

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

Overrides:

reset in class AbstractStep<S,S>