Package org.apache.tinkerpop.gremlin.process.traversal.traverser

Class O_OB_S_SE_SL_Traverser<T>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.traverser.util.AbstractTraverser<T>

org.apache.tinkerpop.gremlin.process.traversal.traverser.O_Traverser<T>

org.apache.tinkerpop.gremlin.process.traversal.traverser.O_OB_S_SE_SL_Traverser<T>

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Traverser<T>>, Traverser<T>, Traverser.Admin<T>, NL_SL_Traverser<T>, Attachable<T>

Direct Known Subclasses:

LP_O_OB_P_S_SE_SL_Traverser, LP_O_OB_S_SE_SL_Traverser, NL_O_OB_S_SE_SL_Traverser

public class O_OB_S_SE_SL_Traverser<T>
extends O_Traverser<T>
implements NL_SL_Traverser<T>

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.util.Attachable

Attachable.Exceptions, Attachable.Method

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

Traverser.Admin<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected long	bulk
protected String	future
protected String	loopName
protected short	loops
protected Object	sack
protected TraversalSideEffects	sideEffects
protected String	stepLabel

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.traverser.O_Traverser

tags

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.traverser.util.AbstractTraverser

t

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.util.Attachable

logger

Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin

HALT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	O_OB_S_SE_SL_Traverser()
	O_OB_S_SE_SL_Traverser(T t, Step<T,?> step)

Method Summary

Modifier and Type	Method	Description
long	bulk()	A traverser may represent a grouping of traversers to allow for more efficient data propagation.
boolean	equals(Object object)
protected boolean	equals(O_OB_S_SE_SL_Traverser other)
TraverserRequirement	getLoopRequirement()
TraversalSideEffects	getSideEffects()	Get the sideEffects associated with the traversal of the traverser.
short	getSingleLoopCount()	Override this method to support single loop.
String	getSingleLoopName()	Override this method to support single loop.
String	getSingleLoopStepLabel()	Override this method to support single loop.
String	getStepId()	Get the step id of where the traverser is located.
int	hashCode()
void	merge(Traverser.Admin<?> other)	When two traversers are have equality with each other, then they can be merged.
<S> S	sack()	Get the sack local sack object of this traverser.
<S> void	sack(S object)	Set the traversers sack object to the provided value ("sack the value").
void	setBulk(long count)	Set the number of traversers represented by this traverser.
void	setSideEffects(TraversalSideEffects sideEffects)	Set the sideEffects of the Traversal.
void	setSingleLoopCount(short loops)	Override this method to support single loop.
void	setSingleLoopName(String loopName)	Override this method to support single loop.
void	setSingleLoopStepLabel(String stepLabel)	Override this method to support single loop.
void	setStepId(String stepId)	Set the step id of where the traverser is located.
Traverser.Admin<T>	split()	Generate a sibling traverser of the current traverser with a full copy of all state within the sibling.
<R> Traverser.Admin<R>	split(R r, Step<T,R> step)	Generate a child traverser of the current traverser for current as step and new object location.

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.traverser.O_Traverser

equals, getTags

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.traverser.util.AbstractTraverser

addLabels, attach, clone, detach, dropLabels, dropPath, get, keepLabels, path, set, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Attachable

get

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.traverser.NL_SL_Traverser

copyNestedLoops, getLoopNames, getNestedLoopCount, getNestedLoopNames, getNestedLoops, getValidLoopRequirement, incrLoops, initialiseLoops, initialiseNestedLoops, loops, loops, resetLoops

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

asAdmin, clone, compareTo, get, path, path, path, sideEffects, sideEffects

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin

addLabels, attach, detach, dropLabels, dropPath, getTags, isHalted, keepLabels, set

Field Detail

sack

protected Object sack

loops

protected short loops

loopName

protected String loopName

stepLabel

protected String stepLabel

sideEffects

protected transient TraversalSideEffects sideEffects

future

protected String future

bulk

protected long bulk

Constructor Detail

O_OB_S_SE_SL_Traverser

protected O_OB_S_SE_SL_Traverser()

O_OB_S_SE_SL_Traverser

public O_OB_S_SE_SL_Traverser(T t,
                              Step<T,?> step)

Method Detail

getSingleLoopCount

public short getSingleLoopCount()

Description copied from interface: NL_SL_Traverser

Override this method to support single loop.

Specified by:

getSingleLoopCount in interface NL_SL_Traverser<T>

Returns:

the single loop count.

setSingleLoopCount

public void setSingleLoopCount(short loops)

Description copied from interface: NL_SL_Traverser

Override this method to support single loop. Sets the single loop count.

Specified by:

setSingleLoopCount in interface NL_SL_Traverser<T>

getSingleLoopName

public String getSingleLoopName()

Description copied from interface: NL_SL_Traverser

Override this method to support single loop.

Specified by:

getSingleLoopName in interface NL_SL_Traverser<T>

Returns:

the single loop name.

setSingleLoopName

public void setSingleLoopName(String loopName)

Description copied from interface: NL_SL_Traverser

Override this method to support single loop. Sets the single loop name.

Specified by:

