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,E>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep<S,Edge>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.map.AddEdgeStep<S>
-
- All Implemented Interfaces:
Serializable
,AutoCloseable
,Cloneable
,Iterator<Traverser.Admin<Edge>>
,Step<S,Edge>
,Configuring
,FromToModulating
,Mutating<Event.EdgeAddedEvent>
,Parameterizing
,Scoping
,TraversalParent
,Writing<Event.EdgeAddedEvent>
public class AddEdgeStep<S> extends ScalarMapStep<S,Edge> implements Writing<Event.EdgeAddedEvent>, TraversalParent, Scoping, FromToModulating
- 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.KeyNotFoundException, Scoping.Variable
-
-
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 Description AddEdgeStep(Traversal.Admin traversal, String edgeLabel)
AddEdgeStep(Traversal.Admin traversal, Traversal.Admin<S,String> edgeLabelTraversal)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFrom(Traversal.Admin<?,?> fromObject)
void
addTo(Traversal.Admin<?,?> toObject)
AddEdgeStep<S>
clone()
Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.void
configure(Object... keyValues)
Accept a configuration to theStep
.<S,E>
List<Traversal.Admin<S,E>>getLocalChildren()
CallbackRegistry<Event.EdgeAddedEvent>
getMutatingCallbackRegistry()
Gets the callback registry for events that the step raises.Parameters
getParameters()
Gets the parameters on the step.Set<TraverserRequirement>
getRequirements()
Provide the necessaryTraverserRequirement
that must be met by the traverser in order for the step to function properly.Set<String>
getScopeKeys()
Get the labels that this scoping step will access during the traversalint
hashCode()
protected Edge
map(Traverser.Admin<S> traverser)
void
setTraversal(Traversal.Admin<?,?> parentTraversal)
Set theTraversal
that this step is contained within.String
toString()
-
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, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep
-
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.FromToModulating
addFrom, addTo
-
Methods inherited from interface java.util.Iterator
forEachRemaining, remove
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping
getNullableScopeValue, getSafeScopeValue, getScopeValue
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent
addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild
-
-
-
-
Constructor Detail
-
AddEdgeStep
public AddEdgeStep(Traversal.Admin traversal, String edgeLabel)
-
AddEdgeStep
public AddEdgeStep(Traversal.Admin traversal, Traversal.Admin<S,String> edgeLabelTraversal)
-
-
Method Detail
-
getLocalChildren
public <S,E> List<Traversal.Admin<S,E>> getLocalChildren()
- Specified by:
getLocalChildren
in interfaceTraversalParent
-
getParameters
public Parameters getParameters()
Description copied from interface:Parameterizing
Gets the parameters on the step.- Specified by:
getParameters
in interfaceParameterizing
-
getScopeKeys
public Set<String> getScopeKeys()
Description copied from interface:Scoping
Get the labels that this scoping step will access during the traversal- Specified by:
getScopeKeys
in interfaceScoping
- Returns:
- the accessed labels of the scoping step
-
configure
public void configure(Object... keyValues)
Description copied from interface:Configuring
Accept a configuration to theStep
. Note that this interface extendsParameterizing
and so there is an expectation that theStep
implementation will have aParameters
instance that will house any values passed to this method. Storing these configurations inParameters
is not a requirement however, IF the configuration is an expected option for the step and can be stored on a member field that can be accessed on the step by more direct means (i.e. like a getter method).- Specified by:
configure
in interfaceConfiguring
-
addTo
public void addTo(Traversal.Admin<?,?> toObject)
- Specified by:
addTo
in interfaceFromToModulating
-
addFrom
public void addFrom(Traversal.Admin<?,?> fromObject)
- Specified by:
addFrom
in interfaceFromToModulating
-
map
protected Edge map(Traverser.Admin<S> traverser)
- Specified by:
map
in classScalarMapStep<S,Edge>
-
getRequirements
public Set<TraverserRequirement> getRequirements()
Description copied from interface:Step
Provide the necessaryTraverserRequirement
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 interfaceStep<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 interfaceMutating<S>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractStep<S,Edge>
-
toString
public String toString()
- Overrides:
toString
in classAbstractStep<S,Edge>
-
setTraversal
public void setTraversal(Traversal.Admin<?,?> parentTraversal)
Description copied from interface:Step
Set theTraversal
that this step is contained within.- Specified by:
setTraversal
in interfaceStep<S,Edge>
- Overrides:
setTraversal
in classAbstractStep<S,Edge>
- Parameters:
parentTraversal
- the new traversal for this step
-
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 whenStep.reset()
is called. Moreover, the previous and next steps should be set toEmptyStep
.
-
-