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

Class WhereTraversalStep<S>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,S>

org.apache.tinkerpop.gremlin.process.traversal.step.filter.FilterStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.filter.WhereTraversalStep<S>

All Implemented Interfaces:

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

public final class WhereTraversalStep<S>
extends FilterStep<S>
implements 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	WhereTraversalStep.WhereEndStep
static class	WhereTraversalStep.WhereStartStep<S>

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

PopContaining.PopInstruction

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

Scoping.KeyNotFoundException, Scoping.Variable

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	keepLabels
protected Set<String>	scopeKeys
protected Traversal.Admin<?,?>	whereTraversal

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
WhereTraversalStep(Traversal.Admin traversal, Traversal<?,?> whereTraversal)

Method Summary

Modifier and Type	Method	Description
WhereTraversalStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
protected boolean	filter(Traverser.Admin<S> traverser)
Set<String>	getKeepLabels()
List<Traversal.Admin<?,?>>	getLocalChildren()	Gets a list of all "local" child traversals for this step.
PathProcessor.ElementRequirement	getMaxRequirement()
HashSet<PopContaining.PopInstruction>	getPopInstructions()	Used to get PopInstruction of a Step that implements Scoping.
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()
protected Traverser.Admin<S>	processNextStart()
void	setKeepLabels(Set<String> keepLabels)
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, 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.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, replaceLocalChild

Field Detail

whereTraversal

protected Traversal.Admin<?,?> whereTraversal

scopeKeys

protected final Set<String> scopeKeys

keepLabels

protected Set<String> keepLabels

Constructor Detail

WhereTraversalStep

public WhereTraversalStep(Traversal.Admin traversal,
                          Traversal<?,?> whereTraversal)

Method Detail

getMaxRequirement

public PathProcessor.ElementRequirement getMaxRequirement()

Specified by:

getMaxRequirement in interface PathProcessor

processNextStart

protected Traverser.Admin<S> processNextStart()

Overrides:

processNextStart in class FilterStep<S>

filter

protected boolean filter(Traverser.Admin<S> traverser)

Specified by:

filter in class FilterStep<S>

getLocalChildren

public List<Traversal.Admin<?,?>> getLocalChildren()

Description copied from interface: TraversalParent

Gets a list of all "local" child traversals for this step. A "local" traversal is one which is evaluated independently for each incoming traverser to the parent step. This is typically used in cases where the child is used to process or augment each traverser individually. See LocalStep or ByModulating as examples.

Specified by:

getLocalChildren in interface TraversalParent

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

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

clone

public WhereTraversalStep<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,S>

Overrides:

clone in class AbstractStep<S,S>

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

Overrides:

setTraversal in class AbstractStep<S,S>

Parameters:

parentTraversal - the new traversal for this step

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

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

Returns:

the set of requirements

setKeepLabels

public void setKeepLabels(Set<String> keepLabels)

Specified by:

setKeepLabels in interface PathProcessor

getKeepLabels

public Set<String> getKeepLabels()

Specified by:

getKeepLabels in interface PathProcessor

getPopInstructions

public HashSet<PopContaining.PopInstruction> getPopInstructions()

Description copied from interface: Scoping

Used to get PopInstruction of a Step that implements Scoping. PopInstruction includes the labels it needs, and the pop type for each label.

Specified by:

getPopInstructions in interface PopContaining

Specified by:

getPopInstructions in interface Scoping

Specified by:

getPopInstructions in interface TraversalParent

Returns:

A Set of PopContaining.PopInstruction values which contain the label and Pop value