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

Class AbstractAddElementStepPlaceholder<S,E extends Element,X extends Event>

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.AbstractAddElementStepPlaceholder<S,E,X>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<E>>, Step<S,E>, Configuring, GValueHolder<S,E>, AddElementStepContract<S,E>, Mutating<X>, Parameterizing, PopContaining, PropertiesHolder, Scoping, TraversalParent, Writing<X>

Direct Known Subclasses:

AbstractAddEdgeStepPlaceholder, AbstractAddVertexStepPlaceholder

public abstract class AbstractAddElementStepPlaceholder<S,E extends Element,X extends Event>
extends ScalarMapStep<S,E>
implements AddElementStepContract<S,E>, GValueHolder<S,E>, Writing<X>

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

Modifier and Type	Field	Description
protected Object	elementId
protected Object	label
protected Map<Object,List<Object>>	properties
protected Set<String>	scopeKeys
protected Parameters	withConfiguration

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

CONCRETE_STEPS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAddElementStepPlaceholder(Traversal.Admin traversal, String label)
protected	AbstractAddElementStepPlaceholder(Traversal.Admin traversal, Collection<Object> labels)	Constructor for multiple labels, each of which may be a String, a GValue, or a Traversal.Admin that resolves to a single String label at execution time.
protected	AbstractAddElementStepPlaceholder(Traversal.Admin traversal, GValue<String> label)
protected	AbstractAddElementStepPlaceholder(Traversal.Admin traversal, Traversal.Admin<S,?> labelTraversal)

Method Summary

Modifier and Type	Method	Description
void	addProperty(Object key, Object value)
protected void	addTraversal(Traversal.Admin<?,?> traversal)
AbstractAddElementStepPlaceholder<S,E,X>	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.
protected void	configureConcreteStep(AddElementStepContract<S,E> step)
boolean	equals(Object o)
protected abstract String	getDefaultLabel()
Object	getElementId()
Object	getElementIdWithGValue()
Collection<GValue<?>>	getGValues()
Object	getLabel()	Gets the label(s) assigned to the element produced by this step.
Object	getLabelWithGValue()
List<Traversal.Admin<?,?>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
CallbackRegistry<X>	getMutatingCallbackRegistry()	Gets the callback registry for events that the step raises.
Parameters	getParameters()	Gets the parameters on the step.
Map<Object,List<Object>>	getProperties()
Map<Object,List<Object>>	getPropertiesWithGValues()
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	isParameterized()
protected E	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.
protected abstract boolean	supportsMultiProperties()
void	updateVariable(String name, Object value)

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, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, 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.map.AddElementStepContract

getPopInstructions

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

asConcreteStep, reduce

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, 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

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

Field Details

label

protected Object label

properties

protected Map<Object,List<Object>> properties

elementId

protected Object elementId

scopeKeys

protected Set<String> scopeKeys

withConfiguration

protected Parameters withConfiguration

Constructor Details

AbstractAddElementStepPlaceholder

protected AbstractAddElementStepPlaceholder(Traversal.Admin traversal,
 String label)

AbstractAddElementStepPlaceholder

protected AbstractAddElementStepPlaceholder(Traversal.Admin traversal,
 GValue<String> label)

AbstractAddElementStepPlaceholder

protected AbstractAddElementStepPlaceholder(Traversal.Admin traversal,
 Traversal.Admin<S,?> labelTraversal)

AbstractAddElementStepPlaceholder

protected AbstractAddElementStepPlaceholder(Traversal.Admin traversal,
 Collection<Object> labels)

Constructor for multiple labels, each of which may be a String, a GValue, or a Traversal.Admin that resolves to a single String label at execution time.

Parameters:

traversal - the parent traversal

labels - the labels to add (must have 2+ elements; null or empty results in the default label)

Method Details

getDefaultLabel

protected abstract String getDefaultLabel()

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

addTraversal

protected void addTraversal(Traversal.Admin<?,?> traversal)

getLocalChildren

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

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,E extends Element>

Overrides:

setTraversal in class AbstractStep<S,E extends Element>

Parameters:

parentTraversal - the new traversal for this step

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,E extends Element>

Returns:

the set of requirements

map

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

Specified by:

map in class ScalarMapStep<S,E extends Element>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractStep<S,E extends Element>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,E extends Element>

configureConcreteStep

protected void configureConcreteStep(AddElementStepContract<S,E> step)

isParameterized

public boolean isParameterized()

Specified by:

isParameterized in interface GValueHolder<S,E extends Element>

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,E extends Element>

Returns:

a String, Traversal, or a Set containing either

getLabelWithGValue

public Object getLabelWithGValue()

Specified by:

getLabelWithGValue in interface AddElementStepContract<S,E extends Element>

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,E extends Element>

Parameters:

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

addProperty

public void addProperty(Object key,
 Object value)

Specified by:

addProperty in interface PropertiesHolder

supportsMultiProperties

protected abstract boolean supportsMultiProperties()

getProperties

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

Specified by:

getProperties in interface PropertiesHolder

getPropertiesWithGValues

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

Specified by:

getPropertiesWithGValues in interface PropertiesHolder

removeProperty

public boolean removeProperty(Object k)

Specified by:

removeProperty in interface PropertiesHolder

getElementId

public Object getElementId()

Specified by:

getElementId in interface AddElementStepContract<S,E extends Element>

getElementIdWithGValue

public Object getElementIdWithGValue()

Specified by:

getElementIdWithGValue in interface AddElementStepContract<S,E extends Element>

removeElementId

public boolean removeElementId()

Specified by:

removeElementId in interface AddElementStepContract<S,E extends Element>

setElementId

public void setElementId(Object elementId)

Specified by:

setElementId in interface AddElementStepContract<S,E extends Element>

updateVariable

public void updateVariable(String name,
 Object value)

Specified by:

updateVariable in interface GValueHolder<S,E extends Element>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S,E extends Element>

getMutatingCallbackRegistry

public CallbackRegistry<X> getMutatingCallbackRegistry()

Description copied from interface: Mutating

Gets the callback registry for events that the step raises.

Specified by:

getMutatingCallbackRegistry in interface Mutating<S>

clone

public AbstractAddElementStepPlaceholder<S,E,X> 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,E extends Element>

Overrides:

clone in class AbstractStep<S,E extends Element>

Returns:

The cloned step

getParameters

public Parameters getParameters()

Description copied from interface: Parameterizing

Gets the parameters on the step.

Specified by:

getParameters in interface Parameterizing

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