- 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.PopContainingPopContaining.PopInstruction
 - 
Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.ScopingScoping.KeyNotFoundException, Scoping.Variable
 
- 
 - 
Field SummaryFields Modifier and Type Field Description protected ObjectelementIdprotected Objectlabelprotected Map<Object,List<Object>>propertiesprotected Set<String>scopeKeysprotected ParameterswithConfiguration- 
Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStepid, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild
 - 
Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.map.AddElementStepContractCONCRETE_STEPS
 
- 
 - 
Constructor SummaryConstructors Modifier Constructor Description protectedAbstractAddElementStepPlaceholder(Traversal.Admin traversal, String label)protectedAbstractAddElementStepPlaceholder(Traversal.Admin traversal, GValue<String> label)protectedAbstractAddElementStepPlaceholder(Traversal.Admin traversal, Traversal.Admin<S,String> labelTraversal)
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddProperty(Object key, Object value)protected voidaddTraversal(Traversal.Admin<?,?> traversal)AbstractAddElementStepPlaceholder<S,E,X>clone()Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.voidconfigure(Object... keyValues)Accept a configuration to theStep.protected voidconfigureConcreteStep(AddElementStepContract<S,E> step)protected abstract StringgetDefaultLabel()ObjectgetElementId()ObjectgetElementIdWithGValue()Collection<GValue<?>>getGValues()ObjectgetLabel()ObjectgetLabelWithGValue()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.ParametersgetParameters()Gets the parameters on the step.Map<Object,List<Object>>getProperties()Map<Object,List<Object>>getPropertiesWithGValues()Set<TraverserRequirement>getRequirements()Provide the necessaryTraverserRequirementthat 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 traversalinthashCode()booleanisParameterized()protected Emap(Traverser.Admin<S> traverser)booleanremoveElementId()booleanremoveProperty(Object k)voidsetElementId(Object elementId)voidsetLabel(Object label)voidsetTraversal(Traversal.Admin<?,?> parentTraversal)Set theTraversalthat this step is contained within.protected abstract booleansupportsMultiProperties()voidupdateVariable(String name, Object value)- 
Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStepprocessNextStart
 - 
Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStepaddLabel, 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.Objectfinalize, getClass, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.map.AddElementStepContractgetPopInstructions
 - 
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.GValueHolderasConcreteStep, reduce
 - 
Methods inherited from interface java.util.IteratorforEachRemaining, hasNext, next, remove
 - 
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.ScopinggetNullableScopeValue, getSafeScopeValue, getScopeValue
 - 
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.StepaddLabel, 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.TraversalParentaddGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild
 
- 
 
- 
- 
- 
Constructor Detail- 
AbstractAddElementStepPlaceholderprotected AbstractAddElementStepPlaceholder(Traversal.Admin traversal, String label) 
 - 
AbstractAddElementStepPlaceholderprotected AbstractAddElementStepPlaceholder(Traversal.Admin traversal, GValue<String> label) 
 - 
AbstractAddElementStepPlaceholderprotected AbstractAddElementStepPlaceholder(Traversal.Admin traversal, Traversal.Admin<S,String> labelTraversal) 
 
- 
 - 
Method Detail- 
getDefaultLabelprotected abstract String getDefaultLabel() 
 - 
getScopeKeyspublic Set<String> getScopeKeys() Description copied from interface:ScopingGet the labels that this scoping step will access during the traversal- Specified by:
- getScopeKeysin interface- Scoping
- Returns:
- the accessed labels of the scoping step
 
 - 
addTraversalprotected void addTraversal(Traversal.Admin<?,?> traversal) 
 - 
getLocalChildrenpublic List<Traversal.Admin<?,?>> getLocalChildren() Description copied from interface:TraversalParentGets 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. SeeLocalSteporByModulatingas examples.- Specified by:
- getLocalChildrenin interface- TraversalParent
 
 - 
