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

Class PathFilterStep<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.PathFilterStep<S>

All Implemented Interfaces:

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

public final class PathFilterStep<S>
extends FilterStep<S>
implements FromToModulating, ByModulating, 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.PathProcessor

PathProcessor.ElementRequirement

Field Summary

Fields

Modifier and Type	Field	Description
protected String	fromLabel
protected String	toLabel

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
PathFilterStep(Traversal.Admin traversal, boolean isSimple)

Method Summary

Modifier and Type	Method	Description
void	addFrom(String fromLabel)
void	addTo(String toLabel)
PathFilterStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
protected boolean	filter(Traverser.Admin<S> traverser)
String	getFromLabel()
Set<String>	getKeepLabels()
List<Traversal.Admin<Object,Object>>	getLocalChildren()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	getToLabel()
TraversalRing<Object,Object>	getTraversalRing()
int	hashCode()
boolean	isSimple()
void	modulateBy(Traversal.Admin<?,?> pathTraversal)
protected Traverser.Admin<S>	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> 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, 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 org.apache.tinkerpop.gremlin.process.traversal.step.FromToModulating

addFrom, addTo

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

equals

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

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

Field Detail

fromLabel

protected String fromLabel

toLabel

protected String toLabel

Constructor Detail

PathFilterStep

public PathFilterStep(Traversal.Admin traversal,
                      boolean isSimple)

Method Detail

filter

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

Specified by:

filter in class FilterStep<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

addFrom

public void addFrom(String fromLabel)

Specified by:

addFrom in interface FromToModulating

addTo

public void addTo(String toLabel)

Specified by:

addTo in interface FromToModulating

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

clone

public PathFilterStep<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

getLocalChildren

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

Specified by:

getLocalChildren in interface TraversalParent

modulateBy

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

Specified by:

modulateBy in interface ByModulating

replaceLocalChild

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

Specified by:

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

Overrides:

reset in class AbstractStep<S,S>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

setKeepLabels

public void setKeepLabels(Set<String> keepLabels)

Specified by:

setKeepLabels in interface PathProcessor

processNextStart

protected Traverser.Admin<S> processNextStart()

Overrides:

processNextStart in class FilterStep<S>

getKeepLabels

public Set<String> getKeepLabels()

Specified by:

getKeepLabels in interface PathProcessor

getFromLabel

public String getFromLabel()

getToLabel

public String getToLabel()

isSimple

public boolean isSimple()

getTraversalRing

public TraversalRing<Object,Object> getTraversalRing()