com.tinkerpop.gremlin.process.graph.step.sideEffect

Class SubgraphStep<S>

java.lang.Object

com.tinkerpop.gremlin.process.util.AbstractStep<S,S>

com.tinkerpop.gremlin.process.graph.step.sideEffect.SideEffectStep<S>

com.tinkerpop.gremlin.process.graph.step.sideEffect.SubgraphStep<S>

All Implemented Interfaces:

Reversible, SideEffectCapable, SideEffectRegistrar, Step<S,S>, java.lang.Cloneable, java.util.Iterator<Traverser<S>>

public final class SubgraphStep<S>
extends SideEffectStep<S>
implements SideEffectCapable, SideEffectRegistrar, Reversible

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

Author:

Stephen Mallette (http://stephen.genoprime.com)

Field Summary

Fields inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

id, label, nextEnd, nextStep, previousStep, PROFILING_ENABLED, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
SubgraphStep(Traversal traversal, java.lang.String sideEffectKey, java.util.Set<java.lang.Object> edgeIdHolder, java.util.Map<java.lang.Object,Vertex> idVertexMap, java.util.function.Predicate<Edge> includeEdge)

Method Summary

Modifier and Type	Method and Description
java.util.Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
java.lang.String	getSideEffectKey()
void	registerSideEffects()
java.lang.String	toString()

Methods inherited from class com.tinkerpop.gremlin.process.graph.step.sideEffect.SideEffectStep

processNextStart, setConsumer

Methods inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

addStart, addStarts, clone, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, reset, 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 com.tinkerpop.gremlin.process.graph.marker.Reversible

reverse

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

SubgraphStep

public SubgraphStep(Traversal traversal,
                    java.lang.String sideEffectKey,
                    java.util.Set<java.lang.Object> edgeIdHolder,
                    java.util.Map<java.lang.Object,Vertex> idVertexMap,
                    java.util.function.Predicate<Edge> includeEdge)

Method Detail

registerSideEffects

public void registerSideEffects()

Specified by:

registerSideEffects in interface SideEffectRegistrar

getSideEffectKey

public java.lang.String getSideEffectKey()

Specified by:

getSideEffectKey in interface SideEffectCapable

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,S>

getRequirements

public java.util.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