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

Class PropertiesStep<E>

java.lang.Object

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

com.tinkerpop.gremlin.process.graph.step.map.FlatMapStep<Element,E>

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

All Implemented Interfaces:

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

public class PropertiesStep<E>
extends FlatMapStep<Element,E>
implements Reversible

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
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
PropertiesStep(Traversal traversal, PropertyType propertyType, java.lang.String... propertyKeys)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getPropertyKeys()
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()
void	reverse()
java.lang.String	toString()

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

processNextStart, reset, setFunction

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

addStart, addStarts, clone, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, 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

Constructor Detail

PropertiesStep

public PropertiesStep(Traversal traversal,
                      PropertyType propertyType,
                      java.lang.String... propertyKeys)

Method Detail

getReturnType

public PropertyType getReturnType()

getPropertyKeys

public java.lang.String[] getPropertyKeys()

reverse

public void reverse()

Specified by:

reverse in interface Reversible

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<Element,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,E>

Returns:

the set of requirements