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

Class VertexStep<E extends Element>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

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

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Parameters	parameters

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
VertexStep(Traversal.Admin traversal, Class<E> returnClass, Direction direction, String... edgeLabels)

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(Object... keyValues) Accept a configuration to the Step.
protected Iterator<E>	flatMap(Traverser.Admin<Vertex> traverser)
Direction	getDirection()
String[]	getEdgeLabels()
Parameters	getParameters() Gets the parameters on the step.
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
Class<E>	getReturnClass()
int	hashCode()
boolean	returnsEdge()
boolean	returnsVertex()
void	reverseDirection()
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, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, 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

parameters

protected Parameters parameters

Constructor Detail

VertexStep

public VertexStep(Traversal.Admin traversal,
                  Class<E> returnClass,
                  Direction direction,
                  String... edgeLabels)

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<Vertex> traverser)

Specified by:

flatMap in class FlatMapStep<Vertex,E extends Element>

getDirection

public Direction getDirection()

getEdgeLabels

public String[] getEdgeLabels()

getReturnClass

public Class<E> getReturnClass()

reverseDirection

public void reverseDirection()

returnsVertex

public boolean returnsVertex()

returnsEdge

public boolean returnsEdge()

toString

public String toString()

Overrides:

toString in class AbstractStep<Vertex,E extends Element>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<Vertex,E extends Element>

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<Vertex,E extends Element>

Returns:

the set of requirements

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception