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

Class SplitGlobalStep<S,E>

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

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

All Implemented Interfaces:

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

public final class SplitGlobalStep<S,E>
extends ScalarMapStep<S,E>
implements TraversalParent

Reference implementation for substring step, a mid-traversal step which returns a list of strings created by splitting the incoming string traverser around the matches of the given separator. A null separator will split the string by whitespaces. Null values from incoming traversers are not processed and remain as null when returned. If the incoming traverser is a non-String value then an IllegalArgumentException will be thrown.

Author:

David Bechberger (http://bechberger.com), 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
SplitGlobalStep(Traversal.Admin traversal, String separator)

Method Summary

Modifier and Type	Method	Description
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	getSeparator()
int	hashCode()
protected E	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, clone, 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.Step

equals

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

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

Constructor Details

SplitGlobalStep

public SplitGlobalStep(Traversal.Admin traversal,
 String separator)

Method Details

map

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

Specified by:

map in class ScalarMapStep<S,E>

getSeparator

public String getSeparator()

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

Returns:

the set of requirements

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,E>