org.apache.xerces.dom

Class NodeIteratorImpl

Implemented Interfaces:
NodeIterator

public class NodeIteratorImpl
extends java.lang.Object
implements NodeIterator

DefaultNodeIterator implements a NodeIterator, which iterates a DOM tree in the expected depth first way.

The whatToShow and filter functionality is implemented as expected.

This class also has method removeNode to enable iterator "fix-up" on DOM remove. It is expected that the DOM implementation call removeNode right before the actual DOM transformation. If not called by the DOM, the client could call it before doing the removal.

Version:
$Id: NodeIteratorImpl.java,v 1.13 2004/10/05 17:12:49 mrglavas Exp $

Constructor Summary

NodeIteratorImpl(DocumentImpl document, Node root, int whatToShow, NodeFilter nodeFilter, boolean entityReferenceExpansion)
Public constructor

Method Summary

void
detach()
boolean
getExpandEntityReferences()
Return whether children entity references are included in the iterator.
NodeFilter
getFilter()
Return the filter
Node
getRoot()
int
getWhatToShow()
Return the whatToShow value
Node
nextNode()
Return the next Node in the Iterator.
Node
previousNode()
Return the previous Node in the Iterator.
void
removeNode(Node node)
Fix-up the iterator on a remove.

Constructor Details

NodeIteratorImpl

public NodeIteratorImpl(DocumentImpl document,
                        Node root,
                        int whatToShow,
                        NodeFilter nodeFilter,
                        boolean entityReferenceExpansion)
Public constructor

Method Details

detach

public void detach()

getExpandEntityReferences

public boolean getExpandEntityReferences()
Return whether children entity references are included in the iterator.

getFilter

public NodeFilter getFilter()
Return the filter

getRoot

public Node getRoot()

getWhatToShow

public int getWhatToShow()
Return the whatToShow value

nextNode

public Node nextNode()
Return the next Node in the Iterator. The node is the next node in depth-first order which also passes the filter, and whatToShow. If there is no next node which passes these criteria, then return null.

previousNode

public Node previousNode()
Return the previous Node in the Iterator. The node is the next node in _backwards_ depth-first order which also passes the filter, and whatToShow.

removeNode

public void removeNode(Node node)
Fix-up the iterator on a remove. Called by DOM or otherwise, before an actual DOM remove.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.