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

Class AddEdgeStep<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,Edge>

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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<Edge>>, Parameterizing, Step<S,Edge>, Mutating<Event.EdgeAddedEvent>, TraversalParent

public final class AddEdgeStep<S>
extends MapStep<S,Edge>
implements Mutating<Event.EdgeAddedEvent>, TraversalParent, Parameterizing

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

See Also:

Serialized Form

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
AddEdgeStep(Traversal.Admin traversal, String edgeLabel)

Method Summary

Modifier and Type	Method and Description
void	addFrom(Object fromObject)
void	addPropertyMutations(Object... keyValues)
void	addTo(Object toObject)
AddEdgeStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
<S,E> List<Traversal.Admin<S,E>>	getLocalChildren()
CallbackRegistry<Event.EdgeAddedEvent>	getMutatingCallbackRegistry() Gets the callback registry for events that the step raises.
Parameters	getParameters()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
int	hashCode()
protected Edge	map(Traverser.Admin<S> traverser)
String	toString()

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

processNextStart

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

addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

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

addGlobalChild, addLocalChild, asStep, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild

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

equals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

AddEdgeStep

public AddEdgeStep(Traversal.Admin traversal,
                   String edgeLabel)

Method Detail

getLocalChildren

public <S,E> List<Traversal.Admin<S,E>> getLocalChildren()

Specified by:

getLocalChildren in interface TraversalParent

getParameters

public Parameters getParameters()

Specified by:

getParameters in interface Parameterizing

addPropertyMutations

public void addPropertyMutations(Object... keyValues)

Specified by:

addPropertyMutations in interface Mutating<Event.EdgeAddedEvent>

addTo

public void addTo(Object toObject)

addFrom

public void addFrom(Object fromObject)

map

protected Edge map(Traverser.Admin<S> traverser)

Specified by:

map in class MapStep<S,Edge>

getRequirements

public Set<TraverserRequirement> getRequirements()

Description copied from interface: Step

Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.

Specified by:

getRequirements in interface Step<S,Edge>

Returns:

the set of requirements

getMutatingCallbackRegistry

public CallbackRegistry<Event.EdgeAddedEvent> getMutatingCallbackRegistry()

Description copied from interface: Mutating

Gets the callback registry for events that the step raises.

Specified by:

getMutatingCallbackRegistry in interface Mutating<Event.EdgeAddedEvent>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,Edge>

toString

public String toString()

Overrides:

toString in class AbstractStep<S,Edge>

clone

public AddEdgeStep<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 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 AbstractStep<S,Edge>

Returns:

The cloned step