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

Class PathStep<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<S,Path>

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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<Path>>, Step<S,Path>, TraversalParent

public final class PathStep<S>
extends MapStep<S,Path>
implements TraversalParent

Author:

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

See Also:

Serialized Form

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
PathStep(Traversal.Admin traversal)

Method Summary

Modifier and Type	Method and Description
void	addLocalChild(Traversal.Admin<?,?> pathTraversal)
PathStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
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.
protected Path	map(Traverser.Admin<S> traverser)
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.map.MapStep

processNextStart

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.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 org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent

addGlobalChild, asStep, getGlobalChildren, getSelfAndChildRequirements, integrateChild

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

PathStep

public PathStep(Traversal.Admin traversal)

Method Detail

map

protected Path map(Traverser.Admin<S> traverser)

Specified by:

map in class MapStep<S,Path>

clone

public PathStep<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,Path>

Overrides:

clone in class AbstractStep<S,Path>

Returns:

The cloned step

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

Overrides:

reset in class AbstractStep<S,Path>

getLocalChildren

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

Specified by:

getLocalChildren in interface TraversalParent

addLocalChild

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

Specified by:

addLocalChild in interface TraversalParent

toString

public String toString()

Overrides:

toString in class AbstractStep<S,Path>

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

Overrides:

getRequirements in class MapStep<S,Path>

Returns:

the set of requirements