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

Class KeyStep

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<Property,String>

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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<String>>, Step<Property,String>

public final class KeyStep
extends MapStep<Property,String>

Author:

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

See Also:

Serialized Form

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
KeyStep(Traversal.Admin traversal)

Method Summary

Modifier and Type	Method and Description
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
protected String	map(Traverser.Admin<Property> traverser)

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

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

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

Constructor Detail

KeyStep

public KeyStep(Traversal.Admin traversal)

Method Detail

map

protected String map(Traverser.Admin<Property> traverser)

Specified by:

map in class MapStep<Property,String>

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<Property,String>

Overrides:

getRequirements in class MapStep<Property,String>

Returns:

the set of requirements