com.tinkerpop.gremlin.process.graph.step.filter

Class SampleStep<S>

java.lang.Object

com.tinkerpop.gremlin.process.util.AbstractStep<S,S>

com.tinkerpop.gremlin.process.graph.step.util.BarrierStep<S>

com.tinkerpop.gremlin.process.graph.step.filter.SampleStep<S>

All Implemented Interfaces:

Barrier, FunctionHolder<S,java.lang.Number>, Reversible, Step<S,S>, java.lang.Cloneable, java.util.Iterator<Traverser<S>>

public final class SampleStep<S>
extends BarrierStep<S>
implements Reversible, FunctionHolder<S,java.lang.Number>

Author:

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

Field Summary

Fields inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

id, label, nextEnd, nextStep, previousStep, PROFILING_ENABLED, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
SampleStep(Traversal traversal, int amountToSample)

Method Summary

Modifier and Type	Method and Description
void	addFunction(java.util.function.Function<S,java.lang.Number> function)
java.util.List<java.util.function.Function<S,java.lang.Number>>	getFunctions()
java.util.Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
java.lang.String	toString()

Methods inherited from class com.tinkerpop.gremlin.process.graph.step.util.BarrierStep

clone, processNextStart, reset, setConsumer

Methods inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

addStart, addStarts, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, setId, setLabel, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tinkerpop.gremlin.process.graph.marker.Reversible

reverse

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

SampleStep

public SampleStep(Traversal traversal,
                  int amountToSample)

Method Detail

addFunction

public void addFunction(java.util.function.Function<S,java.lang.Number> function)

Specified by:

addFunction in interface FunctionHolder<S,java.lang.Number>

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,S>

getFunctions

public java.util.List<java.util.function.Function<S,java.lang.Number>> getFunctions()

Specified by:

getFunctions in interface FunctionHolder<S,java.lang.Number>

getRequirements

public java.util.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 BarrierStep<S>

Returns:

the set of requirements