public final class TraversalFilterStep<S> extends FilterStep<S> implements TraversalParent, Configuring
id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild
Constructor and Description |
---|
TraversalFilterStep(Traversal.Admin traversal,
Traversal<S,?> filterTraversal) |
Modifier and Type | Method and Description |
---|---|
TraversalFilterStep<S> |
clone()
Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
|
void |
configure(Object... keyValues)
Accept a configuration to the
Step . |
protected boolean |
filter(Traverser.Admin<S> traverser) |
Traversal.Admin<S,?> |
getFilterTraversal() |
List<Traversal.Admin<S,?>> |
getLocalChildren() |
Parameters |
getParameters()
Gets the parameters on the step.
|
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 |
setTraversal(Traversal.Admin<?,?> parentTraversal)
Set the
Traversal that this step is contained within. |
String |
toString() |
processNextStart
addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep
finalize, getClass, notify, notifyAll, wait, wait, wait
addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild
forEachRemaining, remove
public TraversalFilterStep(Traversal.Admin traversal, Traversal<S,?> filterTraversal)
public Traversal.Admin<S,?> getFilterTraversal()
public Parameters getParameters()
Parameterizing
getParameters
in interface Parameterizing
public void configure(Object... keyValues)
Configuring
Step
. Note that this interface extends Parameterizing
and so
there is an expectation that the Step
implementation will have a Parameters
instance that will
house any values passed to this method. Storing these configurations in Parameters
is not a requirement
however, IF the configuration is an expected option for the step and can be stored on a member field that can
be accessed on the step by more direct means (i.e. like a getter method).configure
in interface Configuring
protected boolean filter(Traverser.Admin<S> traverser)
filter
in class FilterStep<S>
public List<Traversal.Admin<S,?>> getLocalChildren()
getLocalChildren
in interface TraversalParent
public TraversalFilterStep<S> clone()
Step
Step.reset()
is called. Moreover, the previous and next steps should be set to EmptyStep
.public void setTraversal(Traversal.Admin<?,?> parentTraversal)
Step
Traversal
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 String toString()
toString
in class AbstractStep<S,S>
public int hashCode()
hashCode
in class AbstractStep<S,S>
public Set<TraverserRequirement> getRequirements()
Step
TraverserRequirement
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>
Copyright © 2013–2021 Apache Software Foundation. All rights reserved.