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

Class SelectStep<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,Map<String,E>>

org.apache.tinkerpop.gremlin.process.traversal.step.map.SelectStep<S,E>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<Map<String,E>>>, Step<S,Map<String,E>>, PathProcessor, Scoping, TraversalParent

public final class SelectStep<S,E>
extends MapStep<S,Map<String,E>>
implements Scoping, TraversalParent, PathProcessor

Author:

Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping

Scoping.Variable

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.PathProcessor

PathProcessor.ElementRequirement

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdSetByChild

Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.Scoping

TYPICAL_GLOBAL_REQUIREMENTS, TYPICAL_GLOBAL_REQUIREMENTS_ARRAY, TYPICAL_LOCAL_REQUIREMENTS, TYPICAL_LOCAL_REQUIREMENTS_ARRAY

Constructor Summary

Constructors

Constructor and Description
SelectStep(Traversal.Admin traversal, Pop pop, String... selectKeys)

Method Summary

Modifier and Type	Method and Description
void	addLocalChild(Traversal.Admin<?,?> selectTraversal)
SelectStep<S,E>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
List<Traversal.Admin<Object,E>>	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()
int	hashCode()
protected Map<String,E>	map(Traverser.Admin<S> traverser)
void	reset() Reset the state of the step such that it has no incoming starts.
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep

processNextStart

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, setId, setNextStep, setPreviousStep, setTraversal

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

getNullableScopeValue, getScopeValue

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

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

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

getMaxRequirement

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step

equals

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

SelectStep

public SelectStep(Traversal.Admin traversal,
                  Pop pop,
                  String... selectKeys)

Method Detail

map

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

Specified by:

map in class MapStep<S,Map<String,E>>

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

Overrides:

reset in class AbstractStep<S,Map<String,E>>

toString

public String toString()

Overrides:

toString in class AbstractStep<S,Map<String,E>>

clone

public SelectStep<S,E> 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 reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<S,Map<String,E>>

Overrides:

clone in class AbstractStep<S,Map<String,E>>

Returns:

The cloned step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,Map<String,E>>

getLocalChildren

public List<Traversal.Admin<Object,E>> getLocalChildren()

Specified by:

getLocalChildren in interface TraversalParent

addLocalChild

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

Specified by:

addLocalChild in interface TraversalParent

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

Returns:

the set of requirements

getScopeKeys

public Set<String> getScopeKeys()

Specified by:

getScopeKeys in interface Scoping