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

Class AsNumberStep<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,Number>

org.apache.tinkerpop.gremlin.process.traversal.step.map.AsNumberStep<S>

All Implemented Interfaces:

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

public class AsNumberStep<S>
extends ScalarMapStep<S,Number>

Reference implementation for number parsing step.

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
AsNumberStep(Traversal.Admin traversal)
AsNumberStep(Traversal.Admin traversal, GType numberToken)

Method Summary

Modifier and Type	Method	Description
AsNumberStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
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 Number	map(Traverser.Admin<S> traverser)
void	setTraversal(Traversal.Admin<?,?> parentTraversal)	Set the Traversal that this step is contained within.
String	toString()

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

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

AsNumberStep

public AsNumberStep(Traversal.Admin traversal)

AsNumberStep

public AsNumberStep(Traversal.Admin traversal,
                    GType numberToken)

Method Detail

map

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

Specified by:

map in class ScalarMapStep<S,Number>

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

setTraversal

public void setTraversal(Traversal.Admin<?,?> parentTraversal)

Description copied from interface: Step

Set the Traversal that this step is contained within.

Specified by:

setTraversal in interface Step<S,Number>

Overrides:

setTraversal in class AbstractStep<S,Number>

Parameters:

parentTraversal - the new traversal for this step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,Number>

clone

public AsNumberStep<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,Number>

Overrides:

clone in class AbstractStep<S,Number>

Returns:

The cloned step

toString

public String toString()

Overrides:

toString in class AbstractStep<S,Number>