com.tinkerpop.gremlin.process.graph.step.map

Class FoldStep<S,E>

java.lang.Object

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

com.tinkerpop.gremlin.process.graph.step.map.MapStep<S,E>

com.tinkerpop.gremlin.process.graph.step.map.FoldStep<S,E>

All Implemented Interfaces:

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

public final class FoldStep<S,E>
extends MapStep<S,E>
implements Reducing<E,S>

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
FoldStep(Traversal traversal)
FoldStep(Traversal traversal, java.util.function.Supplier<E> seed, java.util.function.BiFunction<E,S,E> foldFunction)

Method Summary

Modifier and Type	Method and Description
FoldStep<S,E>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
static <S,E> void	generateFunction(FoldStep<S,E> foldStep)
org.javatuples.Pair<java.util.function.Supplier<E>,java.util.function.BiFunction<E,S,E>>	getReducer()
java.util.Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.

Methods inherited from class com.tinkerpop.gremlin.process.graph.step.map.MapStep

processNextStart, setFunction

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

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

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

FoldStep

public FoldStep(Traversal traversal)

FoldStep

public FoldStep(Traversal traversal,
                java.util.function.Supplier<E> seed,
                java.util.function.BiFunction<E,S,E> foldFunction)

Method Detail

getReducer

public org.javatuples.Pair<java.util.function.Supplier<E>,java.util.function.BiFunction<E,S,E>> getReducer()

Specified by:

getReducer in interface Reducing<E,S>

clone

public FoldStep<S,E> clone()
                    throws java.lang.CloneNotSupportedException

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 reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<S,E>

Overrides:

clone in class AbstractStep<S,E>

Returns:

The cloned step

Throws:

java.lang.CloneNotSupportedException

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>

Overrides:

getRequirements in class MapStep<S,E>

Returns:

the set of requirements

generateFunction

public static <S,E> void generateFunction(FoldStep<S,E> foldStep)