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.FlatMapStep<S,Edge>

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

All Implemented Interfaces:

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

public final class AddEdgeStep<S>
extends FlatMapStep<S,Edge>
implements Scoping, Mutating<Event.EdgeAddedEvent>

Author:

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

See Also:

Serialized Form

Nested Class Summary

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

Scoping.Variable

Field Summary

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

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

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

TYPICAL_GLOBAL_REQUIREMENTS, TYPICAL_GLOBAL_REQUIREMENTS_ARRAY, TYPICAL_LOCAL_REQUIREMENTS, TYPICAL_LOCAL_REQUIREMENTS_ARRAY

Constructor Summary

Constructors

Constructor and Description
AddEdgeStep(Traversal.Admin traversal, Direction direction, String firstVertexKey, String edgeLabel, String secondVertexKey, Object... propertyKeyValues)

Method Summary

Modifier and Type	Method and Description
protected Iterator<Edge>	flatMap(Traverser.Admin<S> traverser)
Direction	getDirection()
String	getEdgeLabel()
String	getFirstVertexKey()
CallbackRegistry<Event.EdgeAddedEvent>	getMutatingCallbackRegistry() Gets the callback registry for events that the step raises.
Object[]	getPropertyKeyValues()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
Set<String>	getScopeKeys()
String	getSecondVertexKey()
int	hashCode()

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

processNextStart, reset

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

addLabel, addStart, addStarts, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, setId, setNextStep, setPreviousStep, setTraversal, 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.Scoping

getNullableScopeValue, getScopeValue

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,
                   Direction direction,
                   String firstVertexKey,
                   String edgeLabel,
                   String secondVertexKey,
                   Object... propertyKeyValues)

Method Detail

getDirection

public Direction getDirection()

getFirstVertexKey

public String getFirstVertexKey()

getEdgeLabel

public String getEdgeLabel()

getSecondVertexKey

public String getSecondVertexKey()

getPropertyKeyValues

public Object[] getPropertyKeyValues()

flatMap

protected Iterator<Edge> flatMap(Traverser.Admin<S> traverser)

Specified by:

flatMap in class FlatMapStep<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>

getScopeKeys

public Set<String> getScopeKeys()

Specified by:

getScopeKeys in interface Scoping