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

Class PropertyMapStep<E>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<Element,Map<String,E>>

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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<Map<String,E>>>, Step<Element,Map<String,E>>

public class PropertyMapStep<E>
extends MapStep<Element,Map<String,E>>

Author:

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

See Also:

Serialized Form

Field Summary

Fields

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

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 and Description
PropertyMapStep(Traversal.Admin traversal, boolean includeTokens, PropertyType propertyType, String... propertyKeys)

Method Summary

Modifier and Type	Method and Description
String[]	getPropertyKeys()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
PropertyType	getReturnType()
int	hashCode()
boolean	isIncludeTokens()
protected Map<String,E>	map(Traverser.Admin<Element> traverser)
String	toString()

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

processNextStart

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

addLabel, addStart, addStarts, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

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

equals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

propertyKeys

protected final String[] propertyKeys

returnType

protected final PropertyType returnType

includeTokens

protected final boolean includeTokens

Constructor Detail

PropertyMapStep

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

Method Detail

map

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

Specified by:

map in class MapStep<Element,Map<String,E>>

getReturnType

public PropertyType getReturnType()

getPropertyKeys

public String[] getPropertyKeys()

isIncludeTokens

public boolean isIncludeTokens()

toString

public String toString()

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

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.

Returns:

the set of requirements