com.tinkerpop.gremlin.process.graph.step.sideEffect

Class SideEffectCapStep<S,E>

java.lang.Object

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

com.tinkerpop.gremlin.process.graph.step.sideEffect.SideEffectCapStep<S,E>

All Implemented Interfaces:

EngineDependent, SideEffectRegistrar, Step<S,E>, java.lang.Cloneable, java.util.Iterator<Traverser<E>>

public final class SideEffectCapStep<S,E>
extends AbstractStep<S,E>
implements EngineDependent, SideEffectRegistrar

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
SideEffectCapStep(Traversal traversal, java.lang.String sideEffectKey)

Method Summary

Modifier and Type	Method and Description
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	getSideEffectKey()
void	onEngine(TraversalEngine traversalEngine)
Traverser<E>	processNextStart()
void	registerSideEffects()
void	reset() Reset the state of the step such that it has no incoming starts.
java.lang.String	toString()

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

addStart, addStarts, clone, 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 java.util.Iterator

forEachRemaining, remove

Constructor Detail

SideEffectCapStep

public SideEffectCapStep(Traversal traversal,
                         java.lang.String sideEffectKey)

Method Detail

registerSideEffects

public void registerSideEffects()

Specified by:

registerSideEffects in interface SideEffectRegistrar

processNextStart

public Traverser<E> processNextStart()

Specified by:

processNextStart in class AbstractStep<S,E>

onEngine

public void onEngine(TraversalEngine traversalEngine)

Specified by:

onEngine in interface EngineDependent

reset

public void reset()

Description copied from interface: Step

Reset the state of the step such that it has no incoming starts. Internal states are to be reset, but any sideEffect data structures are not to be recreated.

Specified by:

reset in interface Step<S,E>

Overrides:

reset in class AbstractStep<S,E>

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,E>

getSideEffectKey

public java.lang.String getSideEffectKey()

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,E>

Returns:

the set of requirements