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

Class TailGlobalStepPlaceholder<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.filter.TailGlobalStepPlaceholder<S>

All Implemented Interfaces:

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

public final class TailGlobalStepPlaceholder<S>
extends AbstractStep<S,S>
implements TailGlobalStepContract<S>, GValueHolder<S,S>

Author:

Matt Frantz (http://github.com/mhfrantz)

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

Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.filter.TailGlobalStepContract

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
TailGlobalStepPlaceholder(Traversal.Admin traversal, GValue<Long> limit)

Method Summary

Modifier and Type	Method	Description
Step<S,S>	asConcreteStep()
TailGlobalStepPlaceholder<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	getLimit()
GValue<Long>	getLimitAsGValue()
MemoryComputeKey<TraverserSet<S>>	getMemoryComputeKey()	The MemoryComputeKey that will be used by this step.
int	hashCode()
boolean	isParameterized()
void	processAllStarts()	Process all left traversers by do not yield the resultant output.
Traverser.Admin<S>	processNextStart()
void	setBypass(boolean bypass)
void	updateVariable(String name, Object value)

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

done

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

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

addBarrier, getEmptyBarrier, getStarts, hasNextBarrier, nextBarrier

Constructor Detail

TailGlobalStepPlaceholder

public TailGlobalStepPlaceholder(Traversal.Admin traversal,
                                 GValue<Long> limit)

Method Detail

processNextStart

public Traverser.Admin<S> processNextStart()

Specified by:

processNextStart in class AbstractStep<S,S>

setBypass

public void setBypass(boolean bypass)

Specified by:

setBypass in interface Bypassing

clone

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

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractStep<S,S>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

getLimit

public Long getLimit()

Specified by:

getLimit in interface TailGlobalStepContract<S>

getLimitAsGValue

public GValue<Long> getLimitAsGValue()

Specified by:

getLimitAsGValue in interface TailGlobalStepContract<S>

getMemoryComputeKey

public 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

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>

asConcreteStep

public Step<S,S> asConcreteStep()

Specified by:

asConcreteStep in interface GValueHolder<S,S>

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>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S,S>