org.apache.xml.dtm.ref
Class DTMNodeList

java.lang.Object
  org.apache.xml.dtm.ref.DTMNodeList

All Implemented Interfaces:

org.w3c.dom.NodeList

public class DTMNodeList

extends Object

implements org.w3c.dom.NodeList

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

private DTMIterator	dtm_iter
private int	m_firstChild
private DTM	m_parentDTM
private boolean	valid

Constructor Summary

DTMNodeList(DTM parentDTM, int parentHandle)
Public constructor: Create a NodeList to support DTMNodeProxy.getChildren().

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

(package private) DTMIterator	getDTMIterator() Access the wrapped DTMIterator.
int	getLength() The number of nodes in the list.
org.w3c.dom.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

Field Detail

dtm_iter

private DTMIterator dtm_iter

valid

private boolean valid

m_firstChild

private int m_firstChild

m_parentDTM

private DTM m_parentDTM

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.

DTMNodeList

public DTMNodeList(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.

Parameters:

parentDTM - The DTM containing this node

parentHandle - DTM node-handle integer

Method Detail

getDTMIterator

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 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 org.w3c.dom.NodeList

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 org.w3c.dom.NodeList