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

Class PropertyMapStep<K,E>

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<Element,Map<K,E>>

org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<Map<K,E>>>, Step<Element,Map<K,E>>, ByModulating, Configuring, Parameterizing, PopContaining, TraversalParent

public class PropertyMapStep<K,E>
extends ScalarMapStep<Element,Map<K,E>>
implements TraversalParent, ByModulating, Configuring

Author:

Marko A. Rodriguez (http://markorodriguez.com), Daniel Kuppitz (http://gremlin.guru)

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 Parameters	parameters
protected final String[]	propertyKeys
protected Traversal.Admin<Element,? extends Property>	propertyTraversal
protected final PropertyType	returnType
protected int	tokens
protected Traversal.Admin<K,E>	valueTraversal

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
PropertyMapStep(Traversal.Admin traversal, int options, PropertyType propertyType, String... propertyKeys)
PropertyMapStep(Traversal.Admin traversal, PropertyType propertyType, String... propertyKeys)

Method Summary

Modifier and Type	Method	Description
protected void	addElementProperties(Traverser.Admin<Element> traverser, Map<Object,Object> map)
protected void	addIncludedOptions(Element element, Map<Object,Object> map)
protected void	applyTraversalRingToMap(Map<Object,Object> map)
PropertyMapStep<K,E>	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 Object	getElementId(Element element)
protected String	getElementLabel(Element element)
int	getIncludedTokens()
List<Traversal.Admin<K,E>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
Parameters	getParameters()	Gets the parameters on the step.
String[]	getPropertyKeys()
Traversal.Admin<Element,? extends Property>	getPropertyTraversal()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
PropertyType	getReturnType()
Traversal.Admin<K,E>	getValueTraversal()
protected String	getVertexPropertyKey(VertexProperty<?> vertexProperty)
protected Object	getVertexPropertyValue(VertexProperty<?> vertexProperty)
int	hashCode()
protected boolean	includeToken(int token)
protected Map<K,E>	map(Traverser.Admin<Element> traverser)
void	modulateBy(Traversal.Admin<?,?> selectTraversal)
void	setPropertyTraversal(Traversal.Admin<Element,? extends Property> propertyTraversal)
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.ByModulating

modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step

equals

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

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

Field Details

propertyKeys

protected final String[] propertyKeys

returnType

protected final PropertyType returnType

tokens

protected int tokens

propertyTraversal

protected Traversal.Admin<Element,? extends Property> propertyTraversal

parameters

protected Parameters parameters

valueTraversal

protected Traversal.Admin<K,E> valueTraversal

Constructor Details

PropertyMapStep

public PropertyMapStep(Traversal.Admin traversal,
 PropertyType propertyType,
 String... propertyKeys)

PropertyMapStep

public PropertyMapStep(Traversal.Admin traversal,
 int options,
 PropertyType propertyType,
 String... propertyKeys)

Method Details

map

protected Map<K,E> map(Traverser.Admin<Element> traverser)

Specified by:

map in class ScalarMapStep<Element,Map<K,E>>

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

getLocalChildren

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

modulateBy

public void modulateBy(Traversal.Admin<?,?> selectTraversal)

Specified by:

modulateBy in interface ByModulating

setPropertyTraversal

public void setPropertyTraversal(Traversal.Admin<Element,? extends Property> propertyTraversal)

getReturnType

public PropertyType getReturnType()

getPropertyKeys

public String[] getPropertyKeys()

getPropertyTraversal

public Traversal.Admin<Element,? extends Property> getPropertyTraversal()

toString

public String toString()

Overrides:

toString in class AbstractStep<Element,Map<K,E>>

clone

public PropertyMapStep<K,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<K,E>

Overrides:

clone in class AbstractStep<Element,Map<K,E>>

Returns:

The cloned step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<Element,Map<K,E>>

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

Overrides:

setTraversal in class AbstractStep<Element,Map<K,E>>

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

Returns:

the set of requirements

getIncludedTokens

public int getIncludedTokens()

includeToken

protected boolean includeToken(int token)

addIncludedOptions

protected void addIncludedOptions(Element element,
 Map<Object,Object> map)

getElementId

protected Object getElementId(Element element)

getElementLabel

protected String getElementLabel(Element element)

getVertexPropertyKey

protected String getVertexPropertyKey(VertexProperty<?> vertexProperty)

getVertexPropertyValue

protected Object getVertexPropertyValue(VertexProperty<?> vertexProperty)

addElementProperties

protected void addElementProperties(Traverser.Admin<Element> traverser,
 Map<Object,Object> map)

applyTraversalRingToMap

protected void applyTraversalRingToMap(Map<Object,Object> map)

getValueTraversal

public Traversal.Admin<K,E> getValueTraversal()