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

Class LocalStep<S,E>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public final class LocalStep<S,E>
extends FlatMapStep<S,E>
implements TraversalHolder<S,E>, EngineDependent

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.gremlin.process.graph.marker.TraversalHolder

TraversalHolder.Child

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
LocalStep(Traversal traversal, Traversal<S,E> localTraversal)

Method Summary

Modifier and Type	Method and Description
LocalStep<S,E>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
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.util.List<Traversal<S,E>>	getTraversals()
boolean	isLocalStarGraph()
void	onEngine(TraversalEngine engine)
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.map.FlatMapStep

processNextStart, setFunction

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.TraversalHolder

asStep, executeTraversalOperations, getChildStrategies, getTraversalRequirements, resetTraversals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

LocalStep

public LocalStep(Traversal traversal,
                 Traversal<S,E> localTraversal)

Method Detail

clone

public LocalStep<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

onEngine

public void onEngine(TraversalEngine engine)

Specified by:

onEngine in interface EngineDependent

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,E>

getTraversals

public java.util.List<Traversal<S,E>> getTraversals()

Specified by:

getTraversals in interface TraversalHolder<S,E>

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

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

isLocalStarGraph

public boolean isLocalStarGraph()