org.apache.xml.dtm.ref

Class DTMAxisIterNodeList

java.lang.Object

org.apache.xml.dtm.ref.DTMNodeListBase

org.apache.xml.dtm.ref.DTMAxisIterNodeList

All Implemented Interfaces:

NodeList

public class DTMAxisIterNodeList
extends DTMNodeListBase

DTMAxisNodeList 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 and Description
DTMAxisIterNodeList(DTM dtm, DTMAxisIterator dtmAxisIterator) Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMAxisIterator

Method Summary

Modifier and Type	Method and Description
DTMAxisIterator	getDTMAxisIterator() 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DTMAxisIterNodeList

public DTMAxisIterNodeList(DTM dtm,
                           DTMAxisIterator dtmAxisIterator)

Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMAxisIterator

Method Detail

getDTMAxisIterator

public DTMAxisIterator getDTMAxisIterator()

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 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 class DTMNodeListBase

Parameters:

index - Index into the collection.

Returns:

The node at the indexth position in the NodeList, or null 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 to length-1 inclusive.

Specified by:

getLength in interface NodeList

Overrides:

getLength in class DTMNodeListBase