org.apache.tinkerpop.gremlin.process.traversal.step.map

Class TreeStep<S>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.util.ReducingBarrierStep<S,Tree>

org.apache.tinkerpop.gremlin.process.traversal.step.map.TreeStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<Tree>>, Step<S,Tree>, EngineDependent, MapReducer, PathProcessor, TraversalParent

public final class TreeStep<S>
extends ReducingBarrierStep<S,Tree>
implements MapReducer, TraversalParent, PathProcessor

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeStep.TreeMapReduce

Nested classes/interfaces inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.ReducingBarrierStep

ReducingBarrierStep.DefaultMapReduce, ReducingBarrierStep.FinalGet<A>

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PathProcessor

PathProcessor.ElementRequirement

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.ReducingBarrierStep

byPass, REDUCING, reducingBiFunction, seedSupplier

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
TreeStep(Traversal.Admin traversal)

Method Summary

Modifier and Type	Method and Description
void	addLocalChild(Traversal.Admin<?,?> treeTraversal)
TreeStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
List<Traversal.Admin<Object,Object>>	getLocalChildren()
MapReduce<MapReduce.NullObject,Tree,MapReduce.NullObject,Tree,Tree>	getMapReduce()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
int	hashCode()
Traverser<Tree>	processNextStart()
void	reset() Reset the state of the step such that it has no incoming starts.
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.ReducingBarrierStep

onEngine, setBiFunction, setSeedSupplier

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, setId, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent

addGlobalChild, asStep, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PathProcessor

getMaxRequirement

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step

equals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

TreeStep

public TreeStep(Traversal.Admin traversal)

Method Detail

getLocalChildren

public List<Traversal.Admin<Object,Object>> getLocalChildren()

Specified by:

getLocalChildren in interface TraversalParent

addLocalChild

public void addLocalChild(Traversal.Admin<?,?> treeTraversal)

Specified by:

addLocalChild in interface TraversalParent

getRequirements

public 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,Tree>

Returns:

the set of requirements

getMapReduce

public MapReduce<MapReduce.NullObject,Tree,MapReduce.NullObject,Tree,Tree> getMapReduce()

Specified by:

getMapReduce in interface MapReducer

Overrides:

getMapReduce in class ReducingBarrierStep<S,Tree>

clone

public TreeStep<S> clone()

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

Overrides:

clone in class ReducingBarrierStep<S,Tree>

Returns:

The cloned step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,Tree>

processNextStart

public Traverser<Tree> processNextStart()

Overrides:

processNextStart in class ReducingBarrierStep<S,Tree>

toString

public String toString()

Overrides:

toString in class AbstractStep<S,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,Tree>

Overrides:

reset in class ReducingBarrierStep<S,Tree>