org.apache.tinkerpop.gremlin.process.traversal.step.util

Class CollectingBarrierStep<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.util.CollectingBarrierStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<S>>, Step<S,S>

Direct Known Subclasses:

AggregateStep, NoOpBarrierStep, OrderGlobalStep, SampleGlobalStep

public abstract class CollectingBarrierStep<S>
extends AbstractStep<S,S>

Author:

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

See Also:

Serialized Form

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
CollectingBarrierStep(Traversal.Admin traversal)

Method Summary

Modifier and Type	Method and Description
abstract void	barrierConsumer(TraverserSet<S> traverserSet)
CollectingBarrierStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
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.

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.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

CollectingBarrierStep

public CollectingBarrierStep(Traversal.Admin traversal)

Method Detail

barrierConsumer

public abstract void barrierConsumer(TraverserSet<S> traverserSet)

getRequirements

public 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.

Returns:

the set of requirements

processNextStart

public Traverser<S> processNextStart()

Specified by:

processNextStart in class AbstractStep<S,S>

clone

public CollectingBarrierStep<S> clone()

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

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>