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

Class AbstractMergeElementStepPlaceholder<S,E>

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<E>>, Step<S,E>, Deleting<Event>, GValueHolder<S,E>, MergeStepContract<S,E,Map>, Mutating<Event>, PopContaining, PropertiesHolder, TraversalOptionParent<Merge,S,Map>, TraversalParent, Writing<Event>

Direct Known Subclasses:

MergeEdgeStepPlaceholder, MergeVertexStepPlaceholder

public abstract class AbstractMergeElementStepPlaceholder<S,E>
extends FlatMapStep<S,E>
implements MergeStepContract<S,E,Map>, GValueHolder<S,E>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PopContaining

PopContaining.PopInstruction

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isStart
protected Traversal.Admin<?,Map<Object,Object>>	mergeTraversal
protected Traversal.Admin<?,Map<Object,Object>>	onCreateTraversal
protected Traversal.Admin<?,Map<Object,Object>>	onMatchTraversal
protected Map<Object,List<Object>>	properties

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

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
AbstractMergeElementStepPlaceholder(Traversal.Admin traversal, Traversal.Admin<?,Map<Object,Object>> mergeTraversal, boolean isStart)

Method Summary

Modifier and Type	Method	Description
void	addProperty(Object key, Object value)	This implementation should only be used as a mechanism for supporting PartitionStrategy.
AbstractMergeElementStepPlaceholder<S,E>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
boolean	equals(Object o)
protected Iterator<E>	flatMap(Traverser.Admin<S> traverser)
Collection<GValue<?>>	getGValues()
List<Traversal.Admin<?,?>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
Object	getMergeMapWithGValue()	Gets the merge map from this step.
Traversal.Admin	getMergeTraversal()
CallbackRegistry<Event>	getMutatingCallbackRegistry()	Gets the callback registry for events that the step raises.
Object	getOnCreateMapWithGValue()	Gets the onCreate map from this step.
Traversal.Admin	getOnCreateTraversal()
Object	getOnMatchMapWithGValue()	Gets the onMatch map from this step.
Traversal.Admin	getOnMatchTraversal()
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.
int	hashCode()
boolean	isFirst()
boolean	isParameterized()
boolean	isStart()
boolean	isUsingPartitionStrategy()
boolean	removeProperty(Object k)
void	setMerge(Traversal.Admin<?,Map<Object,Object>> mergeTraversal)
void	setOnCreate(Traversal.Admin<?,Map<Object,Object>> onCreateTraversal)
void	setOnMatch(Traversal.Admin<?,Map<Object,Object>> onMatchTraversal)
void	setTraversal(Traversal.Admin<?,?> parentTraversal)	Set the Traversal that this step is contained within.
void	updateVariable(String name, Object value)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.FlatMapStep

closeIterator, processNextStart, reset

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, 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.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.map.MergeStepContract

reset

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

addChildOption

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

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

Field Detail

isStart

protected final boolean isStart

properties

protected Map<Object,List<Object>> properties

mergeTraversal

protected Traversal.Admin<?,Map<Object,Object>> mergeTraversal

onCreateTraversal

protected Traversal.Admin<?,Map<Object,Object>> onCreateTraversal

onMatchTraversal

protected Traversal.Admin<?,Map<Object,Object>> onMatchTraversal

Constructor Detail

AbstractMergeElementStepPlaceholder

public AbstractMergeElementStepPlaceholder(Traversal.Admin traversal,
                                           Traversal.Admin<?,Map<Object,Object>> mergeTraversal,
                                           boolean isStart)

Method Detail

flatMap

protected Iterator<E> flatMap(Traverser.Admin<S> traverser)

Specified by:

flatMap in class FlatMapStep<S,E>

clone

public AbstractMergeElementStepPlaceholder<S,E> 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>

Overrides:

clone in class AbstractStep<S,E>

Returns:

The cloned 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 MergeStepContract<S,E,Map>

Specified by:

getRequirements in interface Step<S,E>

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

Overrides:

setTraversal in class AbstractStep<S,E>

Parameters:

parentTraversal - the new traversal for this 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

getMergeTraversal

public Traversal.Admin getMergeTraversal()

Specified by:

getMergeTraversal in interface MergeStepContract<S,E,Map>

getMergeMapWithGValue

public Object getMergeMapWithGValue()

Description copied from interface: MergeStepContract

Gets the merge map from this step. If the map was originally passed as a GValue, that is returned directly. If it was originally passed as a Map or ConstantTraversal, then a Map is returned. Otherwise, the MergeMap is returned in Traversal form.

Specified by:

getMergeMapWithGValue in interface MergeStepContract<S,E,Map>

getOnCreateTraversal

public Traversal.Admin getOnCreateTraversal()

Specified by:

getOnCreateTraversal in interface MergeStepContract<S,E,Map>

getOnCreateMapWithGValue

public Object getOnCreateMapWithGValue()

Description copied from interface: MergeStepContract

Gets the onCreate map from this step. If the map was originally passed as a GValue, that is returned directly. If it was originally passed as a Map or ConstantTraversal, then a Map is returned. Otherwise, the onCreate is returned in Traversal form.

Specified by:

getOnCreateMapWithGValue in interface MergeStepContract<S,E,Map>

getOnMatchTraversal

public Traversal.Admin getOnMatchTraversal()

Specified by:

getOnMatchTraversal in interface MergeStepContract<S,E,Map>

getOnMatchMapWithGValue

public Object getOnMatchMapWithGValue()

Description copied from interface: MergeStepContract

Gets the onMatch map from this step. If the map was originally passed as a GValue, that is returned directly. If it was originally passed as a Map or ConstantTraversal, then a Map is returned. Otherwise, the onMatch is returned in Traversal form.

Specified by:

getOnMatchMapWithGValue in interface MergeStepContract<S,E,Map>

isStart

public boolean isStart()

Specified by:

isStart in interface MergeStepContract<S,E,Map>

isFirst

public boolean isFirst()

Specified by:

isFirst in interface MergeStepContract<S,E,Map>

isUsingPartitionStrategy

public boolean isUsingPartitionStrategy()

Specified by:

isUsingPartitionStrategy in interface MergeStepContract<S,E,Map>

setOnMatch

public void setOnMatch(Traversal.Admin<?,Map<Object,Object>> onMatchTraversal)

Specified by:

setOnMatch in interface MergeStepContract<S,E,Map>

setOnCreate

public void setOnCreate(Traversal.Admin<?,Map<Object,Object>> onCreateTraversal)

Specified by:

setOnCreate in interface MergeStepContract<S,E,Map>

setMerge

public void setMerge(Traversal.Admin<?,Map<Object,Object>> mergeTraversal)

Specified by:

setMerge in interface MergeStepContract<S,E,Map>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractStep<S,E>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,E>

isParameterized

public boolean isParameterized()

Specified by:

isParameterized in interface GValueHolder<S,E>

updateVariable

public void updateVariable(String name,
                           Object value)

Specified by:

updateVariable in interface GValueHolder<S,E>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S,E>

getMutatingCallbackRegistry

public CallbackRegistry<Event> getMutatingCallbackRegistry()

Description copied from interface: Mutating

Gets the callback registry for events that the step raises.

Specified by:

getMutatingCallbackRegistry in interface Mutating<S>

addProperty

public void addProperty(Object key,
                        Object value)

This implementation should only be used as a mechanism for supporting PartitionStrategy.

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