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

Class TreeSideEffectStep<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.TreeSideEffectStep<S>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, ByModulating, Generating<Tree,Tree>, PathProcessor, SideEffectCapable<Tree,Tree>, TraversalParent

public final class TreeSideEffectStep<S>
extends SideEffectStep<S>
implements SideEffectCapable<Tree,Tree>, TraversalParent, ByModulating, PathProcessor

Author:

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

See Also:

Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
TreeSideEffectStep(Traversal.Admin traversal, String sideEffectKey)

Method Summary

Modifier and Type	Method and Description
TreeSideEffectStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
Set<String>	getKeepLabels()
List<Traversal.Admin<Object,Object>>	getLocalChildren()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	getSideEffectKey() The side-effect key of the step.
int	hashCode()
void	modulateBy(Traversal.Admin<?,?> treeTraversal)
protected Traverser.Admin<S>	processNextStart()
void	reset() Reset the state of the step such that it has no incoming starts.
void	setKeepLabels(Set<String> keepLabels)
void	setTraversal(Traversal.Admin<?,?> parentTraversal) Set the Traversal that this step is contained within.
protected void	sideEffect(Traverser.Admin<S> traverser)
String	toString()

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

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

generateFinalResult

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

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

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

modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy

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

getMaxRequirement, processTraverserPathLabels

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

equals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

TreeSideEffectStep

public TreeSideEffectStep(Traversal.Admin traversal,
                          String sideEffectKey)

Method Detail

sideEffect

protected void sideEffect(Traverser.Admin<S> traverser)

Specified by:

sideEffect in class SideEffectStep<S>

processNextStart

protected Traverser.Admin<S> processNextStart()

Overrides:

processNextStart in class SideEffectStep<S>

getSideEffectKey

public String getSideEffectKey()

Description copied from interface: SideEffectCapable

The side-effect key of the step.

Specified by:

getSideEffectKey in interface SideEffectCapable<Tree,Tree>

Returns:

the side-effect key

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 String toString()

Overrides:

toString in class AbstractStep<S,S>

clone

public TreeSideEffectStep<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 Step.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

setTraversal

public void setTraversal(Traversal.Admin<?,?> parentTraversal)

Description copied from interface: Step

Set the Traversal that this step is contained within.

Specified by:

setTraversal in interface Step<S,S>

Overrides:

setTraversal in class AbstractStep<S,S>

Parameters:

parentTraversal - the new traversal for this step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

getLocalChildren

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

Specified by:

getLocalChildren in interface TraversalParent

modulateBy

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

Specified by:

modulateBy in interface ByModulating

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

Returns:

the set of requirements

setKeepLabels

public void setKeepLabels(Set<String> keepLabels)

Specified by:

setKeepLabels in interface PathProcessor

getKeepLabels

public Set<String> getKeepLabels()

Specified by:

getKeepLabels in interface PathProcessor