public static interface Traverser.Admin<T> extends Traverser<T>, Attachable<T>
Traverser.Admin<T>Attachable.Exceptions, Attachable.Method| Modifier and Type | Method and Description |
|---|---|
void |
addLabels(Set<String> labels) |
T |
attach(Function<Attachable<T>,T> method)
Regenerate the detached traverser given its location at a particular vertex.
|
Traverser.Admin<T> |
detach()
Prepare the traverser for migration across a JVM boundary.
|
TraversalSideEffects |
getSideEffects()
Get the sideEffects associated with the traversal of the traverser.
|
String |
getStepId()
Get the step id of where the traverser is located.
|
Set<String> |
getTags()
Get the tags associated with the traverser.
|
void |
incrLoops(String stepLabel)
Increment the number of times the traverser has gone through a looping section of traversal.
|
default boolean |
isHalted()
If the traverser has "no future" then it is done with its lifecycle.
|
void |
merge(Traverser.Admin<?> other)
When two traversers are have equality with each other, then they can be merged.
|
void |
resetLoops()
Set the number of times the traverser has gone through a loop back to 0.
|
void |
set(T t)
Set the current object location of the traverser.
|
void |
setBulk(long count)
Set the number of traversers represented by this traverser.
|
void |
setSideEffects(TraversalSideEffects sideEffects)
Set the sideEffects of the
Traversal. |
void |
setStepId(String stepId)
Set the step id of where the traverser is located.
|
Traverser.Admin<T> |
split()
Generate a sibling traverser of the current traverser with a full copy of all state within the sibling.
|
<R> Traverser.Admin<R> |
split(R r,
Step<T,R> step)
Generate a child traverser of the current traverser for current as step and new object location.
|
asAdmin, bulk, clone, compareTo, get, loops, path, path, path, sack, sack, sideEffects, sideEffectsgetstatic final String HALT
void merge(Traverser.Admin<?> other)
other - the other traverser to merge into this traverser. Once merged, the other can be garbage collected.<R> Traverser.Admin<R> split(R r, Step<T,R> step)
R - The current object type of the childr - The current object of the childstep - The step yielding the splitTraverser.Admin<T> split()
void set(T t)
t - The current object of the traverservoid incrLoops(String stepLabel)
stepLabel - the label of the step that is doing the incrementingvoid resetLoops()
String getStepId()
void setStepId(String stepId)
HALT, then isHalted() is true.stepId - The future step of the traverserdefault boolean isHalted()
Traversal.void setBulk(long count)
count - the number of traversersTraverser.Admin<T> detach()
T attach(Function<Attachable<T>,T> method)
attach in interface Attachable<T>method - The method by which to attach a Traverser to an vertex.void setSideEffects(TraversalSideEffects sideEffects)
Traversal. Given that traversers can move between machines,
it may be important to re-set this when the traverser crosses machine boundaries.sideEffects - the sideEffects of the traversal.TraversalSideEffects getSideEffects()
Copyright © 2013–2016 Apache Software Foundation. All rights reserved.