org.openxml.dom.traversal

Class TreeInnerIterator

java.lang.Object

org.openxml.dom.traversal.InnerIterator

org.openxml.dom.traversal.TreeInnerIterator

All Implemented Interfaces:

org.w3c.dom.traversal.NodeIterator

public class TreeInnerIterator
extends InnerIterator

Implementation of a live node tree iterator. This iterator supports selective node return, traversing to next and previous node, and is kept live with respect to changes in the document.

Author:

Impl/inner design contributed by Ray Whitmer., Assaf Arkin

See Also:

NodeIterator, NodeIteratorImpl, InnerIterator, NodeImpl

Field Summary

Fields inherited from class org.openxml.dom.traversal.InnerIterator

_current, _owner, _whatToShow

Method Summary

Modifier and Type	Method and Description
Node	nextNode() Returns the next node in the tree that matches the whatToShow mask.
Node	previousNode() Returns the previous node in the tree that matches the whatToShow mask.

Methods inherited from class org.openxml.dom.traversal.InnerIterator

detach, getExpandEntityReferences, getFilter, getRoot, getWhatToShow, removeNode, reset, setExpandEntityReferences

Methods inherited from class java.lang.Object

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

Method Detail

previousNode

public Node previousNode()

Returns the previous node in the tree that matches the whatToShow mask. If no such node is found, null is returned.

By definition, the current position is between the next node and the previous one, thus, if a call to nextNode() will return the following node, a call to this method will return the last value of nextNode(). The backward traversal algorithm is defined as:

• The current node is the return value, move to the next node
• If there is no previous node, return null
• If this node has a previous sibling, return the last deepest children of the previous sibling
• If this node has no sibling, return its parent

Returns:

The previous node in the tree, or null

nextNode

public Node nextNode()

Returns the next node in the tree that matches the whatToShow mask. If no such node is found, null is returned.

Initially InnerIterator._current points to the tree top, and the first returned node is the one directly underneath it. The forward traversal algorithm is defined as:

• Move to the next node and return it
• If there is no next node, return null
• If this node has children, move to the first child
• If this node has no children but has a sibling, move to the sibling
• If this node has no children or sibling, move to the parent's sibling

Returns:

The next node in the tree, or null