SampleLocalStep (Apache TinkerPop 3.7.3 API)

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.SampleLocalStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, Seedable
```
public final class SampleLocalStep<S>
extends ScalarMapStep<S,S>
implements Seedable
```
Author:

Daniel Kuppitz (http://gremlin.guru), Marko A. Rodriguez (http://markorodriguez.com)

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

Constructor Summary

Constructors
Constructor Description

SampleLocalStep(Traversal.Admin traversal, int amountToSample)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getAmountToSample()`
`Set<TraverserRequirement>`	`getRequirements()`	Provide the necessary `TraverserRequirement` that must be met by the traverser in order for the step to function properly.
`int`	`hashCode()`
`protected S`	`map(Traverser.Admin<S> traverser)`
`void`	`resetSeed(long seed)`

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, clone, equals, 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 java.util.Iterator
forEachRemaining, remove

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

- Constructor Detail
  - SampleLocalStep
```
public SampleLocalStep(Traversal.Admin traversal,
                       int amountToSample)
```
- Method Detail
  - getAmountToSample
```
public int getAmountToSample()
```
  - resetSeed
```
public void resetSeed(long seed)
```
    Specified by:
    
    resetSeed in interface Seedable
  - map
```
protected S map(Traverser.Admin<S> traverser)
```
    Specified by:
    
    map in class ScalarMapStep<S,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>
    
    Returns:
    
    the set of requirements
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractStep<S,S>