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

Class GroupSideEffectStep<S,K,V,R>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroupSideEffectStep<S,K,V,R>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<S>>, Step<S,S>, EngineDependent, MapReducer<K,Collection<V>,K,R,Map<K,R>>, SideEffectCapable, TraversalParent

public final class GroupSideEffectStep<S,K,V,R>
extends SideEffectStep<S>
implements SideEffectCapable, TraversalParent, EngineDependent, MapReducer<K,Collection<V>,K,R,Map<K,R>>

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupSideEffectStep.GroupSideEffectMapReduce<K,V,R>

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

Method Summary

Modifier and Type	Method and Description
void	addLocalChild(Traversal.Admin<?,?> kvrTraversal)
GroupSideEffectStep<S,K,V,R>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
<A,B> List<Traversal.Admin<A,B>>	getLocalChildren()
MapReduce<K,Collection<V>,K,R,Map<K,R>>	getMapReduce()
Traversal.Admin<Collection<V>,R>	getReduceTraversal()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	getSideEffectKey()
int	hashCode()
void	onEngine(TraversalEngine traversalEngine)
protected void	sideEffect(Traverser.Admin<S> traverser)
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep

processNextStart

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

GroupSideEffectStep

public GroupSideEffectStep(Traversal.Admin traversal,
                           String sideEffectKey)

Method Detail

sideEffect

protected void sideEffect(Traverser.Admin<S> traverser)

Specified by:

sideEffect in class SideEffectStep<S>

getSideEffectKey

public String getSideEffectKey()

Specified by:

getSideEffectKey in interface SideEffectCapable

onEngine

public void onEngine(TraversalEngine traversalEngine)

Specified by:

onEngine in interface EngineDependent

getMapReduce

public MapReduce<K,Collection<V>,K,R,Map<K,R>> getMapReduce()

Specified by:

getMapReduce in interface MapReducer<K,Collection<V>,K,R,Map<K,R>>

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

getLocalChildren

public <A,B> List<Traversal.Admin<A,B>> getLocalChildren()

Specified by:

getLocalChildren in interface TraversalParent

getReduceTraversal

public Traversal.Admin<Collection<V>,R> getReduceTraversal()

addLocalChild

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

Specified by:

addLocalChild 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,S>

Returns:

the set of requirements

clone

public GroupSideEffectStep<S,K,V,R> 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 AbstractStep<S,S>

Returns:

The cloned step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>