FileDocCategorySizeDatePackage
DTMChildIterNodeList.javaAPI DocJava SE 6 API4123Tue Jun 10 00:22:56 BST 2008com.sun.org.apache.xml.internal.dtm.ref

DTMChildIterNodeList

public class DTMChildIterNodeList extends DTMNodeListBase
DTMNodeList gives us an implementation of the DOM's NodeList interface wrapped around a DTM Iterator. The author considers this something of an abominations, since NodeList was not intended to be a general purpose "list of nodes" API and is generally considered by the DOM WG to have be a mistake... but I'm told that some of the XPath/XSLT folks say they must have this solution. Please note that this is not necessarily equivlaent to a DOM NodeList operating over the same document. In particular:
  • If there are several Text nodes in logical succession (ie, across CDATASection and EntityReference boundaries), we will return only the first; the caller is responsible for stepping through them. (%REVIEW% Provide a convenience routine here to assist, pending proposed DOM Level 3 getAdjacentText() operation?)
  • Since the whole XPath/XSLT architecture assumes that the source document is not altered while we're working with it, we do not promise to implement the DOM NodeList's "live view" response to document mutation.

State: In progress!!

Fields Summary
private int
m_firstChild
private DTM
m_parentDTM
Constructors Summary
private DTMChildIterNodeList()

    
public DTMChildIterNodeList(DTM parentDTM, int parentHandle)
Public constructor: Create a NodeList to support DTMNodeProxy.getChildren(). Unfortunately AxisIterators and DTMIterators don't share an API, so I can't use the existing Axis.CHILD iterator. Rather than create Yet Another Class, let's set up a special case of this one.

param
parentDTM The DTM containing this node
param
parentHandle DTM node-handle integer

        m_parentDTM=parentDTM;
        m_firstChild=parentDTM.getFirstChild(parentHandle);
    
Methods Summary
public intgetLength()
The number of nodes in the list. The range of valid child node indices is 0 to length-1 inclusive.

        int count=0;
        for (int handle=m_firstChild;
             handle!=DTM.NULL;
             handle=m_parentDTM.getNextSibling(handle)) {
            ++count;
        }
        return count;
    
public org.w3c.dom.Nodeitem(int index)
Returns the indexth item in the collection. If index is greater than or equal to the number of nodes in the list, this returns null.

param
index Index into the collection.
return
The node at the indexth position in the NodeList, or null if that is not a valid index.

        int handle=m_firstChild;
        while(--index>=0 && handle!=DTM.NULL) {
            handle=m_parentDTM.getNextSibling(handle);
        }
        if (handle == DTM.NULL) {
            return null;
        }
        return m_parentDTM.getNode(handle);