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

Class StoreStep<S>

java.lang.Object

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

com.tinkerpop.gremlin.process.graph.step.sideEffect.SideEffectStep<S>

com.tinkerpop.gremlin.process.graph.step.sideEffect.StoreStep<S>

All Implemented Interfaces:

FunctionHolder<S,java.lang.Object>, MapReducer<MapReduce.NullObject,java.lang.Object,MapReduce.NullObject,java.lang.Object,java.util.Collection>, Reversible, SideEffectCapable, SideEffectRegistrar, Step<S,S>, java.lang.Cloneable, java.util.Iterator<Traverser<S>>

public final class StoreStep<S>
extends SideEffectStep<S>
implements SideEffectCapable, SideEffectRegistrar, Reversible, FunctionHolder<S,java.lang.Object>, MapReducer<MapReduce.NullObject,java.lang.Object,MapReduce.NullObject,java.lang.Object,java.util.Collection>

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

Method Summary

Modifier and Type	Method and Description
void	addFunction(java.util.function.Function<S,java.lang.Object> function)
java.util.List<java.util.function.Function<S,java.lang.Object>>	getFunctions()
MapReduce<MapReduce.NullObject,java.lang.Object,MapReduce.NullObject,java.lang.Object,java.util.Collection>	getMapReduce()
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	registerSideEffects()
java.lang.String	toString()

Methods inherited from class com.tinkerpop.gremlin.process.graph.step.sideEffect.SideEffectStep

processNextStart, setConsumer

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

addStart, addStarts, clone, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, reset, 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

StoreStep

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

Method Detail

registerSideEffects

public void registerSideEffects()

Specified by:

registerSideEffects in interface SideEffectRegistrar

getSideEffectKey

public java.lang.String getSideEffectKey()

Specified by:

getSideEffectKey in interface SideEffectCapable

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,S>

getMapReduce

public MapReduce<MapReduce.NullObject,java.lang.Object,MapReduce.NullObject,java.lang.Object,java.util.Collection> getMapReduce()

Specified by:

getMapReduce in interface MapReducer<MapReduce.NullObject,java.lang.Object,MapReduce.NullObject,java.lang.Object,java.util.Collection>

addFunction

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

Specified by:

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

getFunctions

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

Specified by:

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

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>

Returns:

the set of requirements