Class DTMNodeList

  • All Implemented Interfaces:
    org.w3c.dom.NodeList

    public class DTMNodeList
    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!!

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private DTMIterator m_iter  
    • Constructor Summary

      Constructors 
      Constructor Description
      DTMNodeList​(DTMIterator dtmIterator)
      Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMIterator
    • Constructor Detail

      • DTMNodeList

        public DTMNodeList​(DTMIterator dtmIterator)
        Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMIterator

        WARNING: THIS HAS THE SIDE EFFECT OF ISSUING setShouldCacheNodes(true) AGAINST THE DTMIterator.

        Parameters:
        dtmIterator - the iterator to get the nodes from
    • Method Detail

      • getDTMIterator

        public DTMIterator getDTMIterator()
        Access the wrapped DTMIterator. I'm not sure whether anyone will need this or not, but let's write it and think about it.
        Returns:
        the wrapped DTMIterator
      • item

        public org.w3c.dom.Node item​(int index)
        Specified by:
        item in interface org.w3c.dom.NodeList
        Overrides:
        item in class DTMNodeListBase
      • getLength

        public int getLength()
        Specified by:
        getLength in interface org.w3c.dom.NodeList
        Overrides:
        getLength in class DTMNodeListBase