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

Class PropertiesStep<E>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.FlatMapStep<Element,E>

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

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<E>>, Step<Element,E>, Configuring, Parameterizing

public class PropertiesStep<E>
extends FlatMapStep<Element,E>
implements AutoCloseable, Configuring

Author:

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

See Also:

Serialized Form

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
void	close()
void	configure(Object... keyValues)	Accept a configuration to the Step.
protected Iterator<E>	flatMap(Traverser.Admin<Element> traverser)
Parameters	getParameters()	Gets the parameters on the step.
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()
String	toString()

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

closeIterator, processNextStart, reset

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

addLabel, addStart, addStarts, clearLabels, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, setId, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

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

equals

Field Detail

parameters

protected Parameters parameters

propertyKeys

protected final String[] propertyKeys

returnType

protected final PropertyType returnType

Constructor Detail

PropertiesStep

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

Method Detail

getParameters

public Parameters getParameters()

Description copied from interface: Parameterizing

Gets the parameters on the step.

Specified by:

getParameters in interface Parameterizing

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

flatMap

protected Iterator<E> flatMap(Traverser.Admin<Element> traverser)

Specified by:

flatMap in class FlatMapStep<Element,E>

getReturnType

public PropertyType getReturnType()

getPropertyKeys

public String[] getPropertyKeys()

toString

public String toString()

Overrides:

toString in class AbstractStep<Element,E>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<Element,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.

Specified by:

getRequirements in interface Step<Element,E>

Returns:

the set of requirements

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception