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

Class GroupCountSideEffectStep<S,E>

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.GroupCountSideEffectStep<S,E>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, ByModulating, Generating<Map<E,Long>,Map<E,Long>>, PopContaining, SideEffectCapable<Map<E,Long>,Map<E,Long>>, TraversalParent

public class GroupCountSideEffectStep<S,E>
extends SideEffectStep<S>
implements SideEffectCapable<Map<E,Long>,Map<E,Long>>, TraversalParent, ByModulating

Author:

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

See Also:

Serialized Form

Nested Class Summary

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

PopContaining.PopInstruction

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
GroupCountSideEffectStep(Traversal.Admin traversal, String sideEffectKey)

Method Summary

Modifier and Type	Method	Description
void	addLocalChild(Traversal.Admin<?,?> groupTraversal)
GroupCountSideEffectStep<S,E>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
List<Traversal.Admin<S,E>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	getSideEffectKey()	The side-effect key of the step.
int	hashCode()
void	modulateBy(Traversal.Admin<?,?> keyTraversal)
void	replaceLocalChild(Traversal.Admin<?,?> oldTraversal, Traversal.Admin<?,?> newTraversal)
void	setTraversal(Traversal.Admin<?,?> parentTraversal)	Set the Traversal that this step is contained within.
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, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep

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

modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Generating

generateFinalResult

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

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

equals

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent

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

Constructor Detail

GroupCountSideEffectStep

public GroupCountSideEffectStep(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()

Description copied from interface: SideEffectCapable

The side-effect key of the step.

Specified by:

getSideEffectKey in interface SideEffectCapable<S,E>

Returns:

the side-effect key

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

addLocalChild

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

Specified by:

addLocalChild in interface TraversalParent

getLocalChildren

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

Description copied from interface: TraversalParent

Gets a list of all "local" child traversals for this step. A "local" traversal is one which is evaluated independently for each incoming traverser to the parent step. This is typically used in cases where the child is used to process or augment each traverser individually. See LocalStep or ByModulating as examples.

Specified by:

getLocalChildren 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,E>

Returns:

the set of requirements

clone

public GroupCountSideEffectStep<S,E> 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 Step.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 AbstractStep<S,S>

Returns:

The cloned step

setTraversal

public void setTraversal(Traversal.Admin<?,?> parentTraversal)

Description copied from interface: Step

Set the Traversal that this step is contained within.

Specified by:

setTraversal in interface Step<S,E>

Overrides:

setTraversal in class AbstractStep<S,S>

Parameters:

parentTraversal - the new traversal for this step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

modulateBy

public void modulateBy(Traversal.Admin<?,?> keyTraversal)
                throws UnsupportedOperationException

Specified by:

modulateBy in interface ByModulating

Throws:

UnsupportedOperationException

replaceLocalChild

public void replaceLocalChild(Traversal.Admin<?,?> oldTraversal,
                              Traversal.Admin<?,?> newTraversal)

Specified by:

replaceLocalChild in interface TraversalParent