org.treetank.axis

Class DescendantAxis

java.lang.Object

org.treetank.axis.AbsAxis

org.treetank.axis.DescendantAxis

All Implemented Interfaces:

Iterable<Long>, Iterator<Long>

public final class DescendantAxis
extends AbsAxis

DescendantAxis

Iterate over all descendants of kind ELEMENT or TEXT starting at a given node. Self is not included.

Constructor Summary

Constructors

Constructor and Description
DescendantAxis(INodeReadTrx rtx) Constructor initializing internal state.
DescendantAxis(INodeReadTrx rtx, boolean mIncludeSelf) Constructor initializing internal state.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext()
void	reset(long mNodeKey) Resetting the nodekey of this axis to a given nodekey.

Methods inherited from class org.treetank.axis.AbsAxis

addAtomicToItemList, close, getItemList, getNode, getStartKey, isSelfIncluded, iterator, moveTo, next, remove, resetToLastKey, resetToStartKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescendantAxis

public DescendantAxis(INodeReadTrx rtx)

Constructor initializing internal state.

Parameters:

rtx - Exclusive (immutable) trx to iterate with.

DescendantAxis

public DescendantAxis(INodeReadTrx rtx,
              boolean mIncludeSelf)

Constructor initializing internal state.

Parameters:

rtx - Exclusive (immutable) trx to iterate with.

mIncludeSelf - Is self included?

Method Detail

reset

public void reset(long mNodeKey)

Resetting the nodekey of this axis to a given nodekey.

Overrides:

reset in class AbsAxis

Parameters:

mNodeKey - the nodekey where the reset should occur to.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Long>

Specified by:

hasNext in class AbsAxis