setTraversalpublic void setTraversal(Traversal.Admin<?,?> parentTraversal) Description copied from interface:StepSet theTraversalthat this step is contained within.- Specified by:
- setTraversalin interface- Step<S,E extends Element>
- Overrides:
- setTraversalin class- AbstractStep<S,E extends Element>
- Parameters:
- parentTraversal- the new traversal for this step
 
 - 
getRequirementspublic Set<TraverserRequirement> getRequirements() Description copied from interface:StepProvide the necessaryTraverserRequirementthat must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.- Specified by:
- getRequirementsin interface- Step<S,E extends Element>
- Returns:
- the set of requirements
 
 - 
mapprotected E map(Traverser.Admin<S> traverser) - Specified by:
- mapin class- ScalarMapStep<S,E extends Element>
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- AbstractStep<S,E extends Element>
 
 - 
configureConcreteStepprotected void configureConcreteStep(AddElementStepContract<S,E> step) 
 - 
isParameterizedpublic boolean isParameterized() - Specified by:
- isParameterizedin interface- GValueHolder<S,E extends Element>
 
 - 
getLabelpublic Object getLabel() - Specified by:
- getLabelin interface- AddElementStepContract<S,E extends Element>
 
 - 
getLabelWithGValuepublic Object getLabelWithGValue() - Specified by:
- getLabelWithGValuein interface- AddElementStepContract<S,E extends Element>
 
 - 
setLabelpublic void setLabel(Object label) - Specified by:
- setLabelin interface- AddElementStepContract<S,E extends Element>
 
 - 
addPropertypublic void addProperty(Object key, Object value) - Specified by:
- addPropertyin interface- PropertiesHolder
 
 - 
supportsMultiPropertiesprotected abstract boolean supportsMultiProperties() 
 - 
getPropertiespublic Map<Object,List<Object>> getProperties() - Specified by:
- getPropertiesin interface- PropertiesHolder
 
 - 
getPropertiesWithGValuespublic Map<Object,List<Object>> getPropertiesWithGValues() - Specified by:
- getPropertiesWithGValuesin interface- PropertiesHolder
 
 - 
removePropertypublic boolean removeProperty(Object k) - Specified by:
- removePropertyin interface- PropertiesHolder
 
 - 
getElementIdpublic Object getElementId() - Specified by:
- getElementIdin interface- AddElementStepContract<S,E extends Element>
 
 - 
getElementIdWithGValuepublic Object getElementIdWithGValue() - Specified by:
- getElementIdWithGValuein interface- AddElementStepContract<S,E extends Element>
 
 - 
removeElementIdpublic boolean removeElementId() - Specified by:
- removeElementIdin interface- AddElementStepContract<S,E extends Element>
 
 - 
setElementIdpublic void setElementId(Object elementId) - Specified by:
- setElementIdin interface- AddElementStepContract<S,E extends Element>
 
 - 
updateVariablepublic void updateVariable(String name, Object value) - Specified by:
- updateVariablein interface- GValueHolder<S,E extends Element>
 
 - 
getGValuespublic Collection<GValue<?>> getGValues() - Specified by:
- getGValuesin interface- GValueHolder<S,E extends Element>
 
 - 
getMutatingCallbackRegistrypublic CallbackRegistry<X> getMutatingCallbackRegistry() Description copied from interface:MutatingGets the callback registry for events that the step raises.- Specified by:
- getMutatingCallbackRegistryin interface- Mutating<S>
 
 - 
clonepublic AbstractAddElementStepPlaceholder<S,E,X> clone() Description copied from interface:StepCloning 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.
 - 
getParameterspublic Parameters getParameters() Description copied from interface:ParameterizingGets the parameters on the step.- Specified by:
- getParametersin interface- Parameterizing
 
 - 
configurepublic void configure(Object... keyValues) Description copied from interface:ConfiguringAccept a configuration to theStep. Note that this interface extendsParameterizingand so there is an expectation that theStepimplementation will have aParametersinstance that will house any values passed to this method. Storing these configurations inParametersis 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:
- configurein interface- Configuring
 
 
- 
 
-