org.apache.xml.dtm.ref

Class DTMNodeList

Implemented Interfaces:
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:

State: In progress!!

Nested Class Summary

Constructor Summary

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

DTMIterator
getDTMIterator()
Access the wrapped DTMIterator.
int
getLength()
The number of nodes in the list.
Node
item(int index)
Returns the indexth item in the collection.

Methods inherited from class org.apache.xml.dtm.ref.DTMNodeListBase

getLength, item

Constructor Details

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 Details

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.


getLength

public int getLength()
The number of nodes in the list. The range of valid child node indices is 0 to length-1 inclusive.
Specified by:
getLength in interface NodeList
Overrides:
getLength in interface DTMNodeListBase


item

public Node item(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.
Specified by:
item in interface NodeList
Overrides:
item in interface DTMNodeListBase

Parameters:

Returns:
The node at the indexth position in the NodeList, or null if that is not a valid index.


Copyright B) 2004 Apache XML Project. All Rights Reserved.