Class SubstringLocalStep<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.util.StringLocalStep<S,E>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.map.SubstringLocalStep<S,E>
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterator<Traverser.Admin<E>>
,Step<S,E>
public final class SubstringLocalStep<S,E> extends StringLocalStep<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 anIllegalArgumentException
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 SubstringLocalStep(Traversal.Admin traversal, Integer startIndex)
SubstringLocalStep(Traversal.Admin traversal, Integer startIndex, Integer endIndex)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected E
applyStringOperation(String item)
String
getStepName()
int
hashCode()
-
Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.StringLocalStep
getRequirements, map
-
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
-
-
-
-
Constructor Detail
-
SubstringLocalStep
public SubstringLocalStep(Traversal.Admin traversal, Integer startIndex, Integer endIndex)
-
SubstringLocalStep
public SubstringLocalStep(Traversal.Admin traversal, Integer startIndex)
-
-
Method Detail
-
applyStringOperation
protected E applyStringOperation(String item)
- Specified by:
applyStringOperation
in classStringLocalStep<S,E>
-
getStepName
public String getStepName()
- Specified by:
getStepName
in classStringLocalStep<S,E>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractStep<S,E>
-
-