blob: 3dafd6c84bdf3a8ad9b45dcc038ab9cf47d6d528 [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: ElemForEach.java 468643 2006-10-28 06:56:03Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xalan.templates;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Vector;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import javax.xml.transform.TransformerException;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xalan.transformer.NodeSorter;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xalan.transformer.TransformerImpl;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xml.dtm.DTM;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xml.dtm.DTMIterator;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.xml.dtm.DTMManager;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.xml.utils.IntStack;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xpath.Expression;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.xpath.ExpressionOwner;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.xpath.XPath;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.apache.xpath.XPathContext;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> import java.io.ObjectInputStream;<a name="line.38"></a>
<FONT color="green">039</FONT> import java.io.IOException;<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> /**<a name="line.41"></a>
<FONT color="green">042</FONT> * Implement xsl:for-each.<a name="line.42"></a>
<FONT color="green">043</FONT> * &lt;pre&gt;<a name="line.43"></a>
<FONT color="green">044</FONT> * &lt;!ELEMENT xsl:for-each<a name="line.44"></a>
<FONT color="green">045</FONT> * (#PCDATA<a name="line.45"></a>
<FONT color="green">046</FONT> * %instructions;<a name="line.46"></a>
<FONT color="green">047</FONT> * %result-elements;<a name="line.47"></a>
<FONT color="green">048</FONT> * | xsl:sort)<a name="line.48"></a>
<FONT color="green">049</FONT> * &gt;<a name="line.49"></a>
<FONT color="green">050</FONT> *<a name="line.50"></a>
<FONT color="green">051</FONT> * &lt;!ATTLIST xsl:for-each<a name="line.51"></a>
<FONT color="green">052</FONT> * select %expr; #REQUIRED<a name="line.52"></a>
<FONT color="green">053</FONT> * %space-att;<a name="line.53"></a>
<FONT color="green">054</FONT> * &gt;<a name="line.54"></a>
<FONT color="green">055</FONT> * &lt;/pre&gt;<a name="line.55"></a>
<FONT color="green">056</FONT> * @see &lt;a href="http://www.w3.org/TR/xslt#for-each"&gt;for-each in XSLT Specification&lt;/a&gt;<a name="line.56"></a>
<FONT color="green">057</FONT> * @xsl.usage advanced<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> public class ElemForEach extends ElemTemplateElement implements ExpressionOwner<a name="line.59"></a>
<FONT color="green">060</FONT> {<a name="line.60"></a>
<FONT color="green">061</FONT> static final long serialVersionUID = 6018140636363583690L;<a name="line.61"></a>
<FONT color="green">062</FONT> /** Set true to request some basic status reports */<a name="line.62"></a>
<FONT color="green">063</FONT> static final boolean DEBUG = false;<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> * This is set by an "xalan-doc-cache-off" pi, or the old "xalan:doc-cache-off" pi.<a name="line.66"></a>
<FONT color="green">067</FONT> * The old form of the PI only works for XML parsers that are not namespace aware.<a name="line.67"></a>
<FONT color="green">068</FONT> * It tells the engine that<a name="line.68"></a>
<FONT color="green">069</FONT> * documents created in the location paths executed by this element<a name="line.69"></a>
<FONT color="green">070</FONT> * will not be reparsed. It's set by StylesheetHandler during<a name="line.70"></a>
<FONT color="green">071</FONT> * construction. Note that this feature applies _only_ to xsl:for-each<a name="line.71"></a>
<FONT color="green">072</FONT> * elements in its current incarnation; a more general cache management<a name="line.72"></a>
<FONT color="green">073</FONT> * solution is desperately needed.<a name="line.73"></a>
<FONT color="green">074</FONT> */<a name="line.74"></a>
<FONT color="green">075</FONT> public boolean m_doc_cache_off=false;<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * Construct a element representing xsl:for-each.<a name="line.78"></a>
<FONT color="green">079</FONT> */<a name="line.79"></a>
<FONT color="green">080</FONT> public ElemForEach(){}<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> * The "select" expression.<a name="line.83"></a>
<FONT color="green">084</FONT> * @serial<a name="line.84"></a>
<FONT color="green">085</FONT> */<a name="line.85"></a>
<FONT color="green">086</FONT> protected Expression m_selectExpression = null;<a name="line.86"></a>
<FONT color="green">087</FONT> <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> * Used to fix bug#16889<a name="line.90"></a>
<FONT color="green">091</FONT> * Store XPath away for later processing.<a name="line.91"></a>
<FONT color="green">092</FONT> */<a name="line.92"></a>
<FONT color="green">093</FONT> protected XPath m_xpath = null; <a name="line.93"></a>
<FONT color="green">094</FONT> <a name="line.94"></a>
<FONT color="green">095</FONT> /**<a name="line.95"></a>
<FONT color="green">096</FONT> * Set the "select" attribute.<a name="line.96"></a>
<FONT color="green">097</FONT> *<a name="line.97"></a>
<FONT color="green">098</FONT> * @param xpath The XPath expression for the "select" attribute.<a name="line.98"></a>
<FONT color="green">099</FONT> */<a name="line.99"></a>
<FONT color="green">100</FONT> public void setSelect(XPath xpath)<a name="line.100"></a>
<FONT color="green">101</FONT> {<a name="line.101"></a>
<FONT color="green">102</FONT> m_selectExpression = xpath.getExpression();<a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> // The following line is part of the codes added to fix bug#16889<a name="line.104"></a>
<FONT color="green">105</FONT> // Store xpath which will be needed when firing Selected Event<a name="line.105"></a>
<FONT color="green">106</FONT> m_xpath = xpath; <a name="line.106"></a>
<FONT color="green">107</FONT> }<a name="line.107"></a>
<FONT color="green">108</FONT> <a name="line.108"></a>
<FONT color="green">109</FONT> /**<a name="line.109"></a>
<FONT color="green">110</FONT> * Get the "select" attribute.<a name="line.110"></a>
<FONT color="green">111</FONT> *<a name="line.111"></a>
<FONT color="green">112</FONT> * @return The XPath expression for the "select" attribute.<a name="line.112"></a>
<FONT color="green">113</FONT> */<a name="line.113"></a>
<FONT color="green">114</FONT> public Expression getSelect()<a name="line.114"></a>
<FONT color="green">115</FONT> {<a name="line.115"></a>
<FONT color="green">116</FONT> return m_selectExpression;<a name="line.116"></a>
<FONT color="green">117</FONT> }<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>
<FONT color="green">120</FONT> * This function is called after everything else has been<a name="line.120"></a>
<FONT color="green">121</FONT> * recomposed, and allows the template to set remaining<a name="line.121"></a>
<FONT color="green">122</FONT> * values that may be based on some other property that<a name="line.122"></a>
<FONT color="green">123</FONT> * depends on recomposition.<a name="line.123"></a>
<FONT color="green">124</FONT> *<a name="line.124"></a>
<FONT color="green">125</FONT> * NEEDSDOC @param sroot<a name="line.125"></a>
<FONT color="green">126</FONT> *<a name="line.126"></a>
<FONT color="green">127</FONT> * @throws TransformerException<a name="line.127"></a>
<FONT color="green">128</FONT> */<a name="line.128"></a>
<FONT color="green">129</FONT> public void compose(StylesheetRoot sroot) throws TransformerException<a name="line.129"></a>
<FONT color="green">130</FONT> {<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> super.compose(sroot);<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> int length = getSortElemCount();<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> for (int i = 0; i &lt; length; i++)<a name="line.136"></a>
<FONT color="green">137</FONT> {<a name="line.137"></a>
<FONT color="green">138</FONT> getSortElem(i).compose(sroot);<a name="line.138"></a>
<FONT color="green">139</FONT> }<a name="line.139"></a>
<FONT color="green">140</FONT> <a name="line.140"></a>
<FONT color="green">141</FONT> java.util.Vector vnames = sroot.getComposeState().getVariableNames();<a name="line.141"></a>
<FONT color="green">142</FONT> <a name="line.142"></a>
<FONT color="green">143</FONT> if (null != m_selectExpression)<a name="line.143"></a>
<FONT color="green">144</FONT> m_selectExpression.fixupVariables(<a name="line.144"></a>
<FONT color="green">145</FONT> vnames, sroot.getComposeState().getGlobalsSize());<a name="line.145"></a>
<FONT color="green">146</FONT> else<a name="line.146"></a>
<FONT color="green">147</FONT> {<a name="line.147"></a>
<FONT color="green">148</FONT> m_selectExpression =<a name="line.148"></a>
<FONT color="green">149</FONT> getStylesheetRoot().m_selectDefault.getExpression();<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> <a name="line.152"></a>
<FONT color="green">153</FONT> /**<a name="line.153"></a>
<FONT color="green">154</FONT> * This after the template's children have been composed.<a name="line.154"></a>
<FONT color="green">155</FONT> */<a name="line.155"></a>
<FONT color="green">156</FONT> public void endCompose(StylesheetRoot sroot) throws TransformerException<a name="line.156"></a>
<FONT color="green">157</FONT> {<a name="line.157"></a>
<FONT color="green">158</FONT> int length = getSortElemCount();<a name="line.158"></a>
<FONT color="green">159</FONT> <a name="line.159"></a>
<FONT color="green">160</FONT> for (int i = 0; i &lt; length; i++)<a name="line.160"></a>
<FONT color="green">161</FONT> {<a name="line.161"></a>
<FONT color="green">162</FONT> getSortElem(i).endCompose(sroot);<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> super.endCompose(sroot);<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> // /**<a name="line.169"></a>
<FONT color="green">170</FONT> // * This function is called after everything else has been<a name="line.170"></a>
<FONT color="green">171</FONT> // * recomposed, and allows the template to set remaining<a name="line.171"></a>
<FONT color="green">172</FONT> // * values that may be based on some other property that<a name="line.172"></a>
<FONT color="green">173</FONT> // * depends on recomposition.<a name="line.173"></a>
<FONT color="green">174</FONT> // *<a name="line.174"></a>
<FONT color="green">175</FONT> // * @throws TransformerException<a name="line.175"></a>
<FONT color="green">176</FONT> // */<a name="line.176"></a>
<FONT color="green">177</FONT> // public void compose() throws TransformerException<a name="line.177"></a>
<FONT color="green">178</FONT> // {<a name="line.178"></a>
<FONT color="green">179</FONT> //<a name="line.179"></a>
<FONT color="green">180</FONT> // if (null == m_selectExpression)<a name="line.180"></a>
<FONT color="green">181</FONT> // {<a name="line.181"></a>
<FONT color="green">182</FONT> // m_selectExpression =<a name="line.182"></a>
<FONT color="green">183</FONT> // getStylesheetRoot().m_selectDefault.getExpression();<a name="line.183"></a>
<FONT color="green">184</FONT> // }<a name="line.184"></a>
<FONT color="green">185</FONT> // }<a name="line.185"></a>
<FONT color="green">186</FONT> <a name="line.186"></a>
<FONT color="green">187</FONT> /**<a name="line.187"></a>
<FONT color="green">188</FONT> * Vector containing the xsl:sort elements associated with this element.<a name="line.188"></a>
<FONT color="green">189</FONT> * @serial<a name="line.189"></a>
<FONT color="green">190</FONT> */<a name="line.190"></a>
<FONT color="green">191</FONT> protected Vector m_sortElems = null;<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> * Get the count xsl:sort elements associated with this element.<a name="line.194"></a>
<FONT color="green">195</FONT> * @return The number of xsl:sort elements.<a name="line.195"></a>
<FONT color="green">196</FONT> */<a name="line.196"></a>
<FONT color="green">197</FONT> public int getSortElemCount()<a name="line.197"></a>
<FONT color="green">198</FONT> {<a name="line.198"></a>
<FONT color="green">199</FONT> return (m_sortElems == null) ? 0 : m_sortElems.size();<a name="line.199"></a>
<FONT color="green">200</FONT> }<a name="line.200"></a>
<FONT color="green">201</FONT> <a name="line.201"></a>
<FONT color="green">202</FONT> /**<a name="line.202"></a>
<FONT color="green">203</FONT> * Get a xsl:sort element associated with this element.<a name="line.203"></a>
<FONT color="green">204</FONT> *<a name="line.204"></a>
<FONT color="green">205</FONT> * @param i Index of xsl:sort element to get<a name="line.205"></a>
<FONT color="green">206</FONT> *<a name="line.206"></a>
<FONT color="green">207</FONT> * @return xsl:sort element at given index<a name="line.207"></a>
<FONT color="green">208</FONT> */<a name="line.208"></a>
<FONT color="green">209</FONT> public ElemSort getSortElem(int i)<a name="line.209"></a>
<FONT color="green">210</FONT> {<a name="line.210"></a>
<FONT color="green">211</FONT> return (ElemSort) m_sortElems.elementAt(i);<a name="line.211"></a>
<FONT color="green">212</FONT> }<a name="line.212"></a>
<FONT color="green">213</FONT> <a name="line.213"></a>
<FONT color="green">214</FONT> /**<a name="line.214"></a>
<FONT color="green">215</FONT> * Set a xsl:sort element associated with this element.<a name="line.215"></a>
<FONT color="green">216</FONT> *<a name="line.216"></a>
<FONT color="green">217</FONT> * @param sortElem xsl:sort element to set<a name="line.217"></a>
<FONT color="green">218</FONT> */<a name="line.218"></a>
<FONT color="green">219</FONT> public void setSortElem(ElemSort sortElem)<a name="line.219"></a>
<FONT color="green">220</FONT> {<a name="line.220"></a>
<FONT color="green">221</FONT> <a name="line.221"></a>
<FONT color="green">222</FONT> if (null == m_sortElems)<a name="line.222"></a>
<FONT color="green">223</FONT> m_sortElems = new Vector();<a name="line.223"></a>
<FONT color="green">224</FONT> <a name="line.224"></a>
<FONT color="green">225</FONT> m_sortElems.addElement(sortElem);<a name="line.225"></a>
<FONT color="green">226</FONT> }<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> * Get an int constant identifying the type of element.<a name="line.229"></a>
<FONT color="green">230</FONT> * @see org.apache.xalan.templates.Constants<a name="line.230"></a>
<FONT color="green">231</FONT> *<a name="line.231"></a>
<FONT color="green">232</FONT> * @return The token ID for this element<a name="line.232"></a>
<FONT color="green">233</FONT> */<a name="line.233"></a>
<FONT color="green">234</FONT> public int getXSLToken()<a name="line.234"></a>
<FONT color="green">235</FONT> {<a name="line.235"></a>
<FONT color="green">236</FONT> return Constants.ELEMNAME_FOREACH;<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
<FONT color="green">238</FONT> <a name="line.238"></a>
<FONT color="green">239</FONT> /**<a name="line.239"></a>
<FONT color="green">240</FONT> * Return the node name.<a name="line.240"></a>
<FONT color="green">241</FONT> *<a name="line.241"></a>
<FONT color="green">242</FONT> * @return The element's name<a name="line.242"></a>
<FONT color="green">243</FONT> */<a name="line.243"></a>
<FONT color="green">244</FONT> public String getNodeName()<a name="line.244"></a>
<FONT color="green">245</FONT> {<a name="line.245"></a>
<FONT color="green">246</FONT> return Constants.ELEMNAME_FOREACH_STRING;<a name="line.246"></a>
<FONT color="green">247</FONT> }<a name="line.247"></a>
<FONT color="green">248</FONT> <a name="line.248"></a>
<FONT color="green">249</FONT> /**<a name="line.249"></a>
<FONT color="green">250</FONT> * Execute the xsl:for-each transformation<a name="line.250"></a>
<FONT color="green">251</FONT> *<a name="line.251"></a>
<FONT color="green">252</FONT> * @param transformer non-null reference to the the current transform-time state.<a name="line.252"></a>
<FONT color="green">253</FONT> *<a name="line.253"></a>
<FONT color="green">254</FONT> * @throws TransformerException<a name="line.254"></a>
<FONT color="green">255</FONT> */<a name="line.255"></a>
<FONT color="green">256</FONT> public void execute(TransformerImpl transformer) throws TransformerException<a name="line.256"></a>
<FONT color="green">257</FONT> {<a name="line.257"></a>
<FONT color="green">258</FONT> <a name="line.258"></a>
<FONT color="green">259</FONT> transformer.pushCurrentTemplateRuleIsNull(true); <a name="line.259"></a>
<FONT color="green">260</FONT> if (transformer.getDebug())<a name="line.260"></a>
<FONT color="green">261</FONT> transformer.getTraceManager().fireTraceEvent(this);//trigger for-each element event<a name="line.261"></a>
<FONT color="green">262</FONT> <a name="line.262"></a>
<FONT color="green">263</FONT> try<a name="line.263"></a>
<FONT color="green">264</FONT> {<a name="line.264"></a>
<FONT color="green">265</FONT> transformSelectedNodes(transformer);<a name="line.265"></a>
<FONT color="green">266</FONT> }<a name="line.266"></a>
<FONT color="green">267</FONT> finally<a name="line.267"></a>
<FONT color="green">268</FONT> {<a name="line.268"></a>
<FONT color="green">269</FONT> if (transformer.getDebug())<a name="line.269"></a>
<FONT color="green">270</FONT> transformer.getTraceManager().fireTraceEndEvent(this); <a name="line.270"></a>
<FONT color="green">271</FONT> transformer.popCurrentTemplateRuleIsNull();<a name="line.271"></a>
<FONT color="green">272</FONT> }<a name="line.272"></a>
<FONT color="green">273</FONT> }<a name="line.273"></a>
<FONT color="green">274</FONT> <a name="line.274"></a>
<FONT color="green">275</FONT> /**<a name="line.275"></a>
<FONT color="green">276</FONT> * Get template element associated with this<a name="line.276"></a>
<FONT color="green">277</FONT> *<a name="line.277"></a>
<FONT color="green">278</FONT> *<a name="line.278"></a>
<FONT color="green">279</FONT> * @return template element associated with this (itself)<a name="line.279"></a>
<FONT color="green">280</FONT> */<a name="line.280"></a>
<FONT color="green">281</FONT> protected ElemTemplateElement getTemplateMatch()<a name="line.281"></a>
<FONT color="green">282</FONT> {<a name="line.282"></a>
<FONT color="green">283</FONT> return this;<a name="line.283"></a>
<FONT color="green">284</FONT> }<a name="line.284"></a>
<FONT color="green">285</FONT> <a name="line.285"></a>
<FONT color="green">286</FONT> /**<a name="line.286"></a>
<FONT color="green">287</FONT> * Sort given nodes<a name="line.287"></a>
<FONT color="green">288</FONT> *<a name="line.288"></a>
<FONT color="green">289</FONT> *<a name="line.289"></a>
<FONT color="green">290</FONT> * @param xctxt The XPath runtime state for the sort.<a name="line.290"></a>
<FONT color="green">291</FONT> * @param keys Vector of sort keyx<a name="line.291"></a>
<FONT color="green">292</FONT> * @param sourceNodes Iterator of nodes to sort<a name="line.292"></a>
<FONT color="green">293</FONT> *<a name="line.293"></a>
<FONT color="green">294</FONT> * @return iterator of sorted nodes<a name="line.294"></a>
<FONT color="green">295</FONT> *<a name="line.295"></a>
<FONT color="green">296</FONT> * @throws TransformerException<a name="line.296"></a>
<FONT color="green">297</FONT> */<a name="line.297"></a>
<FONT color="green">298</FONT> public DTMIterator sortNodes(<a name="line.298"></a>
<FONT color="green">299</FONT> XPathContext xctxt, Vector keys, DTMIterator sourceNodes)<a name="line.299"></a>
<FONT color="green">300</FONT> throws TransformerException<a name="line.300"></a>
<FONT color="green">301</FONT> {<a name="line.301"></a>
<FONT color="green">302</FONT> <a name="line.302"></a>
<FONT color="green">303</FONT> NodeSorter sorter = new NodeSorter(xctxt);<a name="line.303"></a>
<FONT color="green">304</FONT> sourceNodes.setShouldCacheNodes(true);<a name="line.304"></a>
<FONT color="green">305</FONT> sourceNodes.runTo(-1);<a name="line.305"></a>
<FONT color="green">306</FONT> xctxt.pushContextNodeList(sourceNodes);<a name="line.306"></a>
<FONT color="green">307</FONT> <a name="line.307"></a>
<FONT color="green">308</FONT> try<a name="line.308"></a>
<FONT color="green">309</FONT> {<a name="line.309"></a>
<FONT color="green">310</FONT> sorter.sort(sourceNodes, keys, xctxt);<a name="line.310"></a>
<FONT color="green">311</FONT> sourceNodes.setCurrentPos(0);<a name="line.311"></a>
<FONT color="green">312</FONT> }<a name="line.312"></a>
<FONT color="green">313</FONT> finally<a name="line.313"></a>
<FONT color="green">314</FONT> {<a name="line.314"></a>
<FONT color="green">315</FONT> xctxt.popContextNodeList();<a name="line.315"></a>
<FONT color="green">316</FONT> }<a name="line.316"></a>
<FONT color="green">317</FONT> <a name="line.317"></a>
<FONT color="green">318</FONT> return sourceNodes;<a name="line.318"></a>
<FONT color="green">319</FONT> }<a name="line.319"></a>
<FONT color="green">320</FONT> <a name="line.320"></a>
<FONT color="green">321</FONT> /**<a name="line.321"></a>
<FONT color="green">322</FONT> * Perform a query if needed, and call transformNode for each child.<a name="line.322"></a>
<FONT color="green">323</FONT> *<a name="line.323"></a>
<FONT color="green">324</FONT> * @param transformer non-null reference to the the current transform-time state.<a name="line.324"></a>
<FONT color="green">325</FONT> *<a name="line.325"></a>
<FONT color="green">326</FONT> * @throws TransformerException Thrown in a variety of circumstances.<a name="line.326"></a>
<FONT color="green">327</FONT> * @xsl.usage advanced<a name="line.327"></a>
<FONT color="green">328</FONT> */<a name="line.328"></a>
<FONT color="green">329</FONT> public void transformSelectedNodes(TransformerImpl transformer)<a name="line.329"></a>
<FONT color="green">330</FONT> throws TransformerException<a name="line.330"></a>
<FONT color="green">331</FONT> {<a name="line.331"></a>
<FONT color="green">332</FONT> <a name="line.332"></a>
<FONT color="green">333</FONT> final XPathContext xctxt = transformer.getXPathContext();<a name="line.333"></a>
<FONT color="green">334</FONT> final int sourceNode = xctxt.getCurrentNode();<a name="line.334"></a>
<FONT color="green">335</FONT> DTMIterator sourceNodes = m_selectExpression.asIterator(xctxt,<a name="line.335"></a>
<FONT color="green">336</FONT> sourceNode);<a name="line.336"></a>
<FONT color="green">337</FONT> <a name="line.337"></a>
<FONT color="green">338</FONT> try<a name="line.338"></a>
<FONT color="green">339</FONT> {<a name="line.339"></a>
<FONT color="green">340</FONT> <a name="line.340"></a>
<FONT color="green">341</FONT> final Vector keys = (m_sortElems == null)<a name="line.341"></a>
<FONT color="green">342</FONT> ? null<a name="line.342"></a>
<FONT color="green">343</FONT> : transformer.processSortKeys(this, sourceNode);<a name="line.343"></a>
<FONT color="green">344</FONT> <a name="line.344"></a>
<FONT color="green">345</FONT> // Sort if we need to.<a name="line.345"></a>
<FONT color="green">346</FONT> if (null != keys)<a name="line.346"></a>
<FONT color="green">347</FONT> sourceNodes = sortNodes(xctxt, keys, sourceNodes);<a name="line.347"></a>
<FONT color="green">348</FONT> <a name="line.348"></a>
<FONT color="green">349</FONT> if (transformer.getDebug())<a name="line.349"></a>
<FONT color="green">350</FONT> {<a name="line.350"></a>
<FONT color="green">351</FONT> <a name="line.351"></a>
<FONT color="green">352</FONT> // The original code, which is broken for bug#16889,<a name="line.352"></a>
<FONT color="green">353</FONT> // which fails to get the original select expression in the select event. <a name="line.353"></a>
<FONT color="green">354</FONT> /* transformer.getTraceManager().fireSelectedEvent(<a name="line.354"></a>
<FONT color="green">355</FONT> * sourceNode,<a name="line.355"></a>
<FONT color="green">356</FONT> * this,<a name="line.356"></a>
<FONT color="green">357</FONT> * "select",<a name="line.357"></a>
<FONT color="green">358</FONT> * new XPath(m_selectExpression),<a name="line.358"></a>
<FONT color="green">359</FONT> * new org.apache.xpath.objects.XNodeSet(sourceNodes));<a name="line.359"></a>
<FONT color="green">360</FONT> */ <a name="line.360"></a>
<FONT color="green">361</FONT> <a name="line.361"></a>
<FONT color="green">362</FONT> // The following code fixes bug#16889<a name="line.362"></a>
<FONT color="green">363</FONT> // Solution: Store away XPath in setSelect(Xath), and use it here.<a name="line.363"></a>
<FONT color="green">364</FONT> // Pass m_xath, which the current node is associated with, onto the TraceManager.<a name="line.364"></a>
<FONT color="green">365</FONT> <a name="line.365"></a>
<FONT color="green">366</FONT> Expression expr = m_xpath.getExpression();<a name="line.366"></a>
<FONT color="green">367</FONT> org.apache.xpath.objects.XObject xObject = expr.execute(xctxt);<a name="line.367"></a>
<FONT color="green">368</FONT> int current = xctxt.getCurrentNode();<a name="line.368"></a>
<FONT color="green">369</FONT> transformer.getTraceManager().fireSelectedEvent(<a name="line.369"></a>
<FONT color="green">370</FONT> current,<a name="line.370"></a>
<FONT color="green">371</FONT> this,<a name="line.371"></a>
<FONT color="green">372</FONT> "select",<a name="line.372"></a>
<FONT color="green">373</FONT> m_xpath,<a name="line.373"></a>
<FONT color="green">374</FONT> xObject);<a name="line.374"></a>
<FONT color="green">375</FONT> }<a name="line.375"></a>
<FONT color="green">376</FONT> <a name="line.376"></a>
<FONT color="green">377</FONT> <a name="line.377"></a>
<FONT color="green">378</FONT> <a name="line.378"></a>
<FONT color="green">379</FONT> xctxt.pushCurrentNode(DTM.NULL);<a name="line.379"></a>
<FONT color="green">380</FONT> <a name="line.380"></a>
<FONT color="green">381</FONT> IntStack currentNodes = xctxt.getCurrentNodeStack();<a name="line.381"></a>
<FONT color="green">382</FONT> <a name="line.382"></a>
<FONT color="green">383</FONT> xctxt.pushCurrentExpressionNode(DTM.NULL);<a name="line.383"></a>
<FONT color="green">384</FONT> <a name="line.384"></a>
<FONT color="green">385</FONT> IntStack currentExpressionNodes = xctxt.getCurrentExpressionNodeStack();<a name="line.385"></a>
<FONT color="green">386</FONT> <a name="line.386"></a>
<FONT color="green">387</FONT> xctxt.pushSAXLocatorNull();<a name="line.387"></a>
<FONT color="green">388</FONT> xctxt.pushContextNodeList(sourceNodes);<a name="line.388"></a>
<FONT color="green">389</FONT> transformer.pushElemTemplateElement(null);<a name="line.389"></a>
<FONT color="green">390</FONT> <a name="line.390"></a>
<FONT color="green">391</FONT> // pushParams(transformer, xctxt);<a name="line.391"></a>
<FONT color="green">392</FONT> // Should be able to get this from the iterator but there must be a bug.<a name="line.392"></a>
<FONT color="green">393</FONT> DTM dtm = xctxt.getDTM(sourceNode);<a name="line.393"></a>
<FONT color="green">394</FONT> int docID = sourceNode &amp; DTMManager.IDENT_DTM_DEFAULT;<a name="line.394"></a>
<FONT color="green">395</FONT> int child;<a name="line.395"></a>
<FONT color="green">396</FONT> <a name="line.396"></a>
<FONT color="green">397</FONT> while (DTM.NULL != (child = sourceNodes.nextNode()))<a name="line.397"></a>
<FONT color="green">398</FONT> {<a name="line.398"></a>
<FONT color="green">399</FONT> currentNodes.setTop(child);<a name="line.399"></a>
<FONT color="green">400</FONT> currentExpressionNodes.setTop(child);<a name="line.400"></a>
<FONT color="green">401</FONT> <a name="line.401"></a>
<FONT color="green">402</FONT> if ((child &amp; DTMManager.IDENT_DTM_DEFAULT) != docID)<a name="line.402"></a>
<FONT color="green">403</FONT> {<a name="line.403"></a>
<FONT color="green">404</FONT> dtm = xctxt.getDTM(child);<a name="line.404"></a>
<FONT color="green">405</FONT> docID = child &amp; DTMManager.IDENT_DTM_DEFAULT;<a name="line.405"></a>
<FONT color="green">406</FONT> }<a name="line.406"></a>
<FONT color="green">407</FONT> <a name="line.407"></a>
<FONT color="green">408</FONT> //final int exNodeType = dtm.getExpandedTypeID(child);<a name="line.408"></a>
<FONT color="green">409</FONT> final int nodeType = dtm.getNodeType(child); <a name="line.409"></a>
<FONT color="green">410</FONT> <a name="line.410"></a>
<FONT color="green">411</FONT> // Fire a trace event for the template.<a name="line.411"></a>
<FONT color="green">412</FONT> if (transformer.getDebug())<a name="line.412"></a>
<FONT color="green">413</FONT> {<a name="line.413"></a>
<FONT color="green">414</FONT> transformer.getTraceManager().fireTraceEvent(this);<a name="line.414"></a>
<FONT color="green">415</FONT> }<a name="line.415"></a>
<FONT color="green">416</FONT> <a name="line.416"></a>
<FONT color="green">417</FONT> // And execute the child templates.<a name="line.417"></a>
<FONT color="green">418</FONT> // Loop through the children of the template, calling execute on <a name="line.418"></a>
<FONT color="green">419</FONT> // each of them.<a name="line.419"></a>
<FONT color="green">420</FONT> for (ElemTemplateElement t = this.m_firstChild; t != null;<a name="line.420"></a>
<FONT color="green">421</FONT> t = t.m_nextSibling)<a name="line.421"></a>
<FONT color="green">422</FONT> {<a name="line.422"></a>
<FONT color="green">423</FONT> xctxt.setSAXLocator(t);<a name="line.423"></a>
<FONT color="green">424</FONT> transformer.setCurrentElement(t);<a name="line.424"></a>
<FONT color="green">425</FONT> t.execute(transformer);<a name="line.425"></a>
<FONT color="green">426</FONT> }<a name="line.426"></a>
<FONT color="green">427</FONT> <a name="line.427"></a>
<FONT color="green">428</FONT> if (transformer.getDebug())<a name="line.428"></a>
<FONT color="green">429</FONT> {<a name="line.429"></a>
<FONT color="green">430</FONT> // We need to make sure an old current element is not <a name="line.430"></a>
<FONT color="green">431</FONT> // on the stack. See TransformerImpl#getElementCallstack.<a name="line.431"></a>
<FONT color="green">432</FONT> transformer.setCurrentElement(null);<a name="line.432"></a>
<FONT color="green">433</FONT> transformer.getTraceManager().fireTraceEndEvent(this);<a name="line.433"></a>
<FONT color="green">434</FONT> }<a name="line.434"></a>
<FONT color="green">435</FONT> <a name="line.435"></a>
<FONT color="green">436</FONT> <a name="line.436"></a>
<FONT color="green">437</FONT> // KLUGE: Implement &lt;?xalan:doc_cache_off?&gt; <a name="line.437"></a>
<FONT color="green">438</FONT> // ASSUMPTION: This will be set only when the XPath was indeed<a name="line.438"></a>
<FONT color="green">439</FONT> // a call to the Document() function. Calling it in other<a name="line.439"></a>
<FONT color="green">440</FONT> // situations is likely to fry Xalan.<a name="line.440"></a>
<FONT color="green">441</FONT> //<a name="line.441"></a>
<FONT color="green">442</FONT> // %REVIEW% We need a MUCH cleaner solution -- one that will<a name="line.442"></a>
<FONT color="green">443</FONT> // handle cleaning up after document() and getDTM() in other<a name="line.443"></a>
<FONT color="green">444</FONT> // contexts. The whole SourceTreeManager mechanism should probably<a name="line.444"></a>
<FONT color="green">445</FONT> // be moved into DTMManager rather than being explicitly invoked in<a name="line.445"></a>
<FONT color="green">446</FONT> // FuncDocument and here.<a name="line.446"></a>
<FONT color="green">447</FONT> if(m_doc_cache_off)<a name="line.447"></a>
<FONT color="green">448</FONT> {<a name="line.448"></a>
<FONT color="green">449</FONT> if(DEBUG)<a name="line.449"></a>
<FONT color="green">450</FONT> System.out.println("JJK***** CACHE RELEASE *****\n"+<a name="line.450"></a>
<FONT color="green">451</FONT> "\tdtm="+dtm.getDocumentBaseURI());<a name="line.451"></a>
<FONT color="green">452</FONT> // NOTE: This will work because this is _NOT_ a shared DTM, and thus has<a name="line.452"></a>
<FONT color="green">453</FONT> // only a single Document node. If it could ever be an RTF or other<a name="line.453"></a>
<FONT color="green">454</FONT> // shared DTM, this would require substantial rework.<a name="line.454"></a>
<FONT color="green">455</FONT> xctxt.getSourceTreeManager().removeDocumentFromCache(dtm.getDocument());<a name="line.455"></a>
<FONT color="green">456</FONT> xctxt.release(dtm,false);<a name="line.456"></a>
<FONT color="green">457</FONT> }<a name="line.457"></a>
<FONT color="green">458</FONT> }<a name="line.458"></a>
<FONT color="green">459</FONT> }<a name="line.459"></a>
<FONT color="green">460</FONT> finally<a name="line.460"></a>
<FONT color="green">461</FONT> {<a name="line.461"></a>
<FONT color="green">462</FONT> if (transformer.getDebug())<a name="line.462"></a>
<FONT color="green">463</FONT> transformer.getTraceManager().fireSelectedEndEvent(sourceNode, this,<a name="line.463"></a>
<FONT color="green">464</FONT> "select", new XPath(m_selectExpression),<a name="line.464"></a>
<FONT color="green">465</FONT> new org.apache.xpath.objects.XNodeSet(sourceNodes));<a name="line.465"></a>
<FONT color="green">466</FONT> <a name="line.466"></a>
<FONT color="green">467</FONT> xctxt.popSAXLocator();<a name="line.467"></a>
<FONT color="green">468</FONT> xctxt.popContextNodeList();<a name="line.468"></a>
<FONT color="green">469</FONT> transformer.popElemTemplateElement();<a name="line.469"></a>
<FONT color="green">470</FONT> xctxt.popCurrentExpressionNode();<a name="line.470"></a>
<FONT color="green">471</FONT> xctxt.popCurrentNode();<a name="line.471"></a>
<FONT color="green">472</FONT> sourceNodes.detach();<a name="line.472"></a>
<FONT color="green">473</FONT> }<a name="line.473"></a>
<FONT color="green">474</FONT> }<a name="line.474"></a>
<FONT color="green">475</FONT> <a name="line.475"></a>
<FONT color="green">476</FONT> /**<a name="line.476"></a>
<FONT color="green">477</FONT> * Add a child to the child list.<a name="line.477"></a>
<FONT color="green">478</FONT> * &lt;!ELEMENT xsl:apply-templates (xsl:sort|xsl:with-param)*&gt;<a name="line.478"></a>
<FONT color="green">479</FONT> * &lt;!ATTLIST xsl:apply-templates<a name="line.479"></a>
<FONT color="green">480</FONT> * select %expr; "node()"<a name="line.480"></a>
<FONT color="green">481</FONT> * mode %qname; #IMPLIED<a name="line.481"></a>
<FONT color="green">482</FONT> * &gt;<a name="line.482"></a>
<FONT color="green">483</FONT> *<a name="line.483"></a>
<FONT color="green">484</FONT> * @param newChild Child to add to child list<a name="line.484"></a>
<FONT color="green">485</FONT> *<a name="line.485"></a>
<FONT color="green">486</FONT> * @return Child just added to child list<a name="line.486"></a>
<FONT color="green">487</FONT> */<a name="line.487"></a>
<FONT color="green">488</FONT> public ElemTemplateElement appendChild(ElemTemplateElement newChild)<a name="line.488"></a>
<FONT color="green">489</FONT> {<a name="line.489"></a>
<FONT color="green">490</FONT> <a name="line.490"></a>
<FONT color="green">491</FONT> int type = ((ElemTemplateElement) newChild).getXSLToken();<a name="line.491"></a>
<FONT color="green">492</FONT> <a name="line.492"></a>
<FONT color="green">493</FONT> if (Constants.ELEMNAME_SORT == type)<a name="line.493"></a>
<FONT color="green">494</FONT> {<a name="line.494"></a>
<FONT color="green">495</FONT> setSortElem((ElemSort) newChild);<a name="line.495"></a>
<FONT color="green">496</FONT> <a name="line.496"></a>
<FONT color="green">497</FONT> return newChild;<a name="line.497"></a>
<FONT color="green">498</FONT> }<a name="line.498"></a>
<FONT color="green">499</FONT> else<a name="line.499"></a>
<FONT color="green">500</FONT> return super.appendChild(newChild);<a name="line.500"></a>
<FONT color="green">501</FONT> }<a name="line.501"></a>
<FONT color="green">502</FONT> <a name="line.502"></a>
<FONT color="green">503</FONT> /**<a name="line.503"></a>
<FONT color="green">504</FONT> * Call the children visitors.<a name="line.504"></a>
<FONT color="green">505</FONT> * @param visitor The visitor whose appropriate method will be called.<a name="line.505"></a>
<FONT color="green">506</FONT> */<a name="line.506"></a>
<FONT color="green">507</FONT> public void callChildVisitors(XSLTVisitor visitor, boolean callAttributes)<a name="line.507"></a>
<FONT color="green">508</FONT> {<a name="line.508"></a>
<FONT color="green">509</FONT> if(callAttributes &amp;&amp; (null != m_selectExpression))<a name="line.509"></a>
<FONT color="green">510</FONT> m_selectExpression.callVisitors(this, visitor);<a name="line.510"></a>
<FONT color="green">511</FONT> <a name="line.511"></a>
<FONT color="green">512</FONT> int length = getSortElemCount();<a name="line.512"></a>
<FONT color="green">513</FONT> <a name="line.513"></a>
<FONT color="green">514</FONT> for (int i = 0; i &lt; length; i++)<a name="line.514"></a>
<FONT color="green">515</FONT> {<a name="line.515"></a>
<FONT color="green">516</FONT> getSortElem(i).callVisitors(visitor);<a name="line.516"></a>
<FONT color="green">517</FONT> }<a name="line.517"></a>
<FONT color="green">518</FONT> <a name="line.518"></a>
<FONT color="green">519</FONT> super.callChildVisitors(visitor, callAttributes);<a name="line.519"></a>
<FONT color="green">520</FONT> }<a name="line.520"></a>
<FONT color="green">521</FONT> <a name="line.521"></a>
<FONT color="green">522</FONT> /**<a name="line.522"></a>
<FONT color="green">523</FONT> * @see ExpressionOwner#getExpression()<a name="line.523"></a>
<FONT color="green">524</FONT> */<a name="line.524"></a>
<FONT color="green">525</FONT> public Expression getExpression()<a name="line.525"></a>
<FONT color="green">526</FONT> {<a name="line.526"></a>
<FONT color="green">527</FONT> return m_selectExpression;<a name="line.527"></a>
<FONT color="green">528</FONT> }<a name="line.528"></a>
<FONT color="green">529</FONT> <a name="line.529"></a>
<FONT color="green">530</FONT> /**<a name="line.530"></a>
<FONT color="green">531</FONT> * @see ExpressionOwner#setExpression(Expression)<a name="line.531"></a>
<FONT color="green">532</FONT> */<a name="line.532"></a>
<FONT color="green">533</FONT> public void setExpression(Expression exp)<a name="line.533"></a>
<FONT color="green">534</FONT> {<a name="line.534"></a>
<FONT color="green">535</FONT> exp.exprSetParent(this);<a name="line.535"></a>
<FONT color="green">536</FONT> m_selectExpression = exp;<a name="line.536"></a>
<FONT color="green">537</FONT> }<a name="line.537"></a>
<FONT color="green">538</FONT> <a name="line.538"></a>
<FONT color="green">539</FONT> /*<a name="line.539"></a>
<FONT color="green">540</FONT> * to keep the binary compatibility, assign a default value for newly added<a name="line.540"></a>
<FONT color="green">541</FONT> * globel varialbe m_xpath during deserialization of an object which was <a name="line.541"></a>
<FONT color="green">542</FONT> * serialized using an older version<a name="line.542"></a>
<FONT color="green">543</FONT> */<a name="line.543"></a>
<FONT color="green">544</FONT> private void readObject(ObjectInputStream os) throws <a name="line.544"></a>
<FONT color="green">545</FONT> IOException, ClassNotFoundException {<a name="line.545"></a>
<FONT color="green">546</FONT> os.defaultReadObject();<a name="line.546"></a>
<FONT color="green">547</FONT> m_xpath = null;<a name="line.547"></a>
<FONT color="green">548</FONT> }<a name="line.548"></a>
<FONT color="green">549</FONT> }<a name="line.549"></a>
</PRE>
</BODY>
</HTML>