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

Class AddLabelStep<S extends Element>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AddLabelStep<S>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, Mutating<Event.ElementLabelChangedEvent>, PopContaining, TraversalParent

public class AddLabelStep<S extends Element>
extends SideEffectStep<S>
implements Mutating<Event.ElementLabelChangedEvent>, TraversalParent

Side-effect step that adds labels to the current element by calling Element.addLabel(String, String...). Providers that support label mutation must override addLabel() in their Element implementations.

Since:

4.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PopContaining

PopContaining.PopInstruction

Field Summary

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

id, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
AddLabelStep(Traversal.Admin traversal, String label, String... moreLabels)
AddLabelStep(Traversal.Admin traversal, List<Traversal.Admin<S,?>> labelTraversals)	Constructor for one or more label traversals.

Method Summary

Modifier and Type	Method	Description
AddLabelStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
List<Traversal.Admin<S,?>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
CallbackRegistry<Event.ElementLabelChangedEvent>	getMutatingCallbackRegistry()	Gets the callback registry for events that the step raises.
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
int	hashCode()
void	setTraversal(Traversal.Admin<?,?> parentTraversal)	Set the Traversal that this step is contained within.
protected void	sideEffect(Traverser.Admin<S> traverser)
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep

processNextStart

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

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

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

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent

addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getPopInstructions, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild

Constructor Details

AddLabelStep

public AddLabelStep(Traversal.Admin traversal,
 String label,
 String... moreLabels)

AddLabelStep

public AddLabelStep(Traversal.Admin traversal,
 List<Traversal.Admin<S,?>> labelTraversals)

Constructor for one or more label traversals. If exactly one traversal is given and it produces a Collection, the collection is unfolded into the set of labels added; otherwise each traversal must resolve to a single String label.

Method Details

sideEffect

protected void sideEffect(Traverser.Admin<S> traverser)

Specified by:

sideEffect in class SideEffectStep<S extends Element>

getMutatingCallbackRegistry

public CallbackRegistry<Event.ElementLabelChangedEvent> getMutatingCallbackRegistry()

Description copied from interface: Mutating

Gets the callback registry for events that the step raises.

Specified by:

getMutatingCallbackRegistry in interface Mutating<S 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<S extends Element,S extends Element>

Returns:

the set of requirements

toString

public String toString()

Overrides:

toString in class AbstractStep<S extends Element,S extends Element>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S extends Element,S extends Element>

getLocalChildren

public List<Traversal.Admin<S,?>> getLocalChildren()

Description copied from interface: TraversalParent

Gets a list of all "local" child traversals for this step. A "local" traversal is one which is evaluated independently for each incoming traverser to the parent step. This is typically used in cases where the child is used to process or augment each traverser individually. See LocalStep or ByModulating as examples.

Specified by:

getLocalChildren in interface TraversalParent

clone

public AddLabelStep<S> clone()

Description copied from interface: Step

Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication. When cloning a step, it is important that the steps, the cloned step is equivalent to the state of the step when Step.reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<S extends Element,S extends Element>

Overrides:

clone in class AbstractStep<S extends Element,S extends Element>

Returns:

The cloned step

setTraversal

public void setTraversal(Traversal.Admin<?,?> parentTraversal)

Description copied from interface: Step

Set the Traversal that this step is contained within.

Specified by:

setTraversal in interface Step<S extends Element,S extends Element>

Overrides:

setTraversal in class AbstractStep<S extends Element,S extends Element>

Parameters:

parentTraversal - the new traversal for this step