setSingleLoopName in interface NL_SL_Traverser<T>

getSingleLoopStepLabel

public String getSingleLoopStepLabel()

Description copied from interface: NL_SL_Traverser

Override this method to support single loop.

Specified by:

getSingleLoopStepLabel in interface NL_SL_Traverser<T>

Returns:

the single loop step label.

setSingleLoopStepLabel

public void setSingleLoopStepLabel(String stepLabel)

Description copied from interface: NL_SL_Traverser

Override this method to support single loop. Sets the single loop step label.

Specified by:

setSingleLoopStepLabel in interface NL_SL_Traverser<T>

getLoopRequirement

public TraverserRequirement getLoopRequirement()

Specified by:

getLoopRequirement in interface NL_SL_Traverser<T>

Returns:

the supported loop type - either TraverserRequirement.NESTED_LOOP or TraverserRequirement.SINGLE_LOOP

setBulk

public void setBulk(long count)

Description copied from interface: Traverser.Admin

Set the number of traversers represented by this traverser.

Specified by:

setBulk in interface Traverser.Admin<T>

Overrides:

setBulk in class AbstractTraverser<T>

Parameters:

count - the number of traversers

bulk

public long bulk()

Description copied from interface: Traverser

A traverser may represent a grouping of traversers to allow for more efficient data propagation.

Specified by:

bulk in interface Traverser<T>

Overrides:

bulk in class AbstractTraverser<T>

Returns:

the number of traversers represented in this traverser.

sack

public <S> S sack()

Description copied from interface: Traverser

Get the sack local sack object of this traverser.

Specified by:

sack in interface Traverser<T>

Overrides:

sack in class AbstractTraverser<T>

Type Parameters:

S - the type of the sack object

Returns:

the sack object

sack

public <S> void sack(S object)

Description copied from interface: Traverser

Set the traversers sack object to the provided value ("sack the value").

Specified by:

sack in interface Traverser<T>

Overrides:

sack in class AbstractTraverser<T>

Type Parameters:

S - the type of the object

Parameters:

object - the new value of the traverser's sack

getStepId

public String getStepId()

Description copied from interface: Traverser.Admin

Get the step id of where the traverser is located. This is typically used in multi-machine systems that require the movement of traversers between different traversal instances.

Specified by:

getStepId in interface Traverser.Admin<T>

Overrides:

getStepId in class AbstractTraverser<T>

Returns:

The future step for the traverser

setStepId

public void setStepId(String stepId)

Description copied from interface: Traverser.Admin

Set the step id of where the traverser is located. If the future is Traverser.Admin.HALT, then Traverser.Admin.isHalted() is true.

Specified by:

setStepId in interface Traverser.Admin<T>

Overrides:

setStepId in class AbstractTraverser<T>

Parameters:

stepId - The future step of the traverser

getSideEffects

public TraversalSideEffects getSideEffects()

Description copied from interface: Traverser.Admin

Get the sideEffects associated with the traversal of the traverser.

Specified by:

getSideEffects in interface Traverser.Admin<T>

Overrides:

getSideEffects in class AbstractTraverser<T>

Returns:

the traversal sideEffects of the traverser

setSideEffects

public void setSideEffects(TraversalSideEffects sideEffects)

Description copied from interface: Traverser.Admin

Set the sideEffects of the Traversal. Given that traversers can move between machines, it may be important to re-set this when the traverser crosses machine boundaries.

Specified by:

setSideEffects in interface Traverser.Admin<T>

Overrides:

setSideEffects in class AbstractTraverser<T>

Parameters:

sideEffects - the sideEffects of the traversal.

split

public <R> Traverser.Admin<R> split(R r,
                                    Step<T,R> step)

Description copied from interface: Traverser.Admin

Generate a child traverser of the current traverser for current as step and new object location. The child has the path history, future, and loop information of the parent. The child extends that path history with the current as and provided R-object.

Specified by:

split in interface Traverser.Admin<T>

Overrides:

split in class O_Traverser<T>

Type Parameters:

R - The current object type of the child

Parameters:

r - The current object of the child

step - The step yielding the split

Returns:

The split traverser

split

public Traverser.Admin<T> split()

Description copied from interface: Traverser.Admin

Generate a sibling traverser of the current traverser with a full copy of all state within the sibling.

Specified by:

split in interface Traverser.Admin<T>

Overrides:

split in class O_Traverser<T>

Returns:

The split traverser

merge

public void merge(Traverser.Admin<?> other)

Description copied from interface: Traverser.Admin

When two traversers are have equality with each other, then they can be merged. This method is used to merge the traversers into a single traverser. This is used for optimization where instead of enumerating all traversers, they can be counted.

Specified by:

merge in interface Traverser.Admin<T>

Overrides:

merge in class O_Traverser<T>

Parameters:

other - the other traverser to merge into this traverser. Once merged, the other can be garbage collected.

hashCode

public int hashCode()

Overrides:

hashCode in class O_Traverser<T>

equals

protected final boolean equals(O_OB_S_SE_SL_Traverser other)

equals

public boolean equals(Object object)

Overrides:

equals in class O_Traverser<T>