Package org.apache.xml.dtm.ref
Class DTMNodeList
- java.lang.Object
-
- org.apache.xml.dtm.ref.DTMNodeListBase
-
- org.apache.xml.dtm.ref.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!!
-
-
Constructor Summary
Constructors Constructor Description 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DTMIterator
getDTMIterator()
Access the wrapped DTMIterator.int
getLength()
The number of nodes in the list.org.w3c.dom.Node
item(int index)
Returns theindex
th item in the collection.
-
-
-
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.
-
-
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.
-
item
public org.w3c.dom.Node item(int index)
Returns theindex
th item in the collection. Ifindex
is greater than or equal to the number of nodes in the list, this returnsnull
.- Specified by:
item
in interfaceorg.w3c.dom.NodeList
- Overrides:
item
in classDTMNodeListBase
- Parameters:
index
- Index into the collection.- Returns:
- The node at the
index
th position in theNodeList
, ornull
if that is not a valid index.
-
getLength
public int getLength()
The number of nodes in the list. The range of valid child node indices is 0 tolength-1
inclusive.- Specified by:
getLength
in interfaceorg.w3c.dom.NodeList
- Overrides:
getLength
in classDTMNodeListBase
-
-