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

Class FormatStep<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,String>

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

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<String>>, Step<S,String>, ByModulating, PathProcessor, Scoping, TraversalParent

public final class FormatStep<S>
extends MapStep<S,String>
implements ByModulating, TraversalParent, Scoping, PathProcessor

Reference implementation for String format step, a mid-traversal step which will handle result formatting to string values. If the incoming traverser is a non-String value then an IllegalArgumentException will be thrown.

Author:

Valentyn Kahamlyk

See Also:

Serialized Form

Nested Class Summary

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
FormatStep(Traversal.Admin traversal, String format)

Method Summary

Modifier and Type	Method	Description
FormatStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
Set<String>	getKeepLabels()
List<Traversal.Admin<S,String>>	getLocalChildren()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement 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 traversal
int	hashCode()
void	modulateBy(Traversal.Admin<?,?> selectTraversal)
protected Traverser.Admin<String>	processNextStart()
void	replaceLocalChild(Traversal.Admin<?,?> oldTraversal, Traversal.Admin<?,?> newTraversal)
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 the Traversal that this step is contained within.
String	toString()

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

getMaxRequirement

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

equals

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

addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild

Constructor Detail

FormatStep

public FormatStep(Traversal.Admin traversal,
                  String format)

Method Detail

processNextStart

protected Traverser.Admin<String> processNextStart()

Specified by:

processNextStart in class AbstractStep<S,String>

toString

public String toString()

Overrides:

toString in class AbstractStep<S,String>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,String>

getLocalChildren

public List<Traversal.Admin<S,String>> getLocalChildren()

Specified by:

getLocalChildren in interface TraversalParent

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.

Specified by:

reset in interface Step<S,String>

Overrides:

reset in class AbstractStep<S,String>

clone

public FormatStep<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,String>

Overrides:

clone in class AbstractStep<S,String>

Returns:

The cloned step

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

Overrides:

setTraversal in class AbstractStep<S,String>

Parameters:

parentTraversal - the new traversal for this step

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

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 interface Scoping

Returns:

the accessed labels of the scoping step

setKeepLabels

public void setKeepLabels(Set<String> labels)

Specified by:

setKeepLabels in interface PathProcessor

getKeepLabels

public Set<String> getKeepLabels()

Specified by:

getKeepLabels in interface PathProcessor

modulateBy

public void modulateBy(Traversal.Admin<?,?> selectTraversal)

Specified by:

modulateBy in interface ByModulating

replaceLocalChild

public void replaceLocalChild(Traversal.Admin<?,?> oldTraversal,
                              Traversal.Admin<?,?> newTraversal)

Specified by:

replaceLocalChild in interface TraversalParent