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

Class AggregateStep<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.sideEffect.AggregateStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<S>>, Step<S,S>, MapReducer<MapReduce.NullObject,Object,MapReduce.NullObject,Object,Collection>, SideEffectCapable, TraversalParent

public final class AggregateStep<S>
extends CollectingBarrierStep<S>
implements SideEffectCapable, TraversalParent, MapReducer<MapReduce.NullObject,Object,MapReduce.NullObject,Object,Collection>

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregateStep.AggregateMapReduce

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
AggregateStep(Traversal.Admin traversal, String sideEffectKey)

Method Summary

Modifier and Type	Method and Description
void	addLocalChild(Traversal.Admin<?,?> aggregateTraversal)
void	barrierConsumer(TraverserSet<S> traverserSet)
AggregateStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
List<Traversal.Admin<S,Object>>	getLocalChildren()
MapReduce<MapReduce.NullObject,Object,MapReduce.NullObject,Object,Collection>	getMapReduce()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	getSideEffectKey()
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

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

AggregateStep

public AggregateStep(Traversal.Admin traversal,
                     String sideEffectKey)

Method Detail

getSideEffectKey

public String getSideEffectKey()

Specified by:

getSideEffectKey in interface SideEffectCapable

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

getMapReduce

public MapReduce<MapReduce.NullObject,Object,MapReduce.NullObject,Object,Collection> getMapReduce()

Specified by:

getMapReduce in interface MapReducer<MapReduce.NullObject,Object,MapReduce.NullObject,Object,Collection>

addLocalChild

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

Specified by:

addLocalChild in interface TraversalParent

getLocalChildren

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

Specified by:

getLocalChildren in interface TraversalParent

barrierConsumer

public void barrierConsumer(TraverserSet<S> traverserSet)

Specified by:

barrierConsumer 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

clone

public AggregateStep<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