public final class PathFilterStep<S> extends FilterStep<S> implements FromToModulating, ByModulating, TraversalParent, PathProcessor
PathProcessor.ElementRequirement| Modifier and Type | Field and Description |
|---|---|
protected String |
fromLabel |
protected String |
toLabel |
id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild| Constructor and Description |
|---|
PathFilterStep(Traversal.Admin traversal,
boolean isSimple) |
| Modifier and Type | Method and 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) |
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. |
int |
hashCode() |
void |
modulateBy(Traversal.Admin<?,?> pathTraversal) |
protected Traverser.Admin<S> |
processNextStart() |
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() |
addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, setId, setNextStep, setPreviousStepfinalize, getClass, notify, notifyAll, wait, wait, waitaddFrom, addTomodulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateByaddGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChildgetMaxRequirement, processTraverserPathLabelsforEachRemaining, removepublic PathFilterStep(Traversal.Admin traversal, boolean isSimple)
protected boolean filter(Traverser.Admin<S> traverser)
filter in class FilterStep<S>public Set<TraverserRequirement> getRequirements()
StepTraverserRequirement that must be met by the traverser in order for the step to function properly.
The provided default implements returns an empty set.getRequirements in interface Step<S,S>public void addFrom(String fromLabel)
addFrom in interface FromToModulatingpublic void addTo(String toLabel)
addTo in interface FromToModulatingpublic String toString()
toString in class AbstractStep<S,S>public PathFilterStep<S> clone()
StepEmptyStep.public void setTraversal(Traversal.Admin<?,?> parentTraversal)
StepTraversal that this step is contained within.setTraversal in interface Step<S,S>setTraversal in class AbstractStep<S,S>parentTraversal - the new traversal for this steppublic List<Traversal.Admin<Object,Object>> getLocalChildren()
getLocalChildren in interface TraversalParentpublic void modulateBy(Traversal.Admin<?,?> pathTraversal)
modulateBy in interface ByModulatingpublic void reset()
Steppublic int hashCode()
hashCode in class AbstractStep<S,S>public void setKeepLabels(Set<String> keepLabels)
setKeepLabels in interface PathProcessorprotected Traverser.Admin<S> processNextStart()
processNextStart in class FilterStep<S>public Set<String> getKeepLabels()
getKeepLabels in interface PathProcessorCopyright © 2013–2017 Apache Software Foundation. All rights reserved.