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

Class SubstringGlobalStep<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.SubstringGlobalStep<S,E>

All Implemented Interfaces:

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

public final class SubstringGlobalStep<S,E>
extends ScalarMapStep<S,E>

Reference implementation for substring step, a mid-traversal step which returns a substring of the incoming string traverser with a 0-based start index (inclusive) and optionally an end index (exclusive). If the start index is negative then it will begin at the specified index counted from the end of the string, or 0 if exceeding the string length. Likewise, if the end index is negative then it will end at the specified index counted from the end of the string, or 0 if exceeding the string length. End index is optional, if it is not specified or if it exceeds the length of the string then all remaining characters will be returned. End index <= start index will return the empty string. Null values 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

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
SubstringGlobalStep(Traversal.Admin traversal, Integer startIndex)
SubstringGlobalStep(Traversal.Admin traversal, Integer startIndex, Integer endIndex)

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.
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

Constructor Detail

SubstringGlobalStep

public SubstringGlobalStep(Traversal.Admin traversal,
                           Integer startIndex,
                           Integer endIndex)

SubstringGlobalStep

public SubstringGlobalStep(Traversal.Admin traversal,
                           Integer startIndex)

Method Detail

map

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

Specified by:

map in class ScalarMapStep<S,E>

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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,E>