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

Interface RangeGlobalStepContract<S>

All Superinterfaces:

Barrier<TraverserSet<S>>, Bypassing, Cloneable, FilteringBarrier<TraverserSet<S>>, Iterator<Traverser.Admin<S>>, MemoryComputing<TraverserSet<S>>, Ranging, Serializable, Step<S,S>

All Known Implementing Classes:

RangeGlobalStep, RangeGlobalStepPlaceholder

public interface RangeGlobalStepContract<S>
extends Step<S,S>, FilteringBarrier<TraverserSet<S>>, Ranging, Bypassing

Defines the contract for range related steps.

Field Summary

Fields

Modifier and Type	Field	Description
static List<Class<? extends Step>>	CONCRETE_STEPS	Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Summary

Modifier and Type	Method	Description
default void	addBarrier(TraverserSet<S> barrier)	Add a barrier to the step.
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.
Long	getHighRange()	Retrieves the higher bound of the range.
default GValue<Long>	getHighRangeAsGValue()	getHighRange, retaining the GValue container and without pinning the variable.
Long	getLowRange()	Retrieves the lower bound of the range.
default GValue<Long>	getLowRangeAsGValue()	getLowRange, retaining the GValue container and without pinning the variable.
default MemoryComputeKey<TraverserSet<S>>	getMemoryComputeKey()	The MemoryComputeKey that will be used by this step.
ExpandableStepIterator<S>	getStarts()
default boolean	hasNextBarrier()	Whether or not the step has an accessible barrier.
default TraverserSet<S>	nextBarrier()	Get the next barrier within this step.

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

done, processAllStarts

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

setBypass

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

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

addLabel, addStart, addStarts, clearLabels, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getRequirements, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Field Detail

CONCRETE_STEPS

static final List<Class<? extends Step>> CONCRETE_STEPS

Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Detail

getLowRange

Long getLowRange()

Retrieves the lower bound of the range.

Specified by:

getLowRange in interface Ranging

Returns:

the value representing the lower bound of the range

getHighRange

Long getHighRange()

Retrieves the higher bound of the range.

Specified by:

getHighRange in interface Ranging

Returns:

the higher bound of the range as an object of type V

getLowRangeAsGValue

default GValue<Long> getLowRangeAsGValue()

getLowRange, retaining the GValue container and without pinning the variable. It is the caller's responsibility to ensure that this value is not used to alter the traversal in any way which is not generalizable to any parameter value.

Returns:

the lower bound for range().

getHighRangeAsGValue

default GValue<Long> getHighRangeAsGValue()

getHighRange, retaining the GValue container and without pinning the variable. It is the caller's responsibility to ensure that this value is not used to alter the traversal in any way which is not generalizable to any parameter value.

Returns:

the upper bound for range().

getMemoryComputeKey

default MemoryComputeKey<TraverserSet<S>> 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>

getStarts

ExpandableStepIterator<S> getStarts()

hasNextBarrier

default 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

default 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

default 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