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

Class TreeStep<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.TreeStep<S>

All Implemented Interfaces:

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

public final class TreeStep<S>
extends SideEffectStep<S>
implements SideEffectRegistrar, Reversible, SideEffectCapable, FunctionHolder<java.lang.Object,java.lang.Object>, MapReducer<java.lang.Object,Tree,java.lang.Object,Tree,Tree>

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

Method Summary

Modifier and Type	Method and Description
void	addFunction(java.util.function.Function<java.lang.Object,java.lang.Object> function)
TreeStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
java.util.List<java.util.function.Function<java.lang.Object,java.lang.Object>>	getFunctions()
MapReduce<java.lang.Object,Tree,java.lang.Object,Tree,Tree>	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()
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.graph.step.sideEffect.SideEffectStep

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

TreeStep

public TreeStep(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

getMapReduce

public MapReduce<java.lang.Object,Tree,java.lang.Object,Tree,Tree> getMapReduce()

Specified by:

getMapReduce in interface MapReducer<java.lang.Object,Tree,java.lang.Object,Tree,Tree>

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

Overrides:

reset in class AbstractStep<S,S>

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,S>

clone

public TreeStep<S> 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,S>

Overrides:

clone in class AbstractStep<S,S>

Returns:

The cloned step

Throws:

java.lang.CloneNotSupportedException

addFunction

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

Specified by:

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

getFunctions

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

Specified by:

getFunctions in interface FunctionHolder<java.lang.Object,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