org.openxml.dom.traversal

Class InnerIterator

java.lang.Object

org.openxml.dom.traversal.InnerIterator

All Implemented Interfaces:

org.w3c.dom.traversal.NodeIterator

Direct Known Subclasses:

ListInnerIterator, TreeInnerIterator

public abstract class InnerIterator
extends Object
implements org.w3c.dom.traversal.NodeIterator

Interface of inner object of a live node iterator. List and tree inner iterators extend this class, so a single NodeIteratorImpl can use either implementations.

This interface defines a reset method required for using the iterator as a node list. The destroy method is required by the care-taker design pattern, which saves the need to use weak references.

The inner iterator object is held by the creating node for the purpose of notification. The outer iterator object is held by the application for the purpose of iterating the list. When the iterator is no longer needed, the application releases the reference to the outer iterator which is garbage collected. The outer iterator's finalize method releases the reference between the node and the inner iterator, allowing the inner iterator to be garbage collected as well.

Author:

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

See Also:

NodeIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected Node	_current The current node.
protected ParentNodeImpl	_owner The top node of the iterated tree and the iterator's owner.
protected int	_whatToShow Mask of node types.

Constructor Summary

Constructors

Constructor and Description
InnerIterator()

Method Summary

Modifier and Type	Method and Description
void	detach() Called by NodeIteratorImpl when this iterator is no longer needed.
boolean	getExpandEntityReferences()
org.w3c.dom.traversal.NodeFilter	getFilter()
Node	getRoot() NOTYET, required method.
int	getWhatToShow()
void	removeNode(Node removedNode) Called to notify this iterator that a particular node has been removed.
void	reset() Return to the beginning of the list, so the iteration can start all over.
void	setExpandEntityReferences(boolean expand)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.traversal.NodeIterator

nextNode, previousNode

Field Detail

_owner

protected ParentNodeImpl _owner

The top node of the iterated tree and the iterator's owner. This node is the parent of all traveresed nodes, but is never returned during iteration. No parent or sibling of _owner is ever returned. The iterator is registered as a listener with this owner.

_current

protected Node _current

The current node. This is the last node returned by NodeIterator.nextNode() or NodeIterator.previousNode(), and is set to _owner on initialization.

_whatToShow

protected int _whatToShow

Mask of node types. This mask determines which node types will be returned from the iterator. The value of 0xFFFF will return nodes of all types, and the default value 0x1A will return elements, text and CDATA sections.

The mask is defined as follows. For each node type, its node type code is used as the position of the one in the mask, and all masks are combined with a binary and. Thus, the default value is calculated as:

 = ( 1 << ELEMENT_NODE ) + ( 1 << TEXT_NODE ) + ( 1 << CDATA_SECTION_NODE )
 = ( 1 << 1 ) + ( 1 << 3 ) + ( 1 << 4 )
 = 0x02 + 0x08 + 0x10
 = 0x1A
 

This mask is set in the constructor to be one bit off than the constants defined in NodeIterator so that it can easily mask 1 << getNodeType().

Constructor Detail

InnerIterator

public InnerIterator()

Method Detail

removeNode

public void removeNode(Node removedNode)

Called to notify this iterator that a particular node has been removed. If the iterator is pointing at that node, or one of its childern, it must adjust accordingly.

This method only affects the iterator if it is pointing at the removed node or a child of the removed node. It does not affect the iterator if it is pointing to a parent of the removed node, or the removed node is on some other branch of the document tree.

Parameters:

removedNode - The node being removed

reset

public void reset()

Return to the beginning of the list, so the iteration can start all over. The next call to NodeIterator.nextNode() will return the first node in the list.

detach

public void detach()

Called by NodeIteratorImpl when this iterator is no longer needed. NodeIteratorImpl is being garbage collected when the application ceases referencing it, but this inner iterator is still held by the owner node. This method will unregister the iterator with the node allowing it to be garbage collected.

Specified by:

detach 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

getRoot

public Node getRoot()

NOTYET, required method.

Specified by:

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