Package org.apache.tinkerpop.gremlin.process.traversal.step.branch

Class LocalStep<S,E>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.branch.LocalStep<S,E>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<E>>, Step<S,E>, TraversalParent

public final class LocalStep<S,E>
extends AbstractStep<S,E>
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, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
LocalStep(Traversal.Admin traversal, Traversal.Admin<S,E> localTraversal)

Method Summary

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

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

addLabel, addStart, addStarts, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, setId, setNextStep, setPreviousStep

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

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

equals

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

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

Constructor Detail

LocalStep

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

Method Detail

getLocalChildren

public List<Traversal.Admin<S,E>> getLocalChildren()

Specified by:

getLocalChildren 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,E>

Returns:

the set of requirements

processNextStart

protected Traverser.Admin<E> processNextStart()
                                       throws NoSuchElementException

Specified by:

processNextStart in class AbstractStep<S,E>

Throws:

NoSuchElementException

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

clone

public LocalStep<S,E> 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,E>

Overrides:

clone in class AbstractStep<S,E>

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

Overrides:

setTraversal in class AbstractStep<S,E>

Parameters:

parentTraversal - the new traversal for this step

toString

public String toString()

Overrides:

toString in class AbstractStep<S,E>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,E>