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

Class AddPropertyStepPlaceholder<S extends Element>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AddPropertyStepPlaceholder<S>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, Configuring, Deleting<Event.ElementPropertyChangedEvent>, GValueHolder<S,S>, Mutating<Event.ElementPropertyChangedEvent>, Parameterizing, PopContaining, PropertiesHolder, Scoping, AddPropertyStepContract<S>, TraversalParent, Writing<Event.ElementPropertyChangedEvent>

public class AddPropertyStepPlaceholder<S extends Element>
extends SideEffectStep<S>
implements AddPropertyStepContract<S>, GValueHolder<S,S>

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.sideEffect.AddPropertyStepContract

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
AddPropertyStepPlaceholder(Traversal.Admin traversal, VertexProperty.Cardinality cardinality, Object keyObject, Object valueObject)

Method Summary

Modifier and Type	Method	Description
void	addProperty(Object key, Object value)
AddPropertyStep<S>	asConcreteStep()
AddPropertyStepPlaceholder<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.
VertexProperty.Cardinality	getCardinality()
Collection<GValue<?>>	getGValues()
Object	getKey()	Get the property key
List<Traversal.Admin<?,?>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
CallbackRegistry<Event.ElementPropertyChangedEvent>	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
Object	getValue()	Gets the property value.
Object	getValueWithGValue()	Get the value as-is, without unboxing GValues if present, and without pinning the variable
int	hashCode()
boolean	isParameterized()
boolean	removeProperty(Object k)
void	setTraversal(Traversal.Admin<?,?> parentTraversal)	Set the Traversal that this step is contained within.
protected void	sideEffect(Traverser.Admin<S> traverser)
void	updateVariable(String name, Object value)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep

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, 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.sideEffect.AddPropertyStepContract

getPopInstructions

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

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

Constructor Detail

AddPropertyStepPlaceholder

public AddPropertyStepPlaceholder(Traversal.Admin traversal,
                                  VertexProperty.Cardinality cardinality,
                                  Object keyObject,
                                  Object valueObject)

Method Detail

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

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

Returns:

the set of requirements

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

Overrides:

setTraversal in class AbstractStep<S extends Element,S extends Element>

Parameters:

parentTraversal - the new traversal for this step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S extends Element,S extends Element>

sideEffect

protected void sideEffect(Traverser.Admin<S> traverser)

Specified by:

sideEffect in class SideEffectStep<S extends Element>

getCardinality

public VertexProperty.Cardinality getCardinality()

Specified by:

getCardinality in interface AddPropertyStepContract<S extends Element>

getKey

public Object getKey()

Description copied from interface: AddPropertyStepContract

Get the property key

Specified by:

getKey in interface AddPropertyStepContract<S extends Element>

getValue

public Object getValue()

Description copied from interface: AddPropertyStepContract

Gets the property value. If the value was originally passed as a GValue, the variable will become pinned and the literal value returned.

Specified by:

getValue in interface AddPropertyStepContract<S extends Element>

getValueWithGValue

public Object getValueWithGValue()

Get the value as-is, without unboxing GValues if present, and without pinning the variable

Specified by:

getValueWithGValue in interface AddPropertyStepContract<S extends Element>

clone

public AddPropertyStepPlaceholder<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 extends Element,S extends Element>

Overrides:

clone in class AbstractStep<S extends Element,S extends Element>

Returns:

The cloned step

asConcreteStep

public AddPropertyStep<S> asConcreteStep()

Specified by:

asConcreteStep in interface GValueHolder<S extends Element,S extends Element>

isParameterized

public boolean isParameterized()

Specified by:

isParameterized in interface GValueHolder<S extends Element,S extends Element>

updateVariable

public void updateVariable(String name,
                           Object value)

Specified by:

updateVariable in interface GValueHolder<S extends Element,S extends Element>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S extends Element,S extends Element>

addProperty

public void addProperty(Object key,
                        Object value)

Specified by:

addProperty in interface PropertiesHolder

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

getMutatingCallbackRegistry

public CallbackRegistry<Event.ElementPropertyChangedEvent> getMutatingCallbackRegistry()

Description copied from interface: Mutating

Gets the callback registry for events that the step raises.

Specified by:

getMutatingCallbackRegistry in interface Mutating<S extends Element>

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

getParameters

public Parameters getParameters()

Description copied from interface: Parameterizing

Gets the parameters on the step.

Specified by:

getParameters in interface Parameterizing