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

Interface Scoping

All Known Implementing Classes:

DedupGlobalStep, MatchStep, MatchStep.MatchStartStep, SelectOneStep, SelectStep, WherePredicateStep, WhereTraversalStep, WhereTraversalStep.WhereEndStep, WhereTraversalStep.WhereStartStep

public interface Scoping

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Scoping.Variable

Field Summary

Fields

Modifier and Type	Field and Description
static Set<TraverserRequirement>	TYPICAL_GLOBAL_REQUIREMENTS
static TraverserRequirement[]	TYPICAL_GLOBAL_REQUIREMENTS_ARRAY
static Set<TraverserRequirement>	TYPICAL_LOCAL_REQUIREMENTS
static TraverserRequirement[]	TYPICAL_LOCAL_REQUIREMENTS_ARRAY

Method Summary

Modifier and Type	Method and Description
default <S> S	getNullableScopeValue(Pop pop, String key, Traverser.Admin<?> traverser)
Set<String>	getScopeKeys()
default <S> S	getScopeValue(Pop pop, String key, Traverser.Admin<?> traverser)

Field Detail

TYPICAL_LOCAL_REQUIREMENTS

static final Set<TraverserRequirement> TYPICAL_LOCAL_REQUIREMENTS

TYPICAL_GLOBAL_REQUIREMENTS

static final Set<TraverserRequirement> TYPICAL_GLOBAL_REQUIREMENTS

TYPICAL_LOCAL_REQUIREMENTS_ARRAY

static final TraverserRequirement[] TYPICAL_LOCAL_REQUIREMENTS_ARRAY

TYPICAL_GLOBAL_REQUIREMENTS_ARRAY

static final TraverserRequirement[] TYPICAL_GLOBAL_REQUIREMENTS_ARRAY

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