blob: e6ae80fdfd66502e0d47260c37fc24649c26943c [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: DTMChildIterNodeList.java 468653 2006-10-28 07:07:05Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xml.dtm.ref;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.xml.dtm.DTM;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.w3c.dom.Node;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> /**<a name="line.26"></a>
<FONT color="green">027</FONT> * &lt;code&gt;DTMNodeList&lt;/code&gt; gives us an implementation of the DOM's<a name="line.27"></a>
<FONT color="green">028</FONT> * NodeList interface wrapped around a DTM Iterator. The author<a name="line.28"></a>
<FONT color="green">029</FONT> * considers this something of an abominations, since NodeList was not<a name="line.29"></a>
<FONT color="green">030</FONT> * intended to be a general purpose "list of nodes" API and is<a name="line.30"></a>
<FONT color="green">031</FONT> * generally considered by the DOM WG to have be a mistake... but I'm<a name="line.31"></a>
<FONT color="green">032</FONT> * told that some of the XPath/XSLT folks say they must have this<a name="line.32"></a>
<FONT color="green">033</FONT> * solution.<a name="line.33"></a>
<FONT color="green">034</FONT> *<a name="line.34"></a>
<FONT color="green">035</FONT> * Please note that this is not necessarily equivlaent to a DOM<a name="line.35"></a>
<FONT color="green">036</FONT> * NodeList operating over the same document. In particular:<a name="line.36"></a>
<FONT color="green">037</FONT> * &lt;ul&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> *<a name="line.38"></a>
<FONT color="green">039</FONT> * &lt;li&gt;If there are several Text nodes in logical succession (ie,<a name="line.39"></a>
<FONT color="green">040</FONT> * across CDATASection and EntityReference boundaries), we will return<a name="line.40"></a>
<FONT color="green">041</FONT> * only the first; the caller is responsible for stepping through<a name="line.41"></a>
<FONT color="green">042</FONT> * them.<a name="line.42"></a>
<FONT color="green">043</FONT> * (%REVIEW% Provide a convenience routine here to assist, pending<a name="line.43"></a>
<FONT color="green">044</FONT> * proposed DOM Level 3 getAdjacentText() operation?) &lt;/li&gt;<a name="line.44"></a>
<FONT color="green">045</FONT> *<a name="line.45"></a>
<FONT color="green">046</FONT> * &lt;li&gt;Since the whole XPath/XSLT architecture assumes that the source<a name="line.46"></a>
<FONT color="green">047</FONT> * document is not altered while we're working with it, we do not<a name="line.47"></a>
<FONT color="green">048</FONT> * promise to implement the DOM NodeList's "live view" response to<a name="line.48"></a>
<FONT color="green">049</FONT> * document mutation. &lt;/li&gt;<a name="line.49"></a>
<FONT color="green">050</FONT> *<a name="line.50"></a>
<FONT color="green">051</FONT> * &lt;/ul&gt;<a name="line.51"></a>
<FONT color="green">052</FONT> *<a name="line.52"></a>
<FONT color="green">053</FONT> * &lt;p&gt;State: In progress!!&lt;/p&gt;<a name="line.53"></a>
<FONT color="green">054</FONT> * */<a name="line.54"></a>
<FONT color="green">055</FONT> public class DTMChildIterNodeList extends DTMNodeListBase {<a name="line.55"></a>
<FONT color="green">056</FONT> private int m_firstChild;<a name="line.56"></a>
<FONT color="green">057</FONT> private DTM m_parentDTM;<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> //================================================================<a name="line.59"></a>
<FONT color="green">060</FONT> // Methods unique to this class<a name="line.60"></a>
<FONT color="green">061</FONT> private DTMChildIterNodeList() {<a name="line.61"></a>
<FONT color="green">062</FONT> }<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> /**<a name="line.64"></a>
<FONT color="green">065</FONT> * Public constructor: Create a NodeList to support<a name="line.65"></a>
<FONT color="green">066</FONT> * DTMNodeProxy.getChildren().<a name="line.66"></a>
<FONT color="green">067</FONT> *<a name="line.67"></a>
<FONT color="green">068</FONT> * Unfortunately AxisIterators and DTMIterators don't share an API,<a name="line.68"></a>
<FONT color="green">069</FONT> * so I can't use the existing Axis.CHILD iterator. Rather than<a name="line.69"></a>
<FONT color="green">070</FONT> * create Yet Another Class, let's set up a special case of this<a name="line.70"></a>
<FONT color="green">071</FONT> * one.<a name="line.71"></a>
<FONT color="green">072</FONT> *<a name="line.72"></a>
<FONT color="green">073</FONT> * @param parentDTM The DTM containing this node<a name="line.73"></a>
<FONT color="green">074</FONT> * @param parentHandle DTM node-handle integer<a name="line.74"></a>
<FONT color="green">075</FONT> *<a name="line.75"></a>
<FONT color="green">076</FONT> */<a name="line.76"></a>
<FONT color="green">077</FONT> public DTMChildIterNodeList(DTM parentDTM,int parentHandle) {<a name="line.77"></a>
<FONT color="green">078</FONT> m_parentDTM=parentDTM;<a name="line.78"></a>
<FONT color="green">079</FONT> m_firstChild=parentDTM.getFirstChild(parentHandle);<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> <a name="line.82"></a>
<FONT color="green">083</FONT> //================================================================<a name="line.83"></a>
<FONT color="green">084</FONT> // org.w3c.dom.NodeList API follows<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> /**<a name="line.86"></a>
<FONT color="green">087</FONT> * Returns the &lt;code&gt;index&lt;/code&gt;th item in the collection. If <a name="line.87"></a>
<FONT color="green">088</FONT> * &lt;code&gt;index&lt;/code&gt; is greater than or equal to the number of nodes in <a name="line.88"></a>
<FONT color="green">089</FONT> * the list, this returns &lt;code&gt;null&lt;/code&gt;.<a name="line.89"></a>
<FONT color="green">090</FONT> * @param index Index into the collection.<a name="line.90"></a>
<FONT color="green">091</FONT> * @return The node at the &lt;code&gt;index&lt;/code&gt;th position in the <a name="line.91"></a>
<FONT color="green">092</FONT> * &lt;code&gt;NodeList&lt;/code&gt;, or &lt;code&gt;null&lt;/code&gt; if that is not a valid <a name="line.92"></a>
<FONT color="green">093</FONT> * index.<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> public Node item(int index) {<a name="line.95"></a>
<FONT color="green">096</FONT> int handle=m_firstChild;<a name="line.96"></a>
<FONT color="green">097</FONT> while(--index&gt;=0 &amp;&amp; handle!=DTM.NULL) {<a name="line.97"></a>
<FONT color="green">098</FONT> handle=m_parentDTM.getNextSibling(handle);<a name="line.98"></a>
<FONT color="green">099</FONT> }<a name="line.99"></a>
<FONT color="green">100</FONT> if (handle == DTM.NULL) {<a name="line.100"></a>
<FONT color="green">101</FONT> return null;<a name="line.101"></a>
<FONT color="green">102</FONT> }<a name="line.102"></a>
<FONT color="green">103</FONT> return m_parentDTM.getNode(handle);<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
<FONT color="green">105</FONT> <a name="line.105"></a>
<FONT color="green">106</FONT> /**<a name="line.106"></a>
<FONT color="green">107</FONT> * The number of nodes in the list. The range of valid child node indices <a name="line.107"></a>
<FONT color="green">108</FONT> * is 0 to &lt;code&gt;length-1&lt;/code&gt; inclusive. <a name="line.108"></a>
<FONT color="green">109</FONT> */<a name="line.109"></a>
<FONT color="green">110</FONT> public int getLength() {<a name="line.110"></a>
<FONT color="green">111</FONT> int count=0;<a name="line.111"></a>
<FONT color="green">112</FONT> for (int handle=m_firstChild;<a name="line.112"></a>
<FONT color="green">113</FONT> handle!=DTM.NULL;<a name="line.113"></a>
<FONT color="green">114</FONT> handle=m_parentDTM.getNextSibling(handle)) {<a name="line.114"></a>
<FONT color="green">115</FONT> ++count;<a name="line.115"></a>
<FONT color="green">116</FONT> }<a name="line.116"></a>
<FONT color="green">117</FONT> return count;<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
</PRE>
</BODY>
</HTML>