com.tinkerpop.gremlin.process.graph.step.map

Class PropertyMapStep<E>

java.lang.Object

com.tinkerpop.gremlin.process.util.AbstractStep<S,E>

com.tinkerpop.gremlin.process.graph.step.map.MapStep<Element,java.util.Map<java.lang.String,E>>

com.tinkerpop.gremlin.process.graph.step.map.PropertyMapStep<E>

All Implemented Interfaces:

Step<Element,java.util.Map<java.lang.String,E>>, java.lang.Cloneable, java.util.Iterator<Traverser<java.util.Map<java.lang.String,E>>>

public class PropertyMapStep<E>
extends MapStep<Element,java.util.Map<java.lang.String,E>>

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	includeTokens
protected java.lang.String[]	propertyKeys
protected PropertyType	returnType

Fields inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

id, label, nextEnd, nextStep, previousStep, PROFILING_ENABLED, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
PropertyMapStep(Traversal traversal, boolean includeTokens, PropertyType propertyType, java.lang.String... propertyKeys)

Method Summary

Modifier and Type	Method and Description
java.util.Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
PropertyType	getReturnType()
java.lang.String	toString()

Methods inherited from class com.tinkerpop.gremlin.process.graph.step.map.MapStep

processNextStart, setFunction

Methods inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

addStart, addStarts, clone, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, reset, setId, setLabel, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

propertyKeys

protected final java.lang.String[] propertyKeys

returnType

protected final PropertyType returnType

includeTokens

protected final boolean includeTokens

Constructor Detail

PropertyMapStep

public PropertyMapStep(Traversal traversal,
                       boolean includeTokens,
                       PropertyType propertyType,
                       java.lang.String... propertyKeys)

Method Detail

getReturnType

public PropertyType getReturnType()

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<Element,java.util.Map<java.lang.String,E>>

getRequirements

public java.util.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<Element,java.util.Map<java.lang.String,E>>

Overrides:

getRequirements in class MapStep<Element,java.util.Map<java.lang.String,E>>

Returns:

the set of requirements