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

Interface AddEdgeStepContract<S>

All Superinterfaces:

AddElementStepContract<S,Edge>, AutoCloseable, Cloneable, Configuring, FromToModulating, Iterator<Traverser.Admin<Edge>>, Mutating<Event.EdgeAddedEvent>, Parameterizing, PopContaining, PropertiesHolder, Scoping, Serializable, Step<S,Edge>, TraversalParent, Writing<Event.EdgeAddedEvent>

All Known Implementing Classes:

AbstractAddEdgeStepPlaceholder, AddEdgeStartStep, AddEdgeStartStepPlaceholder, AddEdgeStep, AddEdgeStepPlaceholder

public interface AddEdgeStepContract<S>
extends AddElementStepContract<S,Edge>, FromToModulating, Writing<Event.EdgeAddedEvent>

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 final 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
default Object	getAdjacentVertex(Parameters parameters, String key)
default Vertex	getAdjacentVertex(Parameters parameters, String key, Traverser.Admin<S> traverser, String edgeLabel)
Object	getFrom()	Gets the "from" vertex for the edge to be added.
default Object	getFromWithGValue()	Gets the "from" vertex for the edge to be added.
Object	getTo()	Gets the "to" vertex for the edge to be added.
default Object	getToWithGValue()	Gets the "from" vertex for the edge to be added.

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

getElementId, getElementIdWithGValue, getLabel, getLabelWithGValue, getPopInstructions, removeElementId, setElementId, setLabel

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

configure

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

addFrom, addFrom, addTo, addTo

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

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

getMutatingCallbackRegistry

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

getFrom

Object getFrom()

Gets the "from" vertex for the edge to be added. If the "from" vertex was added as a Vertex, ID, GValue, or ConstantTraversal, it is returned as a ReferenceVertex. Otherwise, it is returned in Traversal form.

getTo

Object getTo()

Gets the "to" vertex for the edge to be added. If the "to" vertex was added as a Vertex, ID, GValue, or ConstantTraversal, it is returned as a ReferenceVertex. Otherwise, it is returned in Traversal form.

getFromWithGValue

default Object getFromWithGValue()

Gets the "from" vertex for the edge to be added. If the "from" vertex was added as a Vertex, ID, or ConstantTraversal, it is returned as a ReferenceVertex. If it was added as a GValue containing a Vertex or ID, the GValue is returned. Otherwise, it is returned in Traversal form.

getToWithGValue

default Object getToWithGValue()

Gets the "from" vertex for the edge to be added. If the "from" vertex was added as a Vertex, ID, or ConstantTraversal, it is returned as a ReferenceVertex. If it was added as a GValue containing a Vertex or ID, the GValue is returned. Otherwise, it is returned in Traversal form.

getAdjacentVertex

default Object getAdjacentVertex(Parameters parameters,
 String key)

getAdjacentVertex

default Vertex getAdjacentVertex(Parameters parameters,
 String key,
 Traverser.Admin<S> traverser,
 String edgeLabel)