org.openxml.dom.traversal

Class NodeIteratorImpl

java.lang.Object

org.openxml.dom.traversal.NodeIteratorImpl

All Implemented Interfaces:

NodeList, org.w3c.dom.traversal.NodeIterator

public final class NodeIteratorImpl
extends Object
implements org.w3c.dom.traversal.NodeIterator, NodeList

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

The iterator interface is defined by NodeIterator. This class serves as an adapter class that implements the interface and delegates iteration requests to a inner iterator, and destroys the inner iterator when garabage collected.

InnerIterator contains the actual iteration logic. Changes in the document tree are reported through the InnerIterator interface and the iterator has to adjust accordingly. Two inner iterators exist, one for list iteration the other for tree iteration.

ParentNodeImpl creates the new iterator and registers it as a listener to changes in the node's tree. The node obtains the listener by calling asInnerIterator() on the iterator. The iterator can unregistered itself by calling ParentNodeImpl.removeInnerIterator(org.openxml.dom.traversal.InnerIterator) on the node.

Author:

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

See Also:

NodeIterator, InnerIterator, ParentNodeImpl

Constructor Summary

Constructors

Constructor and Description
NodeIteratorImpl(ParentNodeImpl owner, boolean tree, int whatToShow, org.w3c.dom.traversal.NodeFilter filter) Constrctor for a new node iterator.

Method Summary

Modifier and Type	Method and Description
InnerIterator	asInnerIterator() Return the inner iterator.
void	detach()
boolean	getExpandEntityReferences()
org.w3c.dom.traversal.NodeFilter	getFilter()
int	getLength() Return the number of childs in this node.
Node	getRoot()
int	getWhatToShow()
Node	item(int index) Return the nth child in the node (zero based).
Node	nextNode()
Node	previousNode()
void	setExpandEntityReferences(boolean expand)

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeIteratorImpl

public NodeIteratorImpl(ParentNodeImpl owner,
                        boolean tree,
                        int whatToShow,
                        org.w3c.dom.traversal.NodeFilter filter)

Constrctor for a new node iterator. The top of the node tree is also the owner of this iterator and notifies it of any changes to the document tree that might affect it. Depending on the value of tree this will return either a tree or a list iterator.

Parameters:

owner - The owner of this iterator and top of the node List to iterate

tree - True if tree iterator required, false for list iterator

whatToShow - Flag indicating what nodes to return

filter - Optional node filter

Method Detail

nextNode

public Node nextNode()

Specified by:

nextNode in interface org.w3c.dom.traversal.NodeIterator

previousNode

public Node previousNode()

Specified by:

previousNode in interface org.w3c.dom.traversal.NodeIterator

getExpandEntityReferences

public final boolean getExpandEntityReferences()

Specified by:

getExpandEntityReferences in interface org.w3c.dom.traversal.NodeIterator

setExpandEntityReferences

public final void setExpandEntityReferences(boolean expand)

getFilter

public final org.w3c.dom.traversal.NodeFilter getFilter()

Specified by:

getFilter in interface org.w3c.dom.traversal.NodeIterator

getWhatToShow

public final int getWhatToShow()

Specified by:

getWhatToShow in interface org.w3c.dom.traversal.NodeIterator

asInnerIterator

public InnerIterator asInnerIterator()

Return the inner iterator. The inner object will be registered as a listener on the owner for notifying the iterator when a node in the iterated tree has been removed.

Returns:

An inner iterator

item

public Node item(int index)

Return the nth child in the node (zero based). If the child does not exist, returns null. No exception is thrown if index is negative.

Specified by:

item in interface NodeList

Parameters:

index - Index of child to return (zero based)

Returns:

Child or null

getLength

public int getLength()

Return the number of childs in this node.

Specified by:

getLength in interface NodeList

Returns:

Number of childs

detach

public void detach()

Specified by:

detach in interface org.w3c.dom.traversal.NodeIterator

getRoot

public Node getRoot()

Specified by:

getRoot in interface org.w3c.dom.traversal.NodeIterator