blob: 702fa0bddde60c70b5f37403d82923ffd4f055b5 [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: KeyTable.java 468645 2006-10-28 06:57:24Z 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.transformer;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Hashtable;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.Vector;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import javax.xml.transform.TransformerException;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xalan.templates.KeyDeclaration;<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.utils.PrefixResolver;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.xml.utils.QName;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xml.utils.WrappedRuntimeException;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.xml.utils.XMLString;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.xpath.XPathContext;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.apache.xpath.objects.XNodeSet;<a name="line.36"></a>
<FONT color="green">037</FONT> import org.apache.xpath.objects.XObject;<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Table of element keys, keyed by document node. An instance of this<a name="line.40"></a>
<FONT color="green">041</FONT> * class is keyed by a Document node that should be matched with the<a name="line.41"></a>
<FONT color="green">042</FONT> * root of the current context.<a name="line.42"></a>
<FONT color="green">043</FONT> * @xsl.usage advanced<a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> public class KeyTable<a name="line.45"></a>
<FONT color="green">046</FONT> {<a name="line.46"></a>
<FONT color="green">047</FONT> /**<a name="line.47"></a>
<FONT color="green">048</FONT> * The document key. This table should only be used with contexts<a name="line.48"></a>
<FONT color="green">049</FONT> * whose Document roots match this key.<a name="line.49"></a>
<FONT color="green">050</FONT> */<a name="line.50"></a>
<FONT color="green">051</FONT> private int m_docKey;<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /**<a name="line.53"></a>
<FONT color="green">054</FONT> * Vector of KeyDeclaration instances holding the key declarations.<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> private Vector m_keyDeclarations;<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> * Hold a cache of key() function result for each ref.<a name="line.59"></a>
<FONT color="green">060</FONT> * Key is XMLString, the ref value<a name="line.60"></a>
<FONT color="green">061</FONT> * Value is XNodeSet, the key() function result for the given ref value.<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> private Hashtable m_refsTable = null;<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 the document root matching this key. <a name="line.66"></a>
<FONT color="green">067</FONT> *<a name="line.67"></a>
<FONT color="green">068</FONT> * @return the document root matching this key<a name="line.68"></a>
<FONT color="green">069</FONT> */<a name="line.69"></a>
<FONT color="green">070</FONT> public int getDocKey()<a name="line.70"></a>
<FONT color="green">071</FONT> {<a name="line.71"></a>
<FONT color="green">072</FONT> return m_docKey;<a name="line.72"></a>
<FONT color="green">073</FONT> }<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> * The main iterator that will walk through the source <a name="line.76"></a>
<FONT color="green">077</FONT> * tree for this key.<a name="line.77"></a>
<FONT color="green">078</FONT> */<a name="line.78"></a>
<FONT color="green">079</FONT> private XNodeSet m_keyNodes;<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> KeyIterator getKeyIterator()<a name="line.81"></a>
<FONT color="green">082</FONT> {<a name="line.82"></a>
<FONT color="green">083</FONT> return (KeyIterator)(m_keyNodes.getContainedIter());<a name="line.83"></a>
<FONT color="green">084</FONT> }<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> * Build a keys table.<a name="line.87"></a>
<FONT color="green">088</FONT> * @param doc The owner document key.<a name="line.88"></a>
<FONT color="green">089</FONT> * @param nscontext The stylesheet's namespace context.<a name="line.89"></a>
<FONT color="green">090</FONT> * @param name The key name<a name="line.90"></a>
<FONT color="green">091</FONT> * @param keyDeclarations The stylesheet's xsl:key declarations.<a name="line.91"></a>
<FONT color="green">092</FONT> *<a name="line.92"></a>
<FONT color="green">093</FONT> * @throws javax.xml.transform.TransformerException<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> public KeyTable(<a name="line.95"></a>
<FONT color="green">096</FONT> int doc, PrefixResolver nscontext, QName name, Vector keyDeclarations, XPathContext xctxt)<a name="line.96"></a>
<FONT color="green">097</FONT> throws javax.xml.transform.TransformerException<a name="line.97"></a>
<FONT color="green">098</FONT> {<a name="line.98"></a>
<FONT color="green">099</FONT> m_docKey = doc;<a name="line.99"></a>
<FONT color="green">100</FONT> m_keyDeclarations = keyDeclarations;<a name="line.100"></a>
<FONT color="green">101</FONT> KeyIterator ki = new KeyIterator(name, keyDeclarations);<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> m_keyNodes = new XNodeSet(ki);<a name="line.103"></a>
<FONT color="green">104</FONT> m_keyNodes.allowDetachToRelease(false);<a name="line.104"></a>
<FONT color="green">105</FONT> m_keyNodes.setRoot(doc, xctxt);<a name="line.105"></a>
<FONT color="green">106</FONT> }<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> * Given a valid element key, return the corresponding node list.<a name="line.109"></a>
<FONT color="green">110</FONT> * <a name="line.110"></a>
<FONT color="green">111</FONT> * @param name The name of the key, which must match the 'name' attribute on xsl:key.<a name="line.111"></a>
<FONT color="green">112</FONT> * @param ref The value that must match the value found by the 'match' attribute on xsl:key.<a name="line.112"></a>
<FONT color="green">113</FONT> * @return a set of nodes referenced by the key named &lt;CODE&gt;name&lt;/CODE&gt; and the reference &lt;CODE&gt;ref&lt;/CODE&gt;. If no node is referenced by this key, an empty node set is returned.<a name="line.113"></a>
<FONT color="green">114</FONT> */<a name="line.114"></a>
<FONT color="green">115</FONT> public XNodeSet getNodeSetDTMByKey(QName name, XMLString ref)<a name="line.115"></a>
<FONT color="green">116</FONT> <a name="line.116"></a>
<FONT color="green">117</FONT> {<a name="line.117"></a>
<FONT color="green">118</FONT> XNodeSet refNodes = (XNodeSet) getRefsTable().get(ref);<a name="line.118"></a>
<FONT color="green">119</FONT> // clone wiht reset the node set<a name="line.119"></a>
<FONT color="green">120</FONT> try<a name="line.120"></a>
<FONT color="green">121</FONT> {<a name="line.121"></a>
<FONT color="green">122</FONT> if (refNodes != null)<a name="line.122"></a>
<FONT color="green">123</FONT> {<a name="line.123"></a>
<FONT color="green">124</FONT> refNodes = (XNodeSet) refNodes.cloneWithReset();<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> catch (CloneNotSupportedException e)<a name="line.127"></a>
<FONT color="green">128</FONT> {<a name="line.128"></a>
<FONT color="green">129</FONT> refNodes = null;<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> if (refNodes == null) {<a name="line.132"></a>
<FONT color="green">133</FONT> // create an empty XNodeSet<a name="line.133"></a>
<FONT color="green">134</FONT> KeyIterator ki = (KeyIterator) (m_keyNodes).getContainedIter();<a name="line.134"></a>
<FONT color="green">135</FONT> XPathContext xctxt = ki.getXPathContext();<a name="line.135"></a>
<FONT color="green">136</FONT> refNodes = new XNodeSet(xctxt.getDTMManager()) {<a name="line.136"></a>
<FONT color="green">137</FONT> public void setRoot(int nodeHandle, Object environment) {<a name="line.137"></a>
<FONT color="green">138</FONT> // Root cannot be set on non-iterated node sets. Ignore it.<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> refNodes.reset();<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> <a name="line.143"></a>
<FONT color="green">144</FONT> return refNodes;<a name="line.144"></a>
<FONT color="green">145</FONT> }<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> * Get Key Name for this KeyTable <a name="line.148"></a>
<FONT color="green">149</FONT> *<a name="line.149"></a>
<FONT color="green">150</FONT> * @return Key name<a name="line.150"></a>
<FONT color="green">151</FONT> */<a name="line.151"></a>
<FONT color="green">152</FONT> public QName getKeyTableName()<a name="line.152"></a>
<FONT color="green">153</FONT> {<a name="line.153"></a>
<FONT color="green">154</FONT> return getKeyIterator().getName();<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> /**<a name="line.157"></a>
<FONT color="green">158</FONT> * @return key declarations for the key associated to this KeyTable<a name="line.158"></a>
<FONT color="green">159</FONT> */<a name="line.159"></a>
<FONT color="green">160</FONT> private Vector getKeyDeclarations() {<a name="line.160"></a>
<FONT color="green">161</FONT> int nDeclarations = m_keyDeclarations.size();<a name="line.161"></a>
<FONT color="green">162</FONT> Vector keyDecls = new Vector(nDeclarations);<a name="line.162"></a>
<FONT color="green">163</FONT> <a name="line.163"></a>
<FONT color="green">164</FONT> // Walk through each of the declarations made with xsl:key<a name="line.164"></a>
<FONT color="green">165</FONT> for (int i = 0; i &lt; nDeclarations; i++)<a name="line.165"></a>
<FONT color="green">166</FONT> {<a name="line.166"></a>
<FONT color="green">167</FONT> KeyDeclaration kd = (KeyDeclaration) m_keyDeclarations.elementAt(i);<a name="line.167"></a>
<FONT color="green">168</FONT> <a name="line.168"></a>
<FONT color="green">169</FONT> // Add the declaration if the name on this key declaration<a name="line.169"></a>
<FONT color="green">170</FONT> // matches the name on the iterator for this walker.<a name="line.170"></a>
<FONT color="green">171</FONT> if (kd.getName().equals(getKeyTableName())) {<a name="line.171"></a>
<FONT color="green">172</FONT> keyDecls.add(kd);<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> }<a name="line.174"></a>
<FONT color="green">175</FONT> <a name="line.175"></a>
<FONT color="green">176</FONT> return keyDecls;<a name="line.176"></a>
<FONT color="green">177</FONT> }<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> * @return lazy initialized refs table associating evaluation of key function<a name="line.180"></a>
<FONT color="green">181</FONT> * with a XNodeSet<a name="line.181"></a>
<FONT color="green">182</FONT> */<a name="line.182"></a>
<FONT color="green">183</FONT> private Hashtable getRefsTable()<a name="line.183"></a>
<FONT color="green">184</FONT> {<a name="line.184"></a>
<FONT color="green">185</FONT> if (m_refsTable == null) {<a name="line.185"></a>
<FONT color="green">186</FONT> // initial capacity set to a prime number to improve hash performance<a name="line.186"></a>
<FONT color="green">187</FONT> m_refsTable = new Hashtable(89);<a name="line.187"></a>
<FONT color="green">188</FONT> <a name="line.188"></a>
<FONT color="green">189</FONT> KeyIterator ki = (KeyIterator) (m_keyNodes).getContainedIter();<a name="line.189"></a>
<FONT color="green">190</FONT> XPathContext xctxt = ki.getXPathContext();<a name="line.190"></a>
<FONT color="green">191</FONT> <a name="line.191"></a>
<FONT color="green">192</FONT> Vector keyDecls = getKeyDeclarations();<a name="line.192"></a>
<FONT color="green">193</FONT> int nKeyDecls = keyDecls.size();<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> int currentNode;<a name="line.195"></a>
<FONT color="green">196</FONT> m_keyNodes.reset();<a name="line.196"></a>
<FONT color="green">197</FONT> while (DTM.NULL != (currentNode = m_keyNodes.nextNode()))<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> for (int keyDeclIdx = 0; keyDeclIdx &lt; nKeyDecls; keyDeclIdx++) {<a name="line.201"></a>
<FONT color="green">202</FONT> KeyDeclaration keyDeclaration =<a name="line.202"></a>
<FONT color="green">203</FONT> (KeyDeclaration) keyDecls.elementAt(keyDeclIdx);<a name="line.203"></a>
<FONT color="green">204</FONT> XObject xuse =<a name="line.204"></a>
<FONT color="green">205</FONT> keyDeclaration.getUse().execute(xctxt,<a name="line.205"></a>
<FONT color="green">206</FONT> currentNode,<a name="line.206"></a>
<FONT color="green">207</FONT> ki.getPrefixResolver());<a name="line.207"></a>
<FONT color="green">208</FONT> <a name="line.208"></a>
<FONT color="green">209</FONT> if (xuse.getType() != xuse.CLASS_NODESET) {<a name="line.209"></a>
<FONT color="green">210</FONT> XMLString exprResult = xuse.xstr();<a name="line.210"></a>
<FONT color="green">211</FONT> addValueInRefsTable(xctxt, exprResult, currentNode);<a name="line.211"></a>
<FONT color="green">212</FONT> } else {<a name="line.212"></a>
<FONT color="green">213</FONT> DTMIterator i = ((XNodeSet)xuse).iterRaw();<a name="line.213"></a>
<FONT color="green">214</FONT> int currentNodeInUseClause;<a name="line.214"></a>
<FONT color="green">215</FONT> <a name="line.215"></a>
<FONT color="green">216</FONT> while (DTM.NULL != (currentNodeInUseClause = i.nextNode())) {<a name="line.216"></a>
<FONT color="green">217</FONT> DTM dtm = xctxt.getDTM(currentNodeInUseClause);<a name="line.217"></a>
<FONT color="green">218</FONT> XMLString exprResult =<a name="line.218"></a>
<FONT color="green">219</FONT> dtm.getStringValue(currentNodeInUseClause);<a name="line.219"></a>
<FONT color="green">220</FONT> addValueInRefsTable(xctxt, exprResult, currentNode);<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> }<a name="line.223"></a>
<FONT color="green">224</FONT> } catch (TransformerException te) {<a name="line.224"></a>
<FONT color="green">225</FONT> throw new WrappedRuntimeException(te);<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> return m_refsTable;<a name="line.229"></a>
<FONT color="green">230</FONT> }<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> * Add an association between a ref and a node in the m_refsTable.<a name="line.233"></a>
<FONT color="green">234</FONT> * Requires that m_refsTable != null<a name="line.234"></a>
<FONT color="green">235</FONT> * @param xctxt XPath context<a name="line.235"></a>
<FONT color="green">236</FONT> * @param ref the value of the use clause of the current key for the given node<a name="line.236"></a>
<FONT color="green">237</FONT> * @param node the node to reference<a name="line.237"></a>
<FONT color="green">238</FONT> */<a name="line.238"></a>
<FONT color="green">239</FONT> private void addValueInRefsTable(XPathContext xctxt, XMLString ref, int node) {<a name="line.239"></a>
<FONT color="green">240</FONT> <a name="line.240"></a>
<FONT color="green">241</FONT> XNodeSet nodes = (XNodeSet) m_refsTable.get(ref);<a name="line.241"></a>
<FONT color="green">242</FONT> if (nodes == null)<a name="line.242"></a>
<FONT color="green">243</FONT> {<a name="line.243"></a>
<FONT color="green">244</FONT> nodes = new XNodeSet(node, xctxt.getDTMManager());<a name="line.244"></a>
<FONT color="green">245</FONT> nodes.nextNode();<a name="line.245"></a>
<FONT color="green">246</FONT> m_refsTable.put(ref, nodes);<a name="line.246"></a>
<FONT color="green">247</FONT> }<a name="line.247"></a>
<FONT color="green">248</FONT> else<a name="line.248"></a>
<FONT color="green">249</FONT> {<a name="line.249"></a>
<FONT color="green">250</FONT> // Nodes are passed to this method in document order. Since we need to<a name="line.250"></a>
<FONT color="green">251</FONT> // suppress duplicates, we only need to check against the last entry<a name="line.251"></a>
<FONT color="green">252</FONT> // in each nodeset. We use nodes.nextNode after each entry so we can<a name="line.252"></a>
<FONT color="green">253</FONT> // easily compare node against the current node.<a name="line.253"></a>
<FONT color="green">254</FONT> if (nodes.getCurrentNode() != node) {<a name="line.254"></a>
<FONT color="green">255</FONT> nodes.mutableNodeset().addNode(node);<a name="line.255"></a>
<FONT color="green">256</FONT> nodes.nextNode();<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> }<a name="line.259"></a>
<FONT color="green">260</FONT> }<a name="line.260"></a>
</PRE>
</BODY>
</HTML>