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

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

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

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<Vertex>>, Step<S,Vertex>, Configuring, AddElementStepContract<S,Vertex>, AddVertexStepContract<S>, Mutating<Event.VertexAddedEvent>, Parameterizing, PopContaining, PropertiesHolder, Scoping, TraversalParent, Writing<Event.VertexAddedEvent>

public class AddVertexStep<S>
extends ScalarMapStep<S,Vertex>
implements AddVertexStepContract<S>

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

PopContaining.PopInstruction

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

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

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
AddVertexStep(Traversal.Admin traversal, String label)
AddVertexStep(Traversal.Admin traversal, List<Traversal.Admin<?,?>> labelTraversals)	Constructor for multiple label traversals.
AddVertexStep(Traversal.Admin traversal, Set<String> labels)
AddVertexStep(Traversal.Admin traversal, Traversal.Admin<S,?> vertexLabelTraversal)

Method Summary

Modifier and Type	Method	Description
void	addProperty(Object key, Object value)
AddVertexStep<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 the Step.
Object	getElementId()
Object	getLabel()	Gets the label(s) assigned to the element produced by this step.
<S, E> List<Traversal.Admin<S,E>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
CallbackRegistry<Event.VertexAddedEvent>	getMutatingCallbackRegistry()	Gets the callback registry for events that the step raises.
Parameters	getParameters()	Gets the parameters on the step.
Map<Object,List<Object>>	getProperties()
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()	Get the labels that this scoping step will access during the traversal
int	hashCode()
boolean	hasUserProvidedLabel()
protected Vertex	map(Traverser.Admin<S> traverser)
boolean	removeElementId()
boolean	removeProperty(Object k)
void	setElementId(Object elementId)
void	setLabel(Object label)	Sets the label(s) to assign to the element produced by this step.
void	setTraversal(Traversal.Admin<?,?> parentTraversal)	Set the Traversal 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, clearLabels, 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.map.AddElementStepContract

getElementIdWithGValue, getLabelWithGValue, getPopInstructions

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

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

getPropertiesWithGValues

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

addLabel, addStart, addStarts, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep

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

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

Constructor Details

AddVertexStep

public AddVertexStep(Traversal.Admin traversal,
 String label)

AddVertexStep

public AddVertexStep(Traversal.Admin traversal,
 Traversal.Admin<S,?> vertexLabelTraversal)

AddVertexStep

public AddVertexStep(Traversal.Admin traversal,
 Set<String> labels)

AddVertexStep

public AddVertexStep(Traversal.Admin traversal,
 List<Traversal.Admin<?,?>> labelTraversals)

Constructor for multiple label traversals. Each traversal is resolved to a single String label at execution time.

Method Details

hasUserProvidedLabel

public boolean hasUserProvidedLabel()

Specified by:

hasUserProvidedLabel in interface AddVertexStepContract<S>

getElementId

public Object getElementId()

Specified by:

getElementId in interface AddElementStepContract<S,Vertex>

setElementId

public void setElementId(Object elementId)

Specified by:

setElementId in interface AddElementStepContract<S,Vertex>

getParameters

public Parameters getParameters()

Description copied from interface: Parameterizing

Gets the parameters on the step.

Specified by:

getParameters in interface Parameterizing

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 interface Scoping

Returns:

the accessed labels of the scoping step

getLocalChildren

public <S,
E> List<Traversal.Admin<S,E>> 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

configure

public void configure(Object... keyValues)

Description copied from interface: Configuring

Accept a configuration to the Step. Note that this interface extends Parameterizing and so there is an expectation that the Step implementation will have a Parameters instance that will house any values passed to this method. Storing these configurations in Parameters 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 interface Configuring

map

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

Specified by:

map in class ScalarMapStep<S,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<S>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,Vertex>

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

Returns:

the set of requirements

toString

public String toString()

Overrides:

toString in class AbstractStep<S,Vertex>

setTraversal

public void setTraversal(Traversal.Admin<?,?> parentTraversal)

Description copied from interface: Step

Set the Traversal that this step is contained within.

Specified by:

setTraversal in interface Step<S,Vertex>

Overrides:

setTraversal in class AbstractStep<S,Vertex>

Parameters:

parentTraversal - the new traversal for this step

clone

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

Overrides:

clone in class AbstractStep<S,Vertex>

Returns:

The cloned step

getLabel

public Object getLabel()

Description copied from interface: AddElementStepContract

Gets the label(s) assigned to the element produced by this step. Returns a single value, or a Set when multiple labels were specified (e.g. addV("a", "b")). Each individual label value will either be a String or Traversal depending on how it was initially set. Callers should not assume the type is String and should check with instanceof before casting.

Specified by:

getLabel in interface AddElementStepContract<S,Vertex>

Returns:

a String, Traversal, or a Set containing either

setLabel

public void setLabel(Object label)

Description copied from interface: AddElementStepContract

Sets the label(s) to assign to the element produced by this step. Accepts a single String, GValue<String>, or Traversal resolving to a String, or a Collection<Object> of two or more such values. Should behave identically to specifying the same value at construction time. Implementations may restrict calling this method more than once at their own discretion.

Specified by:

setLabel in interface AddElementStepContract<S,Vertex>

Parameters:

label - a String, GValue<String>, Traversal, or Collection<Object>

getProperties

public Map<Object,List<Object>> getProperties()

Specified by:

getProperties in interface PropertiesHolder

removeProperty

public boolean removeProperty(Object k)

Specified by:

removeProperty in interface PropertiesHolder

removeElementId

public boolean removeElementId()

Specified by:

removeElementId in interface AddElementStepContract<S,Vertex>

addProperty

public void addProperty(Object key,
 Object value)

Specified by:

addProperty in interface PropertiesHolder