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

Class RangeLocalStepPlaceholder<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<S,E>

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

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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, GValueHolder<S,S>, RangeLocalStepContract<S>, Ranging

public class RangeLocalStepPlaceholder<S>
extends ScalarMapStep<S,S>
implements RangeLocalStepContract<S>, GValueHolder<S,S>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected GValue<Long>	high
protected GValue<Long>	low

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

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.map.RangeLocalStepContract

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
RangeLocalStepPlaceholder(Traversal.Admin traversal, GValue<Long> low, GValue<Long> high)

Method Summary

Modifier and Type	Method	Description
RangeLocalStep<S>	asConcreteStep()
RangeLocalStepPlaceholder<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
boolean	equals(Object o)
Collection<GValue<?>>	getGValues()
Long	getHighRange()	Retrieves the higher bound of the range.
GValue<Long>	getHighRangeAsGValue()	getHighRange, retaining the GValue container and without pinning the variable.
Long	getLowRange()	Retrieves the lower bound of the range.
GValue<Long>	getLowRangeAsGValue()	getLowRange, retaining the GValue container and without pinning the variable.
int	hashCode()
boolean	isParameterized()
protected S	map(Traverser.Admin<S> traverser)
void	updateVariable(String name, Object value)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep

processNextStart

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

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

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

reduce

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, equals, getId, getLabels, getNextStep, getPreviousStep, getRequirements, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Field Detail

low

protected GValue<Long> low

high

protected GValue<Long> high

Constructor Detail

RangeLocalStepPlaceholder

public RangeLocalStepPlaceholder(Traversal.Admin traversal,
                                 GValue<Long> low,
                                 GValue<Long> high)

Method Detail

isParameterized

public boolean isParameterized()

Specified by:

isParameterized in interface GValueHolder<S,S>

updateVariable

public void updateVariable(String name,
                           Object value)

Specified by:

updateVariable in interface GValueHolder<S,S>

getLowRange

public Long getLowRange()

Description copied from interface: RangeLocalStepContract

Retrieves the lower bound of the range.

Specified by:

getLowRange in interface RangeLocalStepContract<S>

Specified by:

getLowRange in interface Ranging

Returns:

the value representing the lower bound of the range

getHighRange

public Long getHighRange()

Description copied from interface: RangeLocalStepContract

Retrieves the higher bound of the range.

Specified by:

getHighRange in interface RangeLocalStepContract<S>

Specified by:

getHighRange in interface Ranging

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractStep<S,S>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

getLowRangeAsGValue

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

Specified by:

getLowRangeAsGValue in interface RangeLocalStepContract<S>

Returns:

the lower bound for range().

getHighRangeAsGValue

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

Specified by:

getHighRangeAsGValue in interface RangeLocalStepContract<S>

Returns:

the upper bound for range().

map

protected S map(Traverser.Admin<S> traverser)

Specified by:

map in class ScalarMapStep<S,S>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S,S>

asConcreteStep

public RangeLocalStep<S> asConcreteStep()

Specified by:

asConcreteStep in interface GValueHolder<S,S>

clone

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