blob: 70dbe98f672a586934f3fc9dce2415da4bed89dd [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: DTMAxisIteratorBase.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.DTMAxisIterator;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * This class serves as a default base for implementations of mutable<a name="line.26"></a>
<FONT color="green">027</FONT> * DTMAxisIterators.<a name="line.27"></a>
<FONT color="green">028</FONT> */<a name="line.28"></a>
<FONT color="green">029</FONT> public abstract class DTMAxisIteratorBase implements DTMAxisIterator<a name="line.29"></a>
<FONT color="green">030</FONT> {<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> /** The position of the last node within the iteration, as defined by XPath.<a name="line.32"></a>
<FONT color="green">033</FONT> * Note that this is _not_ the node's handle within the DTM. Also, don't<a name="line.33"></a>
<FONT color="green">034</FONT> * confuse it with the current (most recently returned) position.<a name="line.34"></a>
<FONT color="green">035</FONT> */<a name="line.35"></a>
<FONT color="green">036</FONT> protected int _last = -1;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /** The position of the current node within the iteration, as defined by XPath.<a name="line.38"></a>
<FONT color="green">039</FONT> * Note that this is _not_ the node's handle within the DTM!<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> protected int _position = 0;<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /** The position of the marked node within the iteration;<a name="line.43"></a>
<FONT color="green">044</FONT> * a saved itaration state that we may want to come back to.<a name="line.44"></a>
<FONT color="green">045</FONT> * Note that only one mark is maintained; there is no stack.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> protected int _markedNode;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> /** The handle to the start, or root, of the iteration.<a name="line.49"></a>
<FONT color="green">050</FONT> * Set this to END to construct an empty iterator.<a name="line.50"></a>
<FONT color="green">051</FONT> */<a name="line.51"></a>
<FONT color="green">052</FONT> protected int _startNode = DTMAxisIterator.END;<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> /** True if the start node should be considered part of the iteration.<a name="line.54"></a>
<FONT color="green">055</FONT> * False will cause it to be skipped.<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> protected boolean _includeSelf = false;<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> /** True if this iteration can be restarted. False otherwise (eg, if<a name="line.59"></a>
<FONT color="green">060</FONT> * we are iterating over a stream that can not be re-scanned, or if<a name="line.60"></a>
<FONT color="green">061</FONT> * the iterator was produced by cloning another iterator.)<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> protected boolean _isRestartable = true;<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> /**<a name="line.65"></a>
<FONT color="green">066</FONT> * Get start to END should 'close' the iterator,<a name="line.66"></a>
<FONT color="green">067</FONT> * i.e. subsequent call to next() should return END.<a name="line.67"></a>
<FONT color="green">068</FONT> *<a name="line.68"></a>
<FONT color="green">069</FONT> * @return The root node of the iteration.<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> public int getStartNode()<a name="line.71"></a>
<FONT color="green">072</FONT> {<a name="line.72"></a>
<FONT color="green">073</FONT> return _startNode;<a name="line.73"></a>
<FONT color="green">074</FONT> }<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> * @return A DTMAxisIterator which has been reset to the start node,<a name="line.77"></a>
<FONT color="green">078</FONT> * which may or may not be the same as this iterator.<a name="line.78"></a>
<FONT color="green">079</FONT> * */<a name="line.79"></a>
<FONT color="green">080</FONT> public DTMAxisIterator reset()<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> final boolean temp = _isRestartable;<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> _isRestartable = true;<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> setStartNode(_startNode);<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> _isRestartable = temp;<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> return this;<a name="line.91"></a>
<FONT color="green">092</FONT> }<a name="line.92"></a>
<FONT color="green">093</FONT> <a name="line.93"></a>
<FONT color="green">094</FONT> /**<a name="line.94"></a>
<FONT color="green">095</FONT> * Set the flag to include the start node in the iteration. <a name="line.95"></a>
<FONT color="green">096</FONT> *<a name="line.96"></a>
<FONT color="green">097</FONT> *<a name="line.97"></a>
<FONT color="green">098</FONT> * @return This default method returns just returns this DTMAxisIterator,<a name="line.98"></a>
<FONT color="green">099</FONT> * after setting the flag.<a name="line.99"></a>
<FONT color="green">100</FONT> * (Returning "this" permits C++-style chaining of<a name="line.100"></a>
<FONT color="green">101</FONT> * method calls into a single expression.)<a name="line.101"></a>
<FONT color="green">102</FONT> */<a name="line.102"></a>
<FONT color="green">103</FONT> public DTMAxisIterator includeSelf()<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> _includeSelf = true;<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> return this;<a name="line.108"></a>
<FONT color="green">109</FONT> }<a name="line.109"></a>
<FONT color="green">110</FONT> <a name="line.110"></a>
<FONT color="green">111</FONT> /** Returns the position of the last node within the iteration, as<a name="line.111"></a>
<FONT color="green">112</FONT> * defined by XPath. In a forward iterator, I believe this equals the number of nodes which this<a name="line.112"></a>
<FONT color="green">113</FONT> * iterator will yield. In a reverse iterator, I believe it should return<a name="line.113"></a>
<FONT color="green">114</FONT> * 1 (since the "last" is the first produced.)<a name="line.114"></a>
<FONT color="green">115</FONT> *<a name="line.115"></a>
<FONT color="green">116</FONT> * This may be an expensive operation when called the first time, since<a name="line.116"></a>
<FONT color="green">117</FONT> * it may have to iterate through a large part of the document to produce<a name="line.117"></a>
<FONT color="green">118</FONT> * its answer.<a name="line.118"></a>
<FONT color="green">119</FONT> *<a name="line.119"></a>
<FONT color="green">120</FONT> * @return The number of nodes in this iterator (forward) or 1 (reverse).<a name="line.120"></a>
<FONT color="green">121</FONT> */<a name="line.121"></a>
<FONT color="green">122</FONT> public int getLast()<a name="line.122"></a>
<FONT color="green">123</FONT> {<a name="line.123"></a>
<FONT color="green">124</FONT> <a name="line.124"></a>
<FONT color="green">125</FONT> if (_last == -1) // Not previously established<a name="line.125"></a>
<FONT color="green">126</FONT> {<a name="line.126"></a>
<FONT color="green">127</FONT> // Note that we're doing both setMark() -- which saves _currentChild<a name="line.127"></a>
<FONT color="green">128</FONT> // -- and explicitly saving our position counter (number of nodes<a name="line.128"></a>
<FONT color="green">129</FONT> // yielded so far).<a name="line.129"></a>
<FONT color="green">130</FONT> //<a name="line.130"></a>
<FONT color="green">131</FONT> // %REVIEW% Should position also be saved by setMark()?<a name="line.131"></a>
<FONT color="green">132</FONT> // (It wasn't in the XSLTC version, but I don't understand why not.)<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> final int temp = _position; // Save state<a name="line.134"></a>
<FONT color="green">135</FONT> setMark();<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> reset(); // Count the nodes found by this iterator<a name="line.137"></a>
<FONT color="green">138</FONT> do<a name="line.138"></a>
<FONT color="green">139</FONT> {<a name="line.139"></a>
<FONT color="green">140</FONT> _last++;<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> while (next() != END);<a name="line.142"></a>
<FONT color="green">143</FONT> <a name="line.143"></a>
<FONT color="green">144</FONT> gotoMark(); // Restore saved state<a name="line.144"></a>
<FONT color="green">145</FONT> _position = temp;<a name="line.145"></a>
<FONT color="green">146</FONT> }<a name="line.146"></a>
<FONT color="green">147</FONT> <a name="line.147"></a>
<FONT color="green">148</FONT> return _last;<a name="line.148"></a>
<FONT color="green">149</FONT> }<a name="line.149"></a>
<FONT color="green">150</FONT> <a name="line.150"></a>
<FONT color="green">151</FONT> /**<a name="line.151"></a>
<FONT color="green">152</FONT> * @return The position of the current node within the set, as defined by<a name="line.152"></a>
<FONT color="green">153</FONT> * XPath. Note that this is one-based, not zero-based.<a name="line.153"></a>
<FONT color="green">154</FONT> */<a name="line.154"></a>
<FONT color="green">155</FONT> public int getPosition()<a name="line.155"></a>
<FONT color="green">156</FONT> {<a name="line.156"></a>
<FONT color="green">157</FONT> return _position == 0 ? 1 : _position;<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> <a name="line.159"></a>
<FONT color="green">160</FONT> /**<a name="line.160"></a>
<FONT color="green">161</FONT> * @return true if this iterator has a reversed axis, else false<a name="line.161"></a>
<FONT color="green">162</FONT> */<a name="line.162"></a>
<FONT color="green">163</FONT> public boolean isReverse()<a name="line.163"></a>
<FONT color="green">164</FONT> {<a name="line.164"></a>
<FONT color="green">165</FONT> return false;<a name="line.165"></a>
<FONT color="green">166</FONT> }<a name="line.166"></a>
<FONT color="green">167</FONT> <a name="line.167"></a>
<FONT color="green">168</FONT> /**<a name="line.168"></a>
<FONT color="green">169</FONT> * Returns a deep copy of this iterator. Cloned iterators may not be<a name="line.169"></a>
<FONT color="green">170</FONT> * restartable. The iterator being cloned may or may not become<a name="line.170"></a>
<FONT color="green">171</FONT> * non-restartable as a side effect of this operation.<a name="line.171"></a>
<FONT color="green">172</FONT> *<a name="line.172"></a>
<FONT color="green">173</FONT> * @return a deep copy of this iterator.<a name="line.173"></a>
<FONT color="green">174</FONT> */<a name="line.174"></a>
<FONT color="green">175</FONT> public DTMAxisIterator cloneIterator()<a name="line.175"></a>
<FONT color="green">176</FONT> {<a name="line.176"></a>
<FONT color="green">177</FONT> <a name="line.177"></a>
<FONT color="green">178</FONT> try<a name="line.178"></a>
<FONT color="green">179</FONT> {<a name="line.179"></a>
<FONT color="green">180</FONT> final DTMAxisIteratorBase clone = (DTMAxisIteratorBase) super.clone();<a name="line.180"></a>
<FONT color="green">181</FONT> <a name="line.181"></a>
<FONT color="green">182</FONT> clone._isRestartable = false;<a name="line.182"></a>
<FONT color="green">183</FONT> <a name="line.183"></a>
<FONT color="green">184</FONT> // return clone.reset();<a name="line.184"></a>
<FONT color="green">185</FONT> return clone;<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> catch (CloneNotSupportedException e)<a name="line.187"></a>
<FONT color="green">188</FONT> {<a name="line.188"></a>
<FONT color="green">189</FONT> throw new org.apache.xml.utils.WrappedRuntimeException(e);<a name="line.189"></a>
<FONT color="green">190</FONT> }<a name="line.190"></a>
<FONT color="green">191</FONT> }<a name="line.191"></a>
<FONT color="green">192</FONT> <a name="line.192"></a>
<FONT color="green">193</FONT> /**<a name="line.193"></a>
<FONT color="green">194</FONT> * Do any final cleanup that is required before returning the node that was<a name="line.194"></a>
<FONT color="green">195</FONT> * passed in, and then return it. The intended use is<a name="line.195"></a>
<FONT color="green">196</FONT> * &lt;br /&gt;<a name="line.196"></a>
<FONT color="green">197</FONT> * &lt;code&gt;return returnNode(node);&lt;/code&gt;<a name="line.197"></a>
<FONT color="green">198</FONT> *<a name="line.198"></a>
<FONT color="green">199</FONT> * %REVIEW% If we're calling it purely for side effects, should we really<a name="line.199"></a>
<FONT color="green">200</FONT> * be bothering with a return value? Something like<a name="line.200"></a>
<FONT color="green">201</FONT> * &lt;br /&gt;<a name="line.201"></a>
<FONT color="green">202</FONT> * &lt;code&gt; accept(node); return node; &lt;/code&gt;<a name="line.202"></a>
<FONT color="green">203</FONT> * &lt;br /&gt;<a name="line.203"></a>
<FONT color="green">204</FONT> * would probably optimize just about as well and avoid questions<a name="line.204"></a>
<FONT color="green">205</FONT> * about whether what's returned could ever be different from what's<a name="line.205"></a>
<FONT color="green">206</FONT> * passed in.<a name="line.206"></a>
<FONT color="green">207</FONT> *<a name="line.207"></a>
<FONT color="green">208</FONT> * @param node Node handle which iteration is about to yield.<a name="line.208"></a>
<FONT color="green">209</FONT> *<a name="line.209"></a>
<FONT color="green">210</FONT> * @return The node handle passed in. */<a name="line.210"></a>
<FONT color="green">211</FONT> protected final int returnNode(final int node)<a name="line.211"></a>
<FONT color="green">212</FONT> {<a name="line.212"></a>
<FONT color="green">213</FONT> _position++;<a name="line.213"></a>
<FONT color="green">214</FONT> <a name="line.214"></a>
<FONT color="green">215</FONT> return node;<a name="line.215"></a>
<FONT color="green">216</FONT> }<a name="line.216"></a>
<FONT color="green">217</FONT> <a name="line.217"></a>
<FONT color="green">218</FONT> /**<a name="line.218"></a>
<FONT color="green">219</FONT> * Reset the position to zero. NOTE that this does not change the iteration<a name="line.219"></a>
<FONT color="green">220</FONT> * state, only the position number associated with that state.<a name="line.220"></a>
<FONT color="green">221</FONT> *<a name="line.221"></a>
<FONT color="green">222</FONT> * %REVIEW% Document when this would be used?<a name="line.222"></a>
<FONT color="green">223</FONT> *<a name="line.223"></a>
<FONT color="green">224</FONT> * @return This instance.<a name="line.224"></a>
<FONT color="green">225</FONT> */<a name="line.225"></a>
<FONT color="green">226</FONT> protected final DTMAxisIterator resetPosition()<a name="line.226"></a>
<FONT color="green">227</FONT> {<a name="line.227"></a>
<FONT color="green">228</FONT> <a name="line.228"></a>
<FONT color="green">229</FONT> _position = 0;<a name="line.229"></a>
<FONT color="green">230</FONT> <a name="line.230"></a>
<FONT color="green">231</FONT> return this;<a name="line.231"></a>
<FONT color="green">232</FONT> }<a name="line.232"></a>
<FONT color="green">233</FONT> <a name="line.233"></a>
<FONT color="green">234</FONT> /**<a name="line.234"></a>
<FONT color="green">235</FONT> * Returns true if all the nodes in the iteration well be returned in document <a name="line.235"></a>
<FONT color="green">236</FONT> * order.<a name="line.236"></a>
<FONT color="green">237</FONT> * <a name="line.237"></a>
<FONT color="green">238</FONT> * @return true as a default.<a name="line.238"></a>
<FONT color="green">239</FONT> */<a name="line.239"></a>
<FONT color="green">240</FONT> public boolean isDocOrdered()<a name="line.240"></a>
<FONT color="green">241</FONT> {<a name="line.241"></a>
<FONT color="green">242</FONT> return true;<a name="line.242"></a>
<FONT color="green">243</FONT> }<a name="line.243"></a>
<FONT color="green">244</FONT> <a name="line.244"></a>
<FONT color="green">245</FONT> /**<a name="line.245"></a>
<FONT color="green">246</FONT> * Returns the axis being iterated, if it is known.<a name="line.246"></a>
<FONT color="green">247</FONT> * <a name="line.247"></a>
<FONT color="green">248</FONT> * @return Axis.CHILD, etc., or -1 if the axis is not known or is of multiple <a name="line.248"></a>
<FONT color="green">249</FONT> * types.<a name="line.249"></a>
<FONT color="green">250</FONT> */<a name="line.250"></a>
<FONT color="green">251</FONT> public int getAxis()<a name="line.251"></a>
<FONT color="green">252</FONT> {<a name="line.252"></a>
<FONT color="green">253</FONT> return -1;<a name="line.253"></a>
<FONT color="green">254</FONT> }<a name="line.254"></a>
<FONT color="green">255</FONT> <a name="line.255"></a>
<FONT color="green">256</FONT> public void setRestartable(boolean isRestartable) {<a name="line.256"></a>
<FONT color="green">257</FONT> _isRestartable = isRestartable;<a name="line.257"></a>
<FONT color="green">258</FONT> } <a name="line.258"></a>
<FONT color="green">259</FONT> <a name="line.259"></a>
<FONT color="green">260</FONT> /**<a name="line.260"></a>
<FONT color="green">261</FONT> * Return the node at the given position.<a name="line.261"></a>
<FONT color="green">262</FONT> * <a name="line.262"></a>
<FONT color="green">263</FONT> * @param position The position<a name="line.263"></a>
<FONT color="green">264</FONT> * @return The node at the given position.<a name="line.264"></a>
<FONT color="green">265</FONT> */<a name="line.265"></a>
<FONT color="green">266</FONT> public int getNodeByPosition(int position)<a name="line.266"></a>
<FONT color="green">267</FONT> {<a name="line.267"></a>
<FONT color="green">268</FONT> if (position &gt; 0) {<a name="line.268"></a>
<FONT color="green">269</FONT> final int pos = isReverse() ? getLast() - position + 1<a name="line.269"></a>
<FONT color="green">270</FONT> : position;<a name="line.270"></a>
<FONT color="green">271</FONT> int node;<a name="line.271"></a>
<FONT color="green">272</FONT> while ((node = next()) != DTMAxisIterator.END) {<a name="line.272"></a>
<FONT color="green">273</FONT> if (pos == getPosition()) {<a name="line.273"></a>
<FONT color="green">274</FONT> return node;<a name="line.274"></a>
<FONT color="green">275</FONT> }<a name="line.275"></a>
<FONT color="green">276</FONT> }<a name="line.276"></a>
<FONT color="green">277</FONT> }<a name="line.277"></a>
<FONT color="green">278</FONT> return END;<a name="line.278"></a>
<FONT color="green">279</FONT> }<a name="line.279"></a>
<FONT color="green">280</FONT> <a name="line.280"></a>
<FONT color="green">281</FONT> }<a name="line.281"></a>
</PRE>
</BODY>
</HTML>