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

Class AddVertexStartStep

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<Vertex>>, Parameterizing, Step<Vertex,Vertex>, Mutating<Event.VertexAddedEvent>, TraversalParent

public final class AddVertexStartStep
extends AbstractStep<Vertex,Vertex>
implements Mutating<Event.VertexAddedEvent>, 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
AddVertexStartStep(Traversal.Admin traversal, String label)

Method Summary

Modifier and Type	Method and Description
void	addPropertyMutations(Object... keyValues)
AddVertexStartStep	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.VertexAddedEvent>	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 Traverser.Admin<Vertex>	processNextStart()
void	reset() Reset the state of the step such that it has no incoming starts.
String	toString()

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

AddVertexStartStep

public AddVertexStartStep(Traversal.Admin traversal,
                          String label)

Method Detail

getParameters

public Parameters getParameters()

Specified by:

getParameters in interface Parameterizing

getLocalChildren

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

Specified by:

getLocalChildren in interface TraversalParent

addPropertyMutations

public void addPropertyMutations(Object... keyValues)

Specified by:

addPropertyMutations in interface Mutating<Event.VertexAddedEvent>

processNextStart

protected Traverser.Admin<Vertex> processNextStart()

Specified by:

processNextStart in class AbstractStep<Vertex,Vertex>

getMutatingCallbackRegistry

public CallbackRegistry<Event.VertexAddedEvent> getMutatingCallbackRegistry()

Description copied from interface: Mutating

Gets the callback registry for events that the step raises.

Specified by:

getMutatingCallbackRegistry in interface Mutating<Event.VertexAddedEvent>

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

Returns:

the set of requirements

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<Vertex,Vertex>

reset

public void reset()

Description copied from interface: Step

Reset the state of the step such that it has no incoming starts. Internal states are to be reset, but any sideEffect data structures are not to be recreated.

Specified by:

reset in interface Step<Vertex,Vertex>

Overrides:

reset in class AbstractStep<Vertex,Vertex>

toString

public String toString()

Overrides:

toString in class AbstractStep<Vertex,Vertex>

clone

public AddVertexStartStep 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<Vertex,Vertex>

Overrides:

clone in class AbstractStep<Vertex,Vertex>

Returns:

The cloned step