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

Class NoOpBarrierStep<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.NoOpBarrierStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, Barrier<TraverserSet<S>>, LocalBarrier<S>, MemoryComputing<TraverserSet<S>>

public final class NoOpBarrierStep<S>
extends AbstractStep<S,S>
implements LocalBarrier<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, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
NoOpBarrierStep(Traversal.Admin traversal)
NoOpBarrierStep(Traversal.Admin traversal, int maxBarrierSize)

Method Summary

Modifier and Type	Method	Description
void	addBarrier(TraverserSet<S> barrier)	Add a barrier to the step.
NoOpBarrierStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
int	getMaxBarrierSize()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
int	hashCode()
boolean	hasNextBarrier()	Whether or not the step has an accessible barrier.
TraverserSet<S>	nextBarrier()	Get the next barrier within this step.
void	processAllStarts()	Process all left traversers by do not yield the resultant output.
protected Traverser.Admin<S>	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.util.AbstractStep

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

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

done

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

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

getMemoryComputeKey

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

equals

Constructor Detail

NoOpBarrierStep

public NoOpBarrierStep(Traversal.Admin traversal)

NoOpBarrierStep

public NoOpBarrierStep(Traversal.Admin traversal,
                       int maxBarrierSize)

Method Detail

processNextStart

protected Traverser.Admin<S> processNextStart()
                                       throws NoSuchElementException

Specified by:

processNextStart in class AbstractStep<S,S>

Throws:

NoSuchElementException

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.

Specified by:

getRequirements in interface Step<S,S>

Returns:

the set of requirements

processAllStarts

public void processAllStarts()

Description copied from interface: Barrier

Process all left traversers by do not yield the resultant output. This method is useful for steps like ReducingBarrierStep, where traversers can be processed "on the fly" and thus, reduce memory consumption.

Specified by:

processAllStarts in interface Barrier<S>

hasNextBarrier

public boolean hasNextBarrier()

Description copied from interface: Barrier

Whether or not the step has an accessible barrier.

Specified by:

hasNextBarrier in interface Barrier<S>

Returns:

whether a barrier exists or not

nextBarrier

public TraverserSet<S> nextBarrier()
                            throws NoSuchElementException

Description copied from interface: Barrier

Get the next barrier within this step. Barriers from parallel steps can be the be merged to create a single step with merge barriers.

Specified by:

nextBarrier in interface Barrier<S>

Returns:

the next barrier of the step

Throws:

NoSuchElementException

addBarrier

public void addBarrier(TraverserSet<S> barrier)

Description copied from interface: Barrier

Add a barrier to the step. This typically happens when multiple parallel barriers need to become one barrier at a single step.

Specified by:

addBarrier in interface Barrier<S>

Parameters:

barrier - the barrier to merge in

clone

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

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

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>

getMaxBarrierSize

public int getMaxBarrierSize()