Class MathStep<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,Double>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.map.MathStep<S>
-
- All Implemented Interfaces:
Serializable
,AutoCloseable
,Cloneable
,Iterator<Traverser.Admin<Double>>
,Step<S,Double>
,ByModulating
,PathProcessor
,Scoping
,TraversalParent
public final class MathStep<S> extends MapStep<S,Double> implements ByModulating, TraversalParent, Scoping, PathProcessor
- Author:
- Marko A. Rodriguez (http://markorodriguez.com)
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MathStep.TinkerExpression
A wrapper for theExpression
class.-
Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PathProcessor
PathProcessor.ElementRequirement
-
Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping
Scoping.KeyNotFoundException, Scoping.Variable
-
-
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 MathStep(Traversal.Admin traversal, String equation)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MathStep<S>
clone()
Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.Set<String>
getKeepLabels()
List<Traversal.Admin<S,Number>>
getLocalChildren()
PathProcessor.ElementRequirement
getMaxRequirement()
Set<TraverserRequirement>
getRequirements()
Provide the necessaryTraverserRequirement
that must be met by the traverser in order for the step to function properly.Set<String>
getScopeKeys()
Get the labels that this scoping step will access during the traversalprotected static Set<String>
getVariables(String equation)
int
hashCode()
void
modulateBy(Traversal.Admin<?,?> selectTraversal)
protected Traverser.Admin<Double>
processNextStart()
void
reset()
Reset the state of the step such that it has no incoming starts.void
setKeepLabels(Set<String> labels)
void
setTraversal(Traversal.Admin<?,?> parentTraversal)
Set theTraversal
that this step is contained within.String
toString()
-
Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep
addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, setId, setNextStep, setPreviousStep
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.ByModulating
modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy
-
Methods inherited from interface java.util.Iterator
forEachRemaining, remove
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping
getNullableScopeValue, getSafeScopeValue, getScopeValue
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent
addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild
-
-
-
-
Constructor Detail
-
MathStep
public MathStep(Traversal.Admin traversal, String equation)
-
-
Method Detail
-
processNextStart
protected Traverser.Admin<Double> processNextStart()
- Specified by:
processNextStart
in classAbstractStep<S,Double>
-
modulateBy
public void modulateBy(Traversal.Admin<?,?> selectTraversal)
- Specified by:
modulateBy
in interfaceByModulating
-
getMaxRequirement
public PathProcessor.ElementRequirement getMaxRequirement()
- Specified by:
getMaxRequirement
in interfacePathProcessor
-
toString
public String toString()
- Overrides:
toString
in classAbstractStep<S,Double>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractStep<S,Double>
-
getLocalChildren
public List<Traversal.Admin<S,Number>> getLocalChildren()
- Specified by:
getLocalChildren
in interfaceTraversalParent
-
reset
public void reset()
Description copied from interface:Step
Reset the state of the step such that it has no incoming starts. Internal states are to be reset, but any sideEffect data structures are not to be recreated.
-
clone
public MathStep<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 whenStep.reset()
is called. Moreover, the previous and next steps should be set toEmptyStep
.
-
setTraversal
public void setTraversal(Traversal.Admin<?,?> parentTraversal)
Description copied from interface:Step
Set theTraversal
that this step is contained within.- Specified by:
setTraversal
in interfaceStep<S,Double>
- Overrides:
setTraversal
in classAbstractStep<S,Double>
- Parameters:
parentTraversal
- the new traversal for this step
-
getRequirements
public Set<TraverserRequirement> getRequirements()
Description copied from interface:Step
Provide the necessaryTraverserRequirement
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 interfaceStep<S,Double>
- Returns:
- the set of requirements
-
getScopeKeys
public Set<String> getScopeKeys()
Description copied from interface:Scoping
Get the labels that this scoping step will access during the traversal- Specified by:
getScopeKeys
in interfaceScoping
- Returns:
- the accessed labels of the scoping step
-
setKeepLabels
public void setKeepLabels(Set<String> labels)
- Specified by:
setKeepLabels
in interfacePathProcessor
-
getKeepLabels
public Set<String> getKeepLabels()
- Specified by:
getKeepLabels
in interfacePathProcessor
-
-