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

Class SampleGlobalStep<S>

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, Barrier<TraverserSet<S>>, ByModulating, MemoryComputing<TraverserSet<S>>, Seedable, TraversalParent

public final class SampleGlobalStep<S>
extends CollectingBarrierStep<S>
implements TraversalParent, ByModulating, Seedable

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

traverserSet

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
SampleGlobalStep(Traversal.Admin traversal, int amountToSample)

Method Summary

Modifier and Type	Method	Description
void	barrierConsumer(TraverserSet<S> traverserSet)
SampleGlobalStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
List<Traversal.Admin<S,Number>>	getLocalChildren()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
int	hashCode()
void	modulateBy(Traversal.Admin<?,?> probabilityTraversal)
void	processAllStarts()	Process all left traversers by do not yield the resultant output.
void	replaceLocalChild(Traversal.Admin<?,?> oldTraversal, Traversal.Admin<?,?> newTraversal)
void	resetSeed(long seed)
void	setTraversal(Traversal.Admin<?,?> parentTraversal)	Set the Traversal that this step is contained within.
String	toString()

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

addBarrier, getMemoryComputeKey, hasNextBarrier, nextBarrier, processNextStart, reset

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

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

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

modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

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

equals

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

addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild

Constructor Detail

SampleGlobalStep

public SampleGlobalStep(Traversal.Admin traversal,
                        int amountToSample)

Method Detail

resetSeed

public void resetSeed(long seed)

Specified by:

resetSeed in interface Seedable

getLocalChildren

public List<Traversal.Admin<S,Number>> getLocalChildren()

Specified by:

getLocalChildren in interface TraversalParent

modulateBy

public void modulateBy(Traversal.Admin<?,?> probabilityTraversal)

Specified by:

modulateBy in interface ByModulating

replaceLocalChild

public void replaceLocalChild(Traversal.Admin<?,?> oldTraversal,
                              Traversal.Admin<?,?> newTraversal)

Specified by:

replaceLocalChild in interface TraversalParent

toString

public String toString()

Overrides:

toString in class CollectingBarrierStep<S>

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>

Overrides:

processAllStarts in class CollectingBarrierStep<S>

barrierConsumer

public void barrierConsumer(TraverserSet<S> traverserSet)

Specified by:

barrierConsumer in class CollectingBarrierStep<S>

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>

Overrides:

getRequirements in class CollectingBarrierStep<S>

Returns:

the set of requirements

clone

public SampleGlobalStep<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 CollectingBarrierStep<S>

Returns:

The cloned step

setTraversal

public void setTraversal(Traversal.Admin<?,?> parentTraversal)

Description copied from interface: Step

Set the Traversal that this step is contained within.

Specified by:

setTraversal in interface Step<S,S>

Overrides:

setTraversal in class AbstractStep<S,S>

Parameters:

parentTraversal - the new traversal for this step

hashCode

public int hashCode()

Overrides:

hashCode in class CollectingBarrierStep<S>