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

Class AbstractAddEdgeStepPlaceholder<S>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.map.AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

org.apache.tinkerpop.gremlin.process.traversal.step.map.AbstractAddEdgeStepPlaceholder<S>

All Implemented Interfaces:

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

Direct Known Subclasses:

AddEdgeStartStepPlaceholder, AddEdgeStepPlaceholder

public abstract class AbstractAddEdgeStepPlaceholder<S>
extends AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>
implements AddEdgeStepContract<S>

See Also:

Serialized Form

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
protected Traversal.Admin<?,?>	from
protected Traversal.Admin<?,?>	to

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.AbstractAddElementStepPlaceholder

elementId, label, properties, scopeKeys, withConfiguration

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.map.AddEdgeStepContract

CONCRETE_STEPS

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

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
AbstractAddEdgeStepPlaceholder(Traversal.Admin traversal, String label)
AbstractAddEdgeStepPlaceholder(Traversal.Admin traversal, GValue<String> label)
AbstractAddEdgeStepPlaceholder(Traversal.Admin traversal, Traversal.Admin<S,String> labelTraversal)

Method Summary

Modifier and Type	Method	Description
void	addFrom(Traversal.Admin<?,?> fromObject)
void	addTo(Traversal.Admin<?,?> toObject)
AbstractAddEdgeStepPlaceholder<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
boolean	equals(Object o)
protected String	getDefaultLabel()
Object	getFrom()	Gets the "from" vertex for the edge to be added.
Object	getFromWithGValue()	Gets the "from" vertex for the edge to be added.
Collection<GValue<?>>	getGValues()
List<Traversal.Admin<?,?>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
Object	getTo()	Gets the "to" vertex for the edge to be added.
Object	getToWithGValue()	Gets the "from" vertex for the edge to be added.
int	hashCode()
boolean	isParameterized()
protected boolean	supportsMultiProperties()
void	updateVariable(String name, Object value)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.AbstractAddElementStepPlaceholder

addProperty, addTraversal, configure, configureConcreteStep, getElementId, getElementIdWithGValue, getLabel, getLabelWithGValue, getMutatingCallbackRegistry, getParameters, getProperties, getPropertiesWithGValues, getRequirements, getScopeKeys, map, removeElementId, removeProperty, setElementId, setLabel, setTraversal

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep

processNextStart

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addLabel, addStart, addStarts, clearLabels, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getAdjacentVertex, getAdjacentVertex

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

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

asConcreteStep, reduce

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, 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, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild

Field Detail

from

protected Traversal.Admin<?,?> from

to

protected Traversal.Admin<?,?> to

Constructor Detail

AbstractAddEdgeStepPlaceholder

public AbstractAddEdgeStepPlaceholder(Traversal.Admin traversal,
                                      String label)

AbstractAddEdgeStepPlaceholder

public AbstractAddEdgeStepPlaceholder(Traversal.Admin traversal,
                                      GValue<String> label)

AbstractAddEdgeStepPlaceholder

public AbstractAddEdgeStepPlaceholder(Traversal.Admin traversal,
                                      Traversal.Admin<S,String> labelTraversal)

Method Detail

getDefaultLabel

protected String getDefaultLabel()

Specified by:

getDefaultLabel in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

addTo

public void addTo(Traversal.Admin<?,?> toObject)

Specified by:

addTo in interface FromToModulating

addFrom

public void addFrom(Traversal.Admin<?,?> fromObject)

Specified by:

addFrom in interface FromToModulating

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

isParameterized

public boolean isParameterized()

Specified by:

isParameterized in interface GValueHolder<S,Edge>

Overrides:

isParameterized in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

getLocalChildren

public List<Traversal.Admin<?,?>> getLocalChildren()

Description copied from interface: TraversalParent

Gets a list of all "local" child traversals for this step. A "local" traversal is one which is evaluated independently for each incoming traverser to the parent step. This is typically used in cases where the child is used to process or augment each traverser individually. See LocalStep or ByModulating as examples.

Specified by:

getLocalChildren in interface TraversalParent

Overrides:

getLocalChildren in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

supportsMultiProperties

protected boolean supportsMultiProperties()

Specified by:

supportsMultiProperties in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

getFrom

public Object getFrom()

Description copied from interface: AddEdgeStepContract

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.

Specified by:

getFrom in interface AddEdgeStepContract<S>

getFromWithGValue

public Object getFromWithGValue()

Description copied from interface: AddEdgeStepContract

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.

Specified by:

getFromWithGValue in interface AddEdgeStepContract<S>

getTo

public Object getTo()

Description copied from interface: AddEdgeStepContract

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.

Specified by:

getTo in interface AddEdgeStepContract<S>

getToWithGValue

public Object getToWithGValue()

Description copied from interface: AddEdgeStepContract

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.

Specified by:

getToWithGValue in interface AddEdgeStepContract<S>

updateVariable

public void updateVariable(String name,
                           Object value)

Specified by:

updateVariable in interface GValueHolder<S,Edge>

Overrides:

updateVariable in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S,Edge>

Overrides:

getGValues in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

clone

public AbstractAddEdgeStepPlaceholder<S> clone()

Description copied from interface: Step

Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication. When cloning a step, it is important that the steps, the cloned step is equivalent to the state of the step when Step.reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<S,Edge>

Overrides:

clone in class AbstractAddElementStepPlaceholder<S,Edge,Event.EdgeAddedEvent>

Returns:

The cloned step