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

Class OrderGlobalStep<S>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public final class OrderGlobalStep<S>
extends CollectingBarrierStep<S>
implements ComparatorHolder<S>, 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, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
OrderGlobalStep(Traversal.Admin traversal)

Method Summary

Modifier and Type	Method and Description
void	addComparator(Comparator<S> comparator)
void	addLocalChild(Traversal.Admin<?,?> localChildTraversal)
void	barrierConsumer(TraverserSet<S> traverserSet)
OrderGlobalStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
List<Comparator<S>>	getComparators()
<S,E> 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()
String	toString()

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

processNextStart, reset

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

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

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

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

equals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

OrderGlobalStep

public OrderGlobalStep(Traversal.Admin traversal)

Method Detail

barrierConsumer

public void barrierConsumer(TraverserSet<S> traverserSet)

Specified by:

barrierConsumer in class CollectingBarrierStep<S>

addComparator

public void addComparator(Comparator<S> comparator)

Specified by:

addComparator in interface ComparatorHolder<S>

getComparators

public List<Comparator<S>> getComparators()

Specified by:

getComparators in interface ComparatorHolder<S>

toString

public String toString()

Overrides:

toString in class CollectingBarrierStep<S>

hashCode

public int hashCode()

Overrides:

hashCode in class CollectingBarrierStep<S>

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>

Overrides:

getRequirements in class CollectingBarrierStep<S>

Returns:

the set of requirements

getLocalChildren

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

Specified by:

getLocalChildren in interface TraversalParent

addLocalChild

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

Specified by:

addLocalChild in interface TraversalParent

clone

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

Overrides:

clone in class CollectingBarrierStep<S>

Returns:

The cloned step