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

Class SubgraphStep

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<Edge>>, Step<Edge,Edge>, Generating, SideEffectCapable

public final class SubgraphStep
extends SideEffectStep<Edge>
implements SideEffectCapable

A side-effect step that produces an edge induced subgraph.

Author:

Stephen Mallette (http://stephen.genoprime.com), 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, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor and Description
SubgraphStep(Traversal.Admin traversal, String sideEffectKey)

Method Summary

Modifier and Type	Method and Description
SubgraphStep	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
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()
protected void	sideEffect(Traverser.Admin<Edge> 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, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, 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.Generating

generateFinalResult

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

equals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

SubgraphStep

public SubgraphStep(Traversal.Admin traversal,
                    String sideEffectKey)

Method Detail

sideEffect

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

Specified by:

sideEffect in class SideEffectStep<Edge>

getSideEffectKey

public String getSideEffectKey()

Description copied from interface: SideEffectCapable

The side-effect key of the step.

Specified by:

getSideEffectKey in interface SideEffectCapable

Returns:

the side-effect key

toString

public String toString()

Overrides:

toString in class AbstractStep<Edge,Edge>

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

Returns:

the set of requirements

clone

public SubgraphStep 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<Edge,Edge>

Overrides:

clone in class AbstractStep<Edge,Edge>

Returns:

The cloned step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<Edge,Edge>