org.treetank.axis

Class AbsAxis

java.lang.Object

org.treetank.axis.AbsAxis

All Implemented Interfaces:

Iterable<Long>, Iterator<Long>

Direct Known Subclasses:

AbsComparator, AbsExpression, AbsFilter, AbsObAxis, AncestorAxis, AttributeAxis, ChildAxis, DescendantAxis, DiffAxis, DocumentNodeAxis, DupFilterAxis, ExceptAxis, FilterAxis, FollowingAxis, FollowingSiblingAxis, ForAxis, IfAxis, IntersectAxis, LevelOrderAxis, NestedAxis, ParentAxis, PostOrderAxis, PrecedingAxis, PrecedingSiblingAxis, PredicateFilterAxis, RangeAxis, SelfAxis, SequenceAxis, UnionAxis, VariableAxis, XPathAxis

public abstract class AbsAxis
extends Object
implements Iterator<Long>, Iterable<Long>

AbstractAxis

Provide standard Java iterator capability compatible with the new enhanced for loop available since Java 5.

All implementations must make sure to call super.hasNext() as the first thing in hasNext().

All users must make sure to call next() after hasNext() evaluated to true.

Constructor Summary

Constructors

Constructor and Description
AbsAxis(INodeReadTrx paramRtx) Bind axis step to transaction.
AbsAxis(INodeReadTrx paramRtx, boolean paramIncludeSelf) Bind axis step to transaction.

Method Summary

Methods

Modifier and Type	Method and Description
static int	addAtomicToItemList(INodeReadTrx pRtx, AtomicValue pVal) Adding any AtomicVal to any ItemList staticly.
void	close() Closing the Transaction
ItemList	getItemList() Getting the ItemList.
INode	getNode() Getting the current node (including items from the ItemList)
protected long	getStartKey() Get start key.
abstract boolean	hasNext()
protected boolean	isSelfIncluded() Is self included?
Iterator<Long>	iterator()
boolean	moveTo(long pKey) Move cursor to a node by its node key.
Long	next()
void	remove()
void	reset(long paramNodeKey) Resetting the nodekey of this axis to a given nodekey.
protected long	resetToLastKey() Make sure the transaction points to the node after the last hasNext().
protected long	resetToStartKey() Make sure the transaction points to the node it started with.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbsAxis

public AbsAxis(INodeReadTrx paramRtx)

Bind axis step to transaction.

Parameters:

paramRtx - transaction to operate with

AbsAxis

public AbsAxis(INodeReadTrx paramRtx,
       boolean paramIncludeSelf)

Bind axis step to transaction.

Parameters:

paramRtx - transaction to operate with

paramIncludeSelf - determines if self is included

Method Detail

iterator

public final Iterator<Long> iterator()

Specified by:

iterator in interface Iterable<Long>

next

public final Long next()

Specified by:

next in interface Iterator<Long>

remove

public final void remove()

Specified by:

remove in interface Iterator<Long>

reset

public void reset(long paramNodeKey)

Resetting the nodekey of this axis to a given nodekey.

Parameters:

paramNodeKey - the nodekey where the reset should occur to.

moveTo

public boolean moveTo(long pKey)

Move cursor to a node by its node key.

Parameters:

pKey - Key of node to select.

Returns:

True if the node with the given node key is selected.

close

public void close()
           throws TTException

Closing the Transaction

Throws:

TTException

getNode

public INode getNode()

Getting the current node (including items from the ItemList)

Returns:

Getting the node.

resetToStartKey

protected final long resetToStartKey()

Make sure the transaction points to the node it started with. This must be called just before hasNext() == false.

Returns:

Key of node where transaction was before the first call of hasNext().

resetToLastKey

protected final long resetToLastKey()

Make sure the transaction points to the node after the last hasNext(). This must be called first in hasNext().

Returns:

Key of node where transaction was after the last call of hasNext().

getStartKey

protected final long getStartKey()

Get start key.

Returns:

Start key.

isSelfIncluded

protected final boolean isSelfIncluded()

Is self included?

Returns:

True if self is included. False else.

hasNext

public abstract boolean hasNext()

Specified by:

hasNext in interface Iterator<Long>

getItemList

public ItemList getItemList()

Getting the ItemList.

Returns:

the Itemlist

addAtomicToItemList

public static int addAtomicToItemList(INodeReadTrx pRtx,
                      AtomicValue pVal)

Adding any AtomicVal to any ItemList staticly.

Parameters:

pRtx - as key

pVal - to be added

Returns:

the index in the ItemList