Interface Scoping

  • All Known Implementing Classes:
    AddEdgeStartStep, AddEdgeStep, AddPropertyStep, AddVertexStartStep, AddVertexStep, DedupGlobalStep, FormatStep, MatchStep, MatchStep.MatchEndStep, MatchStep.MatchStartStep, MathStep, SelectOneStep, SelectStep, TraversalSelectStep, 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.

    There are four types of scopes:

    1. Current scope
    2. — the current data referenced by the traverser (“path head”).
    3. Path scope
    4. — a particular piece of data in the path of the traverser (“path history”).
    5. Side-effect scope
    6. — a particular piece of data in the global traversal blackboard.
    7. Map scope
    8. — a particular piece of data in the current scope map (“map value by key”).
    The current scope refers to the current object referenced by the traverser. That is, the traverser.get() object. Another way to think about the current scope is to think in terms of the path of the traverser where the current scope is the head of the path. With the math()-step, the variable _ refers to the current scope.
     gremlin> g.V().values("age").math("sin _")
    The path scope refers to data previously seen by the traverser. That is, data in the traverser’s path history. Paths can be accessed by path(), however, individual parts of the path can be labeled using as() and accessed later via the path label name. Thus, in the traversal below, “a” and “b” refer to objects previously traversed by the traverser.
     gremlin> g.V().as("a").out("knows").as("b”).
     math("a / b").by("age")
    The side-effect scope refers objects in the global side-effects of the traversal. Side-effects are not local to the traverser, but instead, global to the traversal. In the traversal below you can see how “x” is being referenced in the math()-step and thus, the side-effect data is being used.
     gremlin> g.withSideEffect("x",100).V().values("age").math("_ / x")
    Map scope refers to objects within the current map object. Thus, its like current scope, but a bit “deeper.” In the traversal below the project()-step generates a map with keys “a” and “b”. The subsequent math()-step is then able to access the “a” and “b” values in the respective map and use them for the division operation.
     math("a / b")
    Scoping is all about variable data access and forms the fundamental interface for access to the memory structures of Gremlin.
    Marko A. Rodriguez (, Stephen Mallette (
    • Method Detail

      • getNullableScopeValue

        default <S> S getNullableScopeValue​(Pop pop,
                                            String key,
                                            Traverser.Admin<?> traverser)
        Calls getScopeValue(Pop, Object, Traverser.Admin) and returns null if the key is not found. Use this method with caution as null has one of two meanings as a return value. It could be that the key was found and its value was null or it might mean that the key was not found and null was simply returned.
      • getScopeKeys

        Set<String> getScopeKeys()
        Get the labels that this scoping step will access during the traversal
        the accessed labels of the scoping step