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

Class ConcatStep<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep<S,String>

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

All Implemented Interfaces:

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

public final class ConcatStep<S>
extends ScalarMapStep<S,String>
implements TraversalParent

Reference implementation for String concatenation step, a mid-traversal step which concatenates one or more String values together to the incoming String traverser. If the incoming traverser is a non-String value then an IllegalArgumentException will be thrown.

Author:

Yang Xia (http://github.com/xiazcy)

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, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors

Constructor	Description
ConcatStep(Traversal.Admin traversal, String... concatStrings)
ConcatStep(Traversal.Admin traversal, Traversal<?,String> concatTraversal, Traversal<?,String>... otherConcatTraversals)

Method Summary

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

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

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 Detail

ConcatStep

public ConcatStep(Traversal.Admin traversal,
                  String... concatStrings)

ConcatStep

public ConcatStep(Traversal.Admin traversal,
                  Traversal<?,String> concatTraversal,
                  Traversal<?,String>... otherConcatTraversals)

Method Detail

map

protected String map(Traverser.Admin<S> traverser)

Specified by:

map in class ScalarMapStep<S,String>

getConcatStrings

public List<String> getConcatStrings()

getStringArgsResult

public String getStringArgsResult()

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,String>

Returns:

the set of requirements

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,String>

Overrides:

setTraversal in class AbstractStep<S,String>

Parameters:

parentTraversal - the new traversal for this step

clone

public ConcatStep<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,String>

Overrides:

clone in class AbstractStep<S,String>

Returns:

The cloned step

getLocalChildren

public List<Traversal.Admin<S,String>> 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

toString

public String toString()

Overrides:

toString in class AbstractStep<S,String>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,String>