blob: 1586910214d89a716411681072ee44a3195a33b2 [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: ReverseAxesWalker.java 513117 2007-03-01 03:28:52Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xpath.axes;<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.apache.xml.dtm.DTMAxisIterator;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xpath.XPathContext;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Walker for a reverse axes.<a name="line.28"></a>
<FONT color="green">029</FONT> * @see &lt;a href="http://www.w3.org/TR/xpath#predicates"&gt;XPath 2.4 Predicates&lt;/a&gt;<a name="line.29"></a>
<FONT color="green">030</FONT> */<a name="line.30"></a>
<FONT color="green">031</FONT> public class ReverseAxesWalker extends AxesWalker<a name="line.31"></a>
<FONT color="green">032</FONT> {<a name="line.32"></a>
<FONT color="green">033</FONT> static final long serialVersionUID = 2847007647832768941L;<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> /**<a name="line.35"></a>
<FONT color="green">036</FONT> * Construct an AxesWalker using a LocPathIterator.<a name="line.36"></a>
<FONT color="green">037</FONT> *<a name="line.37"></a>
<FONT color="green">038</FONT> * @param locPathIterator The location path iterator that 'owns' this walker.<a name="line.38"></a>
<FONT color="green">039</FONT> */<a name="line.39"></a>
<FONT color="green">040</FONT> ReverseAxesWalker(LocPathIterator locPathIterator, int axis)<a name="line.40"></a>
<FONT color="green">041</FONT> {<a name="line.41"></a>
<FONT color="green">042</FONT> super(locPathIterator, axis);<a name="line.42"></a>
<FONT color="green">043</FONT> }<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * Set the root node of the TreeWalker.<a name="line.46"></a>
<FONT color="green">047</FONT> * (Not part of the DOM2 TreeWalker interface).<a name="line.47"></a>
<FONT color="green">048</FONT> *<a name="line.48"></a>
<FONT color="green">049</FONT> * @param root The context node of this step.<a name="line.49"></a>
<FONT color="green">050</FONT> */<a name="line.50"></a>
<FONT color="green">051</FONT> public void setRoot(int root)<a name="line.51"></a>
<FONT color="green">052</FONT> {<a name="line.52"></a>
<FONT color="green">053</FONT> super.setRoot(root);<a name="line.53"></a>
<FONT color="green">054</FONT> m_iterator = getDTM(root).getAxisIterator(m_axis);<a name="line.54"></a>
<FONT color="green">055</FONT> m_iterator.setStartNode(root);<a name="line.55"></a>
<FONT color="green">056</FONT> }<a name="line.56"></a>
<FONT color="green">057</FONT> <a name="line.57"></a>
<FONT color="green">058</FONT> /**<a name="line.58"></a>
<FONT color="green">059</FONT> * Detaches the walker from the set which it iterated over, releasing<a name="line.59"></a>
<FONT color="green">060</FONT> * any computational resources and placing the iterator in the INVALID<a name="line.60"></a>
<FONT color="green">061</FONT> * state.<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> public void detach()<a name="line.63"></a>
<FONT color="green">064</FONT> {<a name="line.64"></a>
<FONT color="green">065</FONT> m_iterator = null;<a name="line.65"></a>
<FONT color="green">066</FONT> super.detach();<a name="line.66"></a>
<FONT color="green">067</FONT> }<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> /**<a name="line.69"></a>
<FONT color="green">070</FONT> * Get the next node in document order on the axes.<a name="line.70"></a>
<FONT color="green">071</FONT> *<a name="line.71"></a>
<FONT color="green">072</FONT> * @return the next node in document order on the axes, or null.<a name="line.72"></a>
<FONT color="green">073</FONT> */<a name="line.73"></a>
<FONT color="green">074</FONT> protected int getNextNode()<a name="line.74"></a>
<FONT color="green">075</FONT> {<a name="line.75"></a>
<FONT color="green">076</FONT> if (m_foundLast)<a name="line.76"></a>
<FONT color="green">077</FONT> return DTM.NULL;<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> int next = m_iterator.next();<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> if (m_isFresh)<a name="line.81"></a>
<FONT color="green">082</FONT> m_isFresh = false;<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> if (DTM.NULL == next)<a name="line.84"></a>
<FONT color="green">085</FONT> this.m_foundLast = true;<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> return next;<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> /**<a name="line.91"></a>
<FONT color="green">092</FONT> * Tells if this is a reverse axes. Overrides AxesWalker#isReverseAxes.<a name="line.92"></a>
<FONT color="green">093</FONT> *<a name="line.93"></a>
<FONT color="green">094</FONT> * @return true for this class.<a name="line.94"></a>
<FONT color="green">095</FONT> */<a name="line.95"></a>
<FONT color="green">096</FONT> public boolean isReverseAxes()<a name="line.96"></a>
<FONT color="green">097</FONT> {<a name="line.97"></a>
<FONT color="green">098</FONT> return true;<a name="line.98"></a>
<FONT color="green">099</FONT> }<a name="line.99"></a>
<FONT color="green">100</FONT> <a name="line.100"></a>
<FONT color="green">101</FONT> // /**<a name="line.101"></a>
<FONT color="green">102</FONT> // * Set the root node of the TreeWalker.<a name="line.102"></a>
<FONT color="green">103</FONT> // *<a name="line.103"></a>
<FONT color="green">104</FONT> // * @param root The context node of this step.<a name="line.104"></a>
<FONT color="green">105</FONT> // */<a name="line.105"></a>
<FONT color="green">106</FONT> // public void setRoot(int root)<a name="line.106"></a>
<FONT color="green">107</FONT> // {<a name="line.107"></a>
<FONT color="green">108</FONT> // super.setRoot(root);<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> /**<a name="line.111"></a>
<FONT color="green">112</FONT> * Get the current sub-context position. In order to do the<a name="line.112"></a>
<FONT color="green">113</FONT> * reverse axes count, for the moment this re-searches the axes<a name="line.113"></a>
<FONT color="green">114</FONT> * up to the predicate. An optimization on this is to cache<a name="line.114"></a>
<FONT color="green">115</FONT> * the nodes searched, but, for the moment, this case is probably<a name="line.115"></a>
<FONT color="green">116</FONT> * rare enough that the added complexity isn't worth it.<a name="line.116"></a>
<FONT color="green">117</FONT> *<a name="line.117"></a>
<FONT color="green">118</FONT> * @param predicateIndex The predicate index of the proximity position.<a name="line.118"></a>
<FONT color="green">119</FONT> *<a name="line.119"></a>
<FONT color="green">120</FONT> * @return The pridicate index, or -1.<a name="line.120"></a>
<FONT color="green">121</FONT> */<a name="line.121"></a>
<FONT color="green">122</FONT> protected int getProximityPosition(int predicateIndex)<a name="line.122"></a>
<FONT color="green">123</FONT> {<a name="line.123"></a>
<FONT color="green">124</FONT> // A negative predicate index seems to occur with<a name="line.124"></a>
<FONT color="green">125</FONT> // (preceding-sibling::*|following-sibling::*)/ancestor::*[position()]/*[position()]<a name="line.125"></a>
<FONT color="green">126</FONT> // -sb<a name="line.126"></a>
<FONT color="green">127</FONT> if(predicateIndex &lt; 0)<a name="line.127"></a>
<FONT color="green">128</FONT> return -1;<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> int count = m_proximityPositions[predicateIndex];<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> if (count &lt;= 0)<a name="line.132"></a>
<FONT color="green">133</FONT> {<a name="line.133"></a>
<FONT color="green">134</FONT> AxesWalker savedWalker = wi().getLastUsedWalker();<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> try<a name="line.136"></a>
<FONT color="green">137</FONT> {<a name="line.137"></a>
<FONT color="green">138</FONT> ReverseAxesWalker clone = (ReverseAxesWalker) this.clone();<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> clone.setRoot(this.getRoot());<a name="line.140"></a>
<FONT color="green">141</FONT> <a name="line.141"></a>
<FONT color="green">142</FONT> clone.setPredicateCount(predicateIndex);<a name="line.142"></a>
<FONT color="green">143</FONT> <a name="line.143"></a>
<FONT color="green">144</FONT> clone.setPrevWalker(null);<a name="line.144"></a>
<FONT color="green">145</FONT> clone.setNextWalker(null);<a name="line.145"></a>
<FONT color="green">146</FONT> wi().setLastUsedWalker(clone);<a name="line.146"></a>
<FONT color="green">147</FONT> <a name="line.147"></a>
<FONT color="green">148</FONT> // Count 'em all<a name="line.148"></a>
<FONT color="green">149</FONT> count++;<a name="line.149"></a>
<FONT color="green">150</FONT> int next;<a name="line.150"></a>
<FONT color="green">151</FONT> <a name="line.151"></a>
<FONT color="green">152</FONT> while (DTM.NULL != (next = clone.nextNode()))<a name="line.152"></a>
<FONT color="green">153</FONT> {<a name="line.153"></a>
<FONT color="green">154</FONT> count++;<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> <a name="line.156"></a>
<FONT color="green">157</FONT> m_proximityPositions[predicateIndex] = count;<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> catch (CloneNotSupportedException cnse)<a name="line.159"></a>
<FONT color="green">160</FONT> {<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> // can't happen<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> finally<a name="line.164"></a>
<FONT color="green">165</FONT> {<a name="line.165"></a>
<FONT color="green">166</FONT> wi().setLastUsedWalker(savedWalker);<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> <a name="line.169"></a>
<FONT color="green">170</FONT> return count;<a name="line.170"></a>
<FONT color="green">171</FONT> }<a name="line.171"></a>
<FONT color="green">172</FONT> <a name="line.172"></a>
<FONT color="green">173</FONT> /**<a name="line.173"></a>
<FONT color="green">174</FONT> * Count backwards one proximity position.<a name="line.174"></a>
<FONT color="green">175</FONT> *<a name="line.175"></a>
<FONT color="green">176</FONT> * @param i The predicate index.<a name="line.176"></a>
<FONT color="green">177</FONT> */<a name="line.177"></a>
<FONT color="green">178</FONT> protected void countProximityPosition(int i)<a name="line.178"></a>
<FONT color="green">179</FONT> {<a name="line.179"></a>
<FONT color="green">180</FONT> if (i &lt; m_proximityPositions.length)<a name="line.180"></a>
<FONT color="green">181</FONT> m_proximityPositions[i]--;<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> <a name="line.183"></a>
<FONT color="green">184</FONT> /**<a name="line.184"></a>
<FONT color="green">185</FONT> * Get the number of nodes in this node list. The function is probably ill<a name="line.185"></a>
<FONT color="green">186</FONT> * named?<a name="line.186"></a>
<FONT color="green">187</FONT> *<a name="line.187"></a>
<FONT color="green">188</FONT> *<a name="line.188"></a>
<FONT color="green">189</FONT> * @param xctxt The XPath runtime context.<a name="line.189"></a>
<FONT color="green">190</FONT> *<a name="line.190"></a>
<FONT color="green">191</FONT> * @return the number of nodes in this node list.<a name="line.191"></a>
<FONT color="green">192</FONT> */<a name="line.192"></a>
<FONT color="green">193</FONT> public int getLastPos(XPathContext xctxt)<a name="line.193"></a>
<FONT color="green">194</FONT> {<a name="line.194"></a>
<FONT color="green">195</FONT> <a name="line.195"></a>
<FONT color="green">196</FONT> int count = 0;<a name="line.196"></a>
<FONT color="green">197</FONT> AxesWalker savedWalker = wi().getLastUsedWalker();<a name="line.197"></a>
<FONT color="green">198</FONT> <a name="line.198"></a>
<FONT color="green">199</FONT> try<a name="line.199"></a>
<FONT color="green">200</FONT> {<a name="line.200"></a>
<FONT color="green">201</FONT> ReverseAxesWalker clone = (ReverseAxesWalker) this.clone();<a name="line.201"></a>
<FONT color="green">202</FONT> <a name="line.202"></a>
<FONT color="green">203</FONT> clone.setRoot(this.getRoot());<a name="line.203"></a>
<FONT color="green">204</FONT> <a name="line.204"></a>
<FONT color="green">205</FONT> clone.setPredicateCount(m_predicateIndex);<a name="line.205"></a>
<FONT color="green">206</FONT> <a name="line.206"></a>
<FONT color="green">207</FONT> clone.setPrevWalker(null);<a name="line.207"></a>
<FONT color="green">208</FONT> clone.setNextWalker(null);<a name="line.208"></a>
<FONT color="green">209</FONT> wi().setLastUsedWalker(clone);<a name="line.209"></a>
<FONT color="green">210</FONT> <a name="line.210"></a>
<FONT color="green">211</FONT> // Count 'em all<a name="line.211"></a>
<FONT color="green">212</FONT> // count = 1;<a name="line.212"></a>
<FONT color="green">213</FONT> int next;<a name="line.213"></a>
<FONT color="green">214</FONT> <a name="line.214"></a>
<FONT color="green">215</FONT> while (DTM.NULL != (next = clone.nextNode()))<a name="line.215"></a>
<FONT color="green">216</FONT> {<a name="line.216"></a>
<FONT color="green">217</FONT> count++;<a name="line.217"></a>
<FONT color="green">218</FONT> }<a name="line.218"></a>
<FONT color="green">219</FONT> }<a name="line.219"></a>
<FONT color="green">220</FONT> catch (CloneNotSupportedException cnse)<a name="line.220"></a>
<FONT color="green">221</FONT> {<a name="line.221"></a>
<FONT color="green">222</FONT> <a name="line.222"></a>
<FONT color="green">223</FONT> // can't happen<a name="line.223"></a>
<FONT color="green">224</FONT> }<a name="line.224"></a>
<FONT color="green">225</FONT> finally<a name="line.225"></a>
<FONT color="green">226</FONT> {<a name="line.226"></a>
<FONT color="green">227</FONT> wi().setLastUsedWalker(savedWalker);<a name="line.227"></a>
<FONT color="green">228</FONT> }<a name="line.228"></a>
<FONT color="green">229</FONT> <a name="line.229"></a>
<FONT color="green">230</FONT> return count;<a name="line.230"></a>
<FONT color="green">231</FONT> }<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> * Returns true if all the nodes in the iteration well be returned in document <a name="line.234"></a>
<FONT color="green">235</FONT> * order.<a name="line.235"></a>
<FONT color="green">236</FONT> * Warning: This can only be called after setRoot has been called!<a name="line.236"></a>
<FONT color="green">237</FONT> * <a name="line.237"></a>
<FONT color="green">238</FONT> * @return false.<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 false; // I think.<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> /** The DTM inner traversal class, that corresponds to the super axis. */<a name="line.245"></a>
<FONT color="green">246</FONT> protected DTMAxisIterator m_iterator;<a name="line.246"></a>
<FONT color="green">247</FONT> }<a name="line.247"></a>
</PRE>
</BODY>
</HTML>