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

Interface Scoping

All Known Implementing Classes:

AddEdgeStartStep, AddEdgeStep, AddPropertyStep, AddVertexStartStep, AddVertexStep, DedupGlobalStep, MatchStep, MatchStep.MatchEndStep, MatchStep.MatchStartStep, SelectOneStep, SelectStep, WherePredicateStep, WhereTraversalStep, WhereTraversalStep.WhereEndStep, WhereTraversalStep.WhereStartStep

public interface Scoping

This interface is implemented by Step implementations that access labeled path steps, side-effects or Map values by key, such as select('a') step. Note that a step like project() is non-scoping because while it creates a Map it does not introspect them.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Scoping.Variable

Method Summary

Modifier and Type	Method and Description
default <S> S	getNullableScopeValue(Pop pop, String key, Traverser.Admin<?> traverser)
Set<String>	getScopeKeys() Get the labels that this scoping step will access during the traversal
default <S> S	getScopeValue(Pop pop, String key, Traverser.Admin<?> traverser)

Method Detail

getScopeValue

default <S> S getScopeValue(Pop pop,
                            String key,
                            Traverser.Admin<?> traverser)
                     throws IllegalArgumentException

Throws:

IllegalArgumentException

getNullableScopeValue

default <S> S getNullableScopeValue(Pop pop,
                                    String key,
                                    Traverser.Admin<?> traverser)

getScopeKeys

Set<String> getScopeKeys()

Get the labels that this scoping step will access during the traversal

Returns:

the accessed labels of the scoping step