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

Class ConjoinStep<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.ConjoinStep<S>

All Implemented Interfaces:

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

public final class ConjoinStep<S>
extends ScalarMapStep<S,String>
implements ListFunction

A map step that returns the result of joining every element in the traverser using the delimiter argument.

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
ConjoinStep(Traversal.Admin traversal, String delimiter)
ConjoinStep(Traversal.Admin traversal, GValue<String> delimiter)

Method Summary

Modifier and Type	Method	Description
ConjoinStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
String	getDelimiter()
GValue<String>	getDelimiterGValue()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	getStepName()	Template method used for retrieving the implementing Step's name.
int	hashCode()
protected String	map(Traverser.Admin<S> traverser)

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, 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.util.ListFunction

convertArgumentToCollection, convertArgumentToSet, convertTraversalToCollection, convertTraversalToSet, convertTraverserToCollection, convertTraverserToSet

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

equals

Constructor Details

ConjoinStep

public ConjoinStep(Traversal.Admin traversal,
 String delimiter)

ConjoinStep

public ConjoinStep(Traversal.Admin traversal,
 GValue<String> delimiter)

Method Details

getStepName

public String getStepName()

Description copied from interface: ListFunction

Template method used for retrieving the implementing Step's name.

Specified by:

getStepName in interface ListFunction

Returns:

this step's name.

map

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

Specified by:

map in class ScalarMapStep<S,String>

getDelimiter

public String getDelimiter()

getDelimiterGValue

public GValue<String> getDelimiterGValue()

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

clone

public ConjoinStep<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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,String>