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

Class LabelsStep<S 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<S,String>

org.apache.tinkerpop.gremlin.process.traversal.step.map.LabelsStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<String>>, Step<S,String>

public class LabelsStep<S extends Element>
extends FlatMapStep<S,String>

Maps an Element to its labels, emitting each label as a separate traverser. For vertices with multiple labels, each label is emitted individually. For edges, the single label is emitted.

Since:

4.0.0

See Also:

• Serialized Form

Field Summary

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
LabelsStep(Traversal.Admin traversal)

Method Summary

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

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, hashCode, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, setId, setNextStep, setPreviousStep, setTraversal, toString

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

Constructor Details

LabelsStep

public LabelsStep(Traversal.Admin traversal)

Method Details

flatMap

protected Iterator<String> flatMap(Traverser.Admin<S> traverser)

Specified by:

flatMap in class FlatMapStep<S extends Element,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.

Returns:

the set of requirements