com.tinkerpop.gremlin.process.util

Class AbstractStep<S,E>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BarrierStep, BranchStep, ComputerAwareStep, ComputerResultStep, CountStep, FilterStep, FlatMapStep, MapStep, MatchStep, RouteStep, SideEffectCapStep, SideEffectStep, SumStep

public abstract class AbstractStep<S,E>
extends java.lang.Object
implements Step<S,E>

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id
protected java.util.Optional<java.lang.String>	label
protected Traverser<E>	nextEnd
protected Step<E,?>	nextStep
protected Step<?,S>	previousStep
protected static boolean	PROFILING_ENABLED
protected ExpandableStepIterator<S>	starts
protected Traversal	traversal
protected boolean	traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
AbstractStep(Traversal traversal)

Method Summary

Modifier and Type	Method and Description
void	addStart(Traverser<S> start) Add a single Traverser to the step.
void	addStarts(java.util.Iterator<Traverser<S>> starts) Add a iterator of Traverser objects of type S to the step.
AbstractStep<S,E>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
java.lang.String	getId() Get the unique id of this step.
java.util.Optional<java.lang.String>	getLabel() Get the label of this step.
Step<E,?>	getNextStep() Get the next step to the current step.
Step<?,S>	getPreviousStep() Get the step prior to the current step.
<A,B> Traversal<A,B>	getTraversal() Get the Traversal that this step is contained within.
boolean	hasNext()
Traverser<E>	next()
protected abstract Traverser<E>	processNextStart()
void	reset() Reset the state of the step such that it has no incoming starts.
void	setId(java.lang.String id) Get the unique id of the step.
void	setLabel(java.lang.String label) Set the label of this step.
void	setNextStep(Step<E,?> step) Set the step that is next to the current step.
void	setPreviousStep(Step<?,S> step) Set the step that is previous to the current step.
void	setTraversal(Traversal<?,?> traversal) Set the Traversal that this step is contained within.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tinkerpop.gremlin.process.Step

getRequirements

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

label

protected java.util.Optional<java.lang.String> label

id

protected java.lang.String id

traversal

protected Traversal traversal

starts

protected ExpandableStepIterator<S> starts

nextEnd

protected Traverser<E> nextEnd

traverserStepIdSetByChild

protected boolean traverserStepIdSetByChild

previousStep

protected Step<?,S> previousStep

nextStep

protected Step<E,?> nextStep

PROFILING_ENABLED

protected static final boolean PROFILING_ENABLED

Constructor Detail

AbstractStep

public AbstractStep(Traversal traversal)

Method Detail

setId

public void setId(java.lang.String id)

Description copied from interface: Step

Get the unique id of the step. These ids can change when strategies are applied and anonymous traversals are embedded in the parent traversal. A developer should typically not need to call this method.

Specified by:

setId in interface Step<S,E>

Parameters:

id - the unique id of the step

getId

public java.lang.String getId()

Description copied from interface: Step

Get the unique id of this step.

Specified by:

getId in interface Step<S,E>

Returns:

the unique id of the step

setLabel

public void setLabel(java.lang.String label)

Description copied from interface: Step

Set the label of this step.

Specified by:

setLabel in interface Step<S,E>

Parameters:

label - the label for this step

getLabel

public java.util.Optional<java.lang.String> getLabel()

Description copied from interface: Step

Get the label of this step. If the step is not labeled, then an Optional.empty() is returned.

Specified by:

getLabel in interface Step<S,E>

Returns:

the optional label of the 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,E>

addStarts

public void addStarts(java.util.Iterator<Traverser<S>> starts)

Description copied from interface: Step

Add a iterator of Traverser objects of type S to the step.

Specified by:

addStarts in interface Step<S,E>

Parameters:

starts - The iterator of objects to add

addStart

public void addStart(Traverser<S> start)

Description copied from interface: Step

Add a single Traverser to the step.

Specified by:

addStart in interface Step<S,E>

Parameters:

start - The traverser to add

setPreviousStep

public void setPreviousStep(Step<?,S> step)

Description copied from interface: Step

Set the step that is previous to the current step. Used for linking steps together to form a function chain.

Specified by:

setPreviousStep in interface Step<S,E>

Parameters:

step - the previous step of this step

getPreviousStep

public Step<?,S> getPreviousStep()

Description copied from interface: Step

Get the step prior to the current step.

Specified by:

getPreviousStep in interface Step<S,E>

Returns:

The previous step

setNextStep

public void setNextStep(Step<E,?> step)

Description copied from interface: Step

Set the step that is next to the current step. Used for linking steps together to form a function chain.

Specified by:

setNextStep in interface Step<S,E>

Parameters:

step - the next step of this step

getNextStep

public Step<E,?> getNextStep()

Description copied from interface: Step

Get the next step to the current step.

Specified by:

getNextStep in interface Step<S,E>

Returns:

The next step

next

public Traverser<E> next()

Specified by:

next in interface java.util.Iterator<Traverser<E>>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<Traverser<E>>

getTraversal

public <A,B> Traversal<A,B> getTraversal()

Description copied from interface: Step

Get the Traversal that this step is contained within.

Specified by:

getTraversal in interface Step<S,E>

Type Parameters:

A - The incoming object type of the traversal

B - The outgoing object type of the traversal

Returns:

The traversal of this step

setTraversal

public void setTraversal(Traversal<?,?> traversal)

Description copied from interface: Step

Set the Traversal that this step is contained within.

Specified by:

setTraversal in interface Step<S,E>

Parameters:

traversal - the new traversal for this step

processNextStart

protected abstract Traverser<E> processNextStart()
                                          throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public AbstractStep<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 java.lang.Object

Returns:

The cloned step

Throws:

java.lang.CloneNotSupportedException