public class O_OB_S_SE_SL_Traverser<T> extends O_Traverser<T>
Traverser.Admin<T>
Attachable.Exceptions, Attachable.Method
Modifier and Type | Field and Description |
---|---|
protected long |
bulk |
protected String |
future |
protected String |
loopName |
protected short |
loops |
protected Object |
sack |
protected TraversalSideEffects |
sideEffects |
tags
t
HALT
Modifier | Constructor and Description |
---|---|
protected |
O_OB_S_SE_SL_Traverser() |
|
O_OB_S_SE_SL_Traverser(T t,
Step<T,?> step) |
Modifier and Type | Method and Description |
---|---|
long |
bulk()
A traverser may represent a grouping of traversers to allow for more efficient data propagation.
|
protected boolean |
equals(O_OB_S_SE_SL_Traverser other) |
boolean |
equals(Object object) |
Set<String> |
getLoopNames()
If this traverser supports loops then return the loop names if any.
|
TraversalSideEffects |
getSideEffects()
Get the sideEffects associated with the traversal of the traverser.
|
String |
getStepId()
Get the step id of where the traverser is located.
|
int |
hashCode() |
void |
incrLoops()
Increment the number of times the traverser has gone through a looping section of traversal.
|
void |
initialiseLoops(String stepLabel,
String loopName)
Initialise a loop by setting up the looping construct.
|
int |
loops()
Return the number of times the traverser has gone through a looping section of a traversal.
|
int |
loops(String loopName)
Return the number of times the traverser has gone through the named looping section of a traversal.
|
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.
|
<S> S |
sack()
Get the sack local sack object of this traverser.
|
<S> void |
sack(S object)
Set the traversers sack object to the provided value ("sack the value").
|
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.
|
equals, getTags
addLabels, attach, clone, detach, dropLabels, dropPath, get, keepLabels, path, set, toString
finalize, getClass, notify, notifyAll, wait, wait, wait
isHalted
asAdmin, compareTo, path, path, sideEffects, sideEffects
protected Object sack
protected short loops
protected String loopName
protected transient TraversalSideEffects sideEffects
protected String future
protected long bulk
public void setBulk(long count)
Traverser.Admin
setBulk
in interface Traverser.Admin<T>
setBulk
in class AbstractTraverser<T>
count
- the number of traverserspublic long bulk()
Traverser
public <S> S sack()
Traverser
public <S> void sack(S object)
Traverser
public int loops()
Traverser
public int loops(String loopName)
Traverser
public Set<String> getLoopNames()
Traverser.Admin
public void initialiseLoops(String stepLabel, String loopName)
Traverser.Admin
LoopsStep
initialiseLoops
in interface Traverser.Admin<T>
initialiseLoops
in class AbstractTraverser<T>
stepLabel
- the label of the step that is being set-up.loopName
- the user defined name for referencing the loop counter or null if not setpublic void incrLoops()
Traverser.Admin
incrLoops
in interface Traverser.Admin<T>
incrLoops
in class AbstractTraverser<T>
public void resetLoops()
Traverser.Admin
resetLoops
in interface Traverser.Admin<T>
resetLoops
in class AbstractTraverser<T>
public String getStepId()
Traverser.Admin
getStepId
in interface Traverser.Admin<T>
getStepId
in class AbstractTraverser<T>
public void setStepId(String stepId)
Traverser.Admin
Traverser.Admin.HALT
, then Traverser.Admin.isHalted()
is true.setStepId
in interface Traverser.Admin<T>
setStepId
in class AbstractTraverser<T>
stepId
- The future step of the traverserpublic TraversalSideEffects getSideEffects()
Traverser.Admin
getSideEffects
in interface Traverser.Admin<T>
getSideEffects
in class AbstractTraverser<T>
public void setSideEffects(TraversalSideEffects sideEffects)
Traverser.Admin
Traversal
. Given that traversers can move between machines,
it may be important to re-set this when the traverser crosses machine boundaries.setSideEffects
in interface Traverser.Admin<T>
setSideEffects
in class AbstractTraverser<T>
sideEffects
- the sideEffects of the traversal.public <R> Traverser.Admin<R> split(R r, Step<T,R> step)
Traverser.Admin
split
in interface Traverser.Admin<T>
split
in class O_Traverser<T>
R
- The current object type of the childr
- The current object of the childstep
- The step yielding the splitpublic Traverser.Admin<T> split()
Traverser.Admin
split
in interface Traverser.Admin<T>
split
in class O_Traverser<T>
public void merge(Traverser.Admin<?> other)
Traverser.Admin
merge
in interface Traverser.Admin<T>
merge
in class O_Traverser<T>
other
- the other traverser to merge into this traverser. Once merged, the other can be garbage collected.public int hashCode()
hashCode
in class O_Traverser<T>
protected final boolean equals(O_OB_S_SE_SL_Traverser other)
public boolean equals(Object object)
equals
in class O_Traverser<T>
Copyright © 2013–2022 Apache Software Foundation. All rights reserved.