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

Interface AddElementStepContract<S,E>

All Superinterfaces:
AutoCloseable, Cloneable, Configuring, Iterator<Traverser.Admin<E>>, Parameterizing, PopContaining, PropertiesHolder, Scoping, Serializable, Step<S,E>, TraversalParent
All Known Subinterfaces:
AddEdgeStepContract<S>, AddVertexStepContract<S>
All Known Implementing Classes:
AbstractAddEdgeStepPlaceholder, AbstractAddElementStepPlaceholder, AbstractAddVertexStepPlaceholder, AddEdgeStartStep, AddEdgeStartStepPlaceholder, AddEdgeStep, AddEdgeStepPlaceholder, AddVertexStartStep, AddVertexStartStepPlaceholder, AddVertexStep, AddVertexStepPlaceholder
public interface AddElementStepContract<S,E> extends Step<S,E>, PropertiesHolder, TraversalParent, Scoping, Configuring

  • Field Details

    • CONCRETE_STEPS

      static final List<Class<? extends Step>> CONCRETE_STEPS
      Concrete implementations of this contract that can be referenced as TinkerPop implementations.

  • Method Details

    • getLabel

      Object getLabel()
      Gets the label(s) assigned to the element produced by this step. Returns a single value, or a Set when multiple labels were specified (e.g. addV("a", "b")). Each individual label value will either be a String or Traversal depending on how it was initially set. Callers should not assume the type is String and should check with instanceof before casting.
      Returns:
      a String, Traversal, or a Set containing either

    • getLabelWithGValue

      default Object getLabelWithGValue()

    • setLabel

      void setLabel(Object label)
      Sets the label(s) to assign to the element produced by this step. Accepts a single String, GValue<String>, or Traversal resolving to a String, or a Collection<Object> of two or more such values. Should behave identically to specifying the same value at construction time. Implementations may restrict calling this method more than once at their own discretion.
      Parameters:
      label - a String, GValue<String>, Traversal, or Collection<Object>

    • getElementId

      Object getElementId()

    • getElementIdWithGValue

      default Object getElementIdWithGValue()

    • setElementId

      void setElementId(Object elementId)

    • removeElementId

      boolean removeElementId()

    • getPopInstructions

      default HashSet<PopContaining.PopInstruction> getPopInstructions()
      Description copied from interface: Scoping
      Used to get PopInstruction of a Step that implements Scoping. PopInstruction includes the labels it needs, and the pop type for each label.
      Specified by:
      getPopInstructions in interface PopContaining
      Specified by:
      getPopInstructions in interface Scoping
      Specified by:
      getPopInstructions in interface TraversalParent
      Returns:
      A Set of PopContaining.PopInstruction values which contain the label and Pop value