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

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PopContaining

PopContaining.PopInstruction

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping

Scoping.KeyNotFoundException, Scoping.Variable

Field Summary

Fields

Modifier and Type	Field	Description
static List<Class<? extends Step>>	CONCRETE_STEPS	Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Summary

Modifier and Type	Method	Description
Object	getElementId()
default Object	getElementIdWithGValue()
Object	getLabel()
default Object	getLabelWithGValue()
default HashSet<PopContaining.PopInstruction>	getPopInstructions()	Used to get PopInstruction of a Step that implements Scoping.
boolean	removeElementId()
void	setElementId(Object elementId)
void	setLabel(Object label)

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Configuring

configure

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Parameterizing

getParameters

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PropertiesHolder

addProperty, getProperties, getPropertiesWithGValues, removeProperty

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping

getNullableScopeValue, getSafeScopeValue, getScopeKeys, getScopeValue

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step

addLabel, addStart, addStarts, clearLabels, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getRequirements, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent

addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getLocalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild

Field Detail

CONCRETE_STEPS

static final List<Class<? extends Step>> CONCRETE_STEPS

Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Detail

getLabel

Object getLabel()

getLabelWithGValue

default Object getLabelWithGValue()

setLabel

void setLabel(Object label)

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