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

Interface PopContaining

All Known Subinterfaces:

Scoping, TraversalOptionParent<M,S,E>, TraversalParent

All Known Implementing Classes:

AddEdgeStartStep, AddEdgeStep, AddPropertyStep, AddVertexStartStep, AddVertexStep, AggregateGlobalStep, AggregateLocalStep, AndStep, BranchStep, CallStep, ChooseStep, CoalesceStep, CombineStep, ConcatStep, ConnectedComponentVertexProgramStep, ConnectiveStep, DateDiffStep, DedupGlobalStep, DifferenceStep, DisjunctStep, ElementMapStep, EmptyStep, FormatStep, GroupCountSideEffectStep, GroupCountStep, GroupSideEffectStep, GroupStep, IndexStep, IntersectStep, LocalStep, MatchStep, MatchStep.MatchEndStep, MatchStep.MatchStartStep, MathStep, MergeEdgeStep, MergeStep, MergeVertexStep, NotStep, OptionalStep, OrderGlobalStep, OrderLocalStep, OrStep, PageRankVertexProgramStep, PathFilterStep, PathStep, PeerPressureVertexProgramStep, ProductStep, ProjectStep, PropertyMapStep, RepeatStep, SackValueStep, SampleGlobalStep, SelectOneStep, SelectStep, ShortestPathVertexProgramStep, SplitGlobalStep, SplitLocalStep, TraversalFilterStep, TraversalFlatMapStep, TraversalMapStep, TraversalMergeStep, TraversalSelectStep, TraversalSideEffectStep, TraversalVertexProgramStep, TreeSideEffectStep, TreeStep, UnionStep, WherePredicateStep, WhereTraversalStep, WhereTraversalStep.WhereEndStep, WhereTraversalStep.WhereStartStep

public interface PopContaining

The PopContaining interface is implemented by traversal steps that maintain Pop instructions for label access. It provides a mechanism to track and manage how labeled elements should be accessed using Pop semantics (first, last, all, or mixed). In Gremlin traversals, various elements can be labeled and later accessed via these labels. The Pop enum determines how to access these labeled elements when there are multiple values associated with the same label.

 
 // Simple example with default Pop.last behavior
 gremlin> g.V().as("a").out().as("a").select("a")
 ==>[v[2]]  // returns the last element labeled "a"

 // Using Pop.first to get the first labeled element
 gremlin> g.V().as("a").out().as("a").select(first, "a")
 ==>[v[1]]  // returns the first element labeled "a"

 // Using Pop.all to get all labeled elements
 gremlin> g.V().as("a").out().as("a").select(all, "a")
 ==>[v[1], v[2]]  // returns all elements labeled "a"
 
 

Steps implementing this interface maintain a collection of PopContaining.PopInstruction objects, each containing a label and a Pop value that specifies how to access elements with that label.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PopContaining.PopInstruction	A class for storing the Scope Context.

Method Summary

Modifier and Type	Method	Description
Set<PopContaining.PopInstruction>	getPopInstructions()

Method Detail

getPopInstructions

Set<PopContaining.PopInstruction> getPopInstructions()