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

Interface LocalBarrier<S>

All Superinterfaces:

Barrier<TraverserSet<S>>, MemoryComputing<TraverserSet<S>>

All Known Implementing Classes:

AggregateStep, GroupCountSideEffectStep, GroupSideEffectStep, NoOpBarrierStep, SideEffectBarrierStep, SubgraphStep, TreeSideEffectStep

public interface LocalBarrier<S>
extends Barrier<TraverserSet<S>>

Author:

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

Method Summary

Modifier and Type	Method	Description
default TraverserSet<S>	getEmptyBarrier()	If a barrier is unproductive then provide an empty object suitable to the implementation which can be used to represent that state.
default MemoryComputeKey	getMemoryComputeKey()	The MemoryComputeKey that will be used by this step.

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

addBarrier, done, hasNextBarrier, nextBarrier, processAllStarts

Method Details

getMemoryComputeKey

default MemoryComputeKey getMemoryComputeKey()

Description copied from interface: MemoryComputing

The MemoryComputeKey that will be used by this step.

Specified by:

getMemoryComputeKey in interface MemoryComputing<S>

Returns:

the MemoryComputeKey to use

getEmptyBarrier

default TraverserSet<S> getEmptyBarrier()

Description copied from interface: Barrier

If a barrier is unproductive then provide an empty object suitable to the implementation which can be used to represent that state. This is important for cases like by(out().order().fold()) where the order() might filter but the fold() means the traversal is productive.

Specified by:

getEmptyBarrier in interface Barrier<S>