blob: bf3938a50fb5403efe941cc70d1c55b2af282078 [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: SerializerUtils.java 468642 2006-10-28 06:55:10Z 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.serialize;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import javax.xml.transform.TransformerException;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xalan.transformer.TransformerImpl;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xml.dtm.DTM;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xml.serializer.NamespaceMappings;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xml.serializer.SerializationHandler;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xpath.XPathContext;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xpath.objects.XObject;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.xml.sax.SAXException;<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * Class that contains only static methods that are used to "serialize",<a name="line.34"></a>
<FONT color="green">035</FONT> * these methods are used by Xalan and are not in org.apache.xml.serializer<a name="line.35"></a>
<FONT color="green">036</FONT> * because they have dependancies on the packages org.apache.xpath or org.<a name="line.36"></a>
<FONT color="green">037</FONT> * apache.xml.dtm or org.apache.xalan.transformer. The package org.apache.xml.<a name="line.37"></a>
<FONT color="green">038</FONT> * serializer should not depend on Xalan or XSLTC.<a name="line.38"></a>
<FONT color="green">039</FONT> * @xsl.usage internal<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> public class SerializerUtils<a name="line.41"></a>
<FONT color="green">042</FONT> {<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> * Copy an DOM attribute to the created output element, executing<a name="line.45"></a>
<FONT color="green">046</FONT> * attribute templates as need be, and processing the xsl:use<a name="line.46"></a>
<FONT color="green">047</FONT> * attribute.<a name="line.47"></a>
<FONT color="green">048</FONT> *<a name="line.48"></a>
<FONT color="green">049</FONT> * @param handler SerializationHandler to which the attributes are added.<a name="line.49"></a>
<FONT color="green">050</FONT> * @param attr Attribute node to add to SerializationHandler.<a name="line.50"></a>
<FONT color="green">051</FONT> *<a name="line.51"></a>
<FONT color="green">052</FONT> * @throws TransformerException<a name="line.52"></a>
<FONT color="green">053</FONT> */<a name="line.53"></a>
<FONT color="green">054</FONT> public static void addAttribute(SerializationHandler handler, int attr)<a name="line.54"></a>
<FONT color="green">055</FONT> throws TransformerException<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> TransformerImpl transformer =<a name="line.58"></a>
<FONT color="green">059</FONT> (TransformerImpl) handler.getTransformer();<a name="line.59"></a>
<FONT color="green">060</FONT> DTM dtm = transformer.getXPathContext().getDTM(attr);<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> if (SerializerUtils.isDefinedNSDecl(handler, attr, dtm))<a name="line.62"></a>
<FONT color="green">063</FONT> return;<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> String ns = dtm.getNamespaceURI(attr);<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> if (ns == null)<a name="line.67"></a>
<FONT color="green">068</FONT> ns = "";<a name="line.68"></a>
<FONT color="green">069</FONT> <a name="line.69"></a>
<FONT color="green">070</FONT> // %OPT% ...can I just store the node handle?<a name="line.70"></a>
<FONT color="green">071</FONT> try<a name="line.71"></a>
<FONT color="green">072</FONT> {<a name="line.72"></a>
<FONT color="green">073</FONT> handler.addAttribute(<a name="line.73"></a>
<FONT color="green">074</FONT> ns,<a name="line.74"></a>
<FONT color="green">075</FONT> dtm.getLocalName(attr),<a name="line.75"></a>
<FONT color="green">076</FONT> dtm.getNodeName(attr),<a name="line.76"></a>
<FONT color="green">077</FONT> "CDATA",<a name="line.77"></a>
<FONT color="green">078</FONT> dtm.getNodeValue(attr), false);<a name="line.78"></a>
<FONT color="green">079</FONT> }<a name="line.79"></a>
<FONT color="green">080</FONT> catch (SAXException e)<a name="line.80"></a>
<FONT color="green">081</FONT> {<a name="line.81"></a>
<FONT color="green">082</FONT> // do something?<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> } // end copyAttributeToTarget method<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> * Copy DOM attributes to the result element.<a name="line.87"></a>
<FONT color="green">088</FONT> *<a name="line.88"></a>
<FONT color="green">089</FONT> * @param src Source node with the attributes<a name="line.89"></a>
<FONT color="green">090</FONT> *<a name="line.90"></a>
<FONT color="green">091</FONT> * @throws TransformerException<a name="line.91"></a>
<FONT color="green">092</FONT> */<a name="line.92"></a>
<FONT color="green">093</FONT> public static void addAttributes(SerializationHandler handler, int src)<a name="line.93"></a>
<FONT color="green">094</FONT> throws TransformerException<a name="line.94"></a>
<FONT color="green">095</FONT> {<a name="line.95"></a>
<FONT color="green">096</FONT> <a name="line.96"></a>
<FONT color="green">097</FONT> TransformerImpl transformer =<a name="line.97"></a>
<FONT color="green">098</FONT> (TransformerImpl) handler.getTransformer();<a name="line.98"></a>
<FONT color="green">099</FONT> DTM dtm = transformer.getXPathContext().getDTM(src);<a name="line.99"></a>
<FONT color="green">100</FONT> <a name="line.100"></a>
<FONT color="green">101</FONT> for (int node = dtm.getFirstAttribute(src);<a name="line.101"></a>
<FONT color="green">102</FONT> DTM.NULL != node;<a name="line.102"></a>
<FONT color="green">103</FONT> node = dtm.getNextAttribute(node))<a name="line.103"></a>
<FONT color="green">104</FONT> {<a name="line.104"></a>
<FONT color="green">105</FONT> addAttribute(handler, node);<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> /**<a name="line.109"></a>
<FONT color="green">110</FONT> * Given a result tree fragment, walk the tree and<a name="line.110"></a>
<FONT color="green">111</FONT> * output it to the SerializationHandler.<a name="line.111"></a>
<FONT color="green">112</FONT> *<a name="line.112"></a>
<FONT color="green">113</FONT> * @param obj Result tree fragment object<a name="line.113"></a>
<FONT color="green">114</FONT> * @param support XPath context for the result tree fragment<a name="line.114"></a>
<FONT color="green">115</FONT> *<a name="line.115"></a>
<FONT color="green">116</FONT> * @throws org.xml.sax.SAXException<a name="line.116"></a>
<FONT color="green">117</FONT> */<a name="line.117"></a>
<FONT color="green">118</FONT> public static void outputResultTreeFragment(<a name="line.118"></a>
<FONT color="green">119</FONT> SerializationHandler handler,<a name="line.119"></a>
<FONT color="green">120</FONT> XObject obj,<a name="line.120"></a>
<FONT color="green">121</FONT> XPathContext support)<a name="line.121"></a>
<FONT color="green">122</FONT> throws org.xml.sax.SAXException<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> int doc = obj.rtf();<a name="line.125"></a>
<FONT color="green">126</FONT> DTM dtm = support.getDTM(doc);<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> if (null != dtm)<a name="line.128"></a>
<FONT color="green">129</FONT> {<a name="line.129"></a>
<FONT color="green">130</FONT> for (int n = dtm.getFirstChild(doc);<a name="line.130"></a>
<FONT color="green">131</FONT> DTM.NULL != n;<a name="line.131"></a>
<FONT color="green">132</FONT> n = dtm.getNextSibling(n))<a name="line.132"></a>
<FONT color="green">133</FONT> {<a name="line.133"></a>
<FONT color="green">134</FONT> handler.flushPending();<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> // I think. . . . This used to have a (true) arg<a name="line.136"></a>
<FONT color="green">137</FONT> // to flush prefixes, will that cause problems ???<a name="line.137"></a>
<FONT color="green">138</FONT> if (dtm.getNodeType(n) == DTM.ELEMENT_NODE<a name="line.138"></a>
<FONT color="green">139</FONT> &amp;&amp; dtm.getNamespaceURI(n) == null)<a name="line.139"></a>
<FONT color="green">140</FONT> handler.startPrefixMapping("", "");<a name="line.140"></a>
<FONT color="green">141</FONT> dtm.dispatchToEvents(n, handler);<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> }<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> * Copy &lt;KBD&gt;xmlns:&lt;/KBD&gt; attributes in if not already in scope.<a name="line.147"></a>
<FONT color="green">148</FONT> *<a name="line.148"></a>
<FONT color="green">149</FONT> * As a quick hack to support ClonerToResultTree, this can also be used<a name="line.149"></a>
<FONT color="green">150</FONT> * to copy an individual namespace node.<a name="line.150"></a>
<FONT color="green">151</FONT> *<a name="line.151"></a>
<FONT color="green">152</FONT> * @param src Source Node<a name="line.152"></a>
<FONT color="green">153</FONT> * NEEDSDOC @param type<a name="line.153"></a>
<FONT color="green">154</FONT> * NEEDSDOC @param dtm<a name="line.154"></a>
<FONT color="green">155</FONT> *<a name="line.155"></a>
<FONT color="green">156</FONT> * @throws TransformerException<a name="line.156"></a>
<FONT color="green">157</FONT> */<a name="line.157"></a>
<FONT color="green">158</FONT> public static void processNSDecls(<a name="line.158"></a>
<FONT color="green">159</FONT> SerializationHandler handler,<a name="line.159"></a>
<FONT color="green">160</FONT> int src,<a name="line.160"></a>
<FONT color="green">161</FONT> int type,<a name="line.161"></a>
<FONT color="green">162</FONT> DTM dtm)<a name="line.162"></a>
<FONT color="green">163</FONT> throws TransformerException<a name="line.163"></a>
<FONT color="green">164</FONT> {<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> try<a name="line.166"></a>
<FONT color="green">167</FONT> {<a name="line.167"></a>
<FONT color="green">168</FONT> if (type == DTM.ELEMENT_NODE)<a name="line.168"></a>
<FONT color="green">169</FONT> {<a name="line.169"></a>
<FONT color="green">170</FONT> for (int namespace = dtm.getFirstNamespaceNode(src, true);<a name="line.170"></a>
<FONT color="green">171</FONT> DTM.NULL != namespace;<a name="line.171"></a>
<FONT color="green">172</FONT> namespace = dtm.getNextNamespaceNode(src, namespace, true))<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> // String prefix = dtm.getPrefix(namespace);<a name="line.175"></a>
<FONT color="green">176</FONT> String prefix = dtm.getNodeNameX(namespace);<a name="line.176"></a>
<FONT color="green">177</FONT> String desturi = handler.getNamespaceURIFromPrefix(prefix);<a name="line.177"></a>
<FONT color="green">178</FONT> // String desturi = getURI(prefix);<a name="line.178"></a>
<FONT color="green">179</FONT> String srcURI = dtm.getNodeValue(namespace);<a name="line.179"></a>
<FONT color="green">180</FONT> <a name="line.180"></a>
<FONT color="green">181</FONT> if (!srcURI.equalsIgnoreCase(desturi))<a name="line.181"></a>
<FONT color="green">182</FONT> {<a name="line.182"></a>
<FONT color="green">183</FONT> handler.startPrefixMapping(prefix, srcURI, false);<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> else if (type == DTM.NAMESPACE_NODE)<a name="line.187"></a>
<FONT color="green">188</FONT> {<a name="line.188"></a>
<FONT color="green">189</FONT> String prefix = dtm.getNodeNameX(src);<a name="line.189"></a>
<FONT color="green">190</FONT> // Brian M. - some changes here to get desturi<a name="line.190"></a>
<FONT color="green">191</FONT> String desturi = handler.getNamespaceURIFromPrefix(prefix);<a name="line.191"></a>
<FONT color="green">192</FONT> String srcURI = dtm.getNodeValue(src);<a name="line.192"></a>
<FONT color="green">193</FONT> <a name="line.193"></a>
<FONT color="green">194</FONT> if (!srcURI.equalsIgnoreCase(desturi))<a name="line.194"></a>
<FONT color="green">195</FONT> {<a name="line.195"></a>
<FONT color="green">196</FONT> handler.startPrefixMapping(prefix, srcURI, false);<a name="line.196"></a>
<FONT color="green">197</FONT> }<a name="line.197"></a>
<FONT color="green">198</FONT> }<a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> catch (org.xml.sax.SAXException se)<a name="line.200"></a>
<FONT color="green">201</FONT> {<a name="line.201"></a>
<FONT color="green">202</FONT> throw new TransformerException(se);<a name="line.202"></a>
<FONT color="green">203</FONT> }<a name="line.203"></a>
<FONT color="green">204</FONT> }<a name="line.204"></a>
<FONT color="green">205</FONT> <a name="line.205"></a>
<FONT color="green">206</FONT> /**<a name="line.206"></a>
<FONT color="green">207</FONT> * Returns whether a namespace is defined<a name="line.207"></a>
<FONT color="green">208</FONT> *<a name="line.208"></a>
<FONT color="green">209</FONT> *<a name="line.209"></a>
<FONT color="green">210</FONT> * @param attr Namespace attribute node<a name="line.210"></a>
<FONT color="green">211</FONT> * @param dtm The DTM that owns attr.<a name="line.211"></a>
<FONT color="green">212</FONT> *<a name="line.212"></a>
<FONT color="green">213</FONT> * @return True if the namespace is already defined in<a name="line.213"></a>
<FONT color="green">214</FONT> * list of namespaces<a name="line.214"></a>
<FONT color="green">215</FONT> */<a name="line.215"></a>
<FONT color="green">216</FONT> public static boolean isDefinedNSDecl(<a name="line.216"></a>
<FONT color="green">217</FONT> SerializationHandler serializer,<a name="line.217"></a>
<FONT color="green">218</FONT> int attr,<a name="line.218"></a>
<FONT color="green">219</FONT> DTM dtm)<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 (DTM.NAMESPACE_NODE == dtm.getNodeType(attr))<a name="line.222"></a>
<FONT color="green">223</FONT> {<a name="line.223"></a>
<FONT color="green">224</FONT> <a name="line.224"></a>
<FONT color="green">225</FONT> // String prefix = dtm.getPrefix(attr);<a name="line.225"></a>
<FONT color="green">226</FONT> String prefix = dtm.getNodeNameX(attr);<a name="line.226"></a>
<FONT color="green">227</FONT> String uri = serializer.getNamespaceURIFromPrefix(prefix);<a name="line.227"></a>
<FONT color="green">228</FONT> // String uri = getURI(prefix);<a name="line.228"></a>
<FONT color="green">229</FONT> <a name="line.229"></a>
<FONT color="green">230</FONT> if ((null != uri) &amp;&amp; uri.equals(dtm.getStringValue(attr)))<a name="line.230"></a>
<FONT color="green">231</FONT> return true;<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> return false;<a name="line.234"></a>
<FONT color="green">235</FONT> }<a name="line.235"></a>
<FONT color="green">236</FONT> <a name="line.236"></a>
<FONT color="green">237</FONT> /**<a name="line.237"></a>
<FONT color="green">238</FONT> * This function checks to make sure a given prefix is really<a name="line.238"></a>
<FONT color="green">239</FONT> * declared. It might not be, because it may be an excluded prefix.<a name="line.239"></a>
<FONT color="green">240</FONT> * If it's not, it still needs to be declared at this point.<a name="line.240"></a>
<FONT color="green">241</FONT> * TODO: This needs to be done at an earlier stage in the game... -sb<a name="line.241"></a>
<FONT color="green">242</FONT> *<a name="line.242"></a>
<FONT color="green">243</FONT> * NEEDSDOC @param dtm<a name="line.243"></a>
<FONT color="green">244</FONT> * NEEDSDOC @param namespace<a name="line.244"></a>
<FONT color="green">245</FONT> *<a name="line.245"></a>
<FONT color="green">246</FONT> * @throws org.xml.sax.SAXException<a name="line.246"></a>
<FONT color="green">247</FONT> */<a name="line.247"></a>
<FONT color="green">248</FONT> public static void ensureNamespaceDeclDeclared(<a name="line.248"></a>
<FONT color="green">249</FONT> SerializationHandler handler,<a name="line.249"></a>
<FONT color="green">250</FONT> DTM dtm,<a name="line.250"></a>
<FONT color="green">251</FONT> int namespace)<a name="line.251"></a>
<FONT color="green">252</FONT> throws org.xml.sax.SAXException<a name="line.252"></a>
<FONT color="green">253</FONT> {<a name="line.253"></a>
<FONT color="green">254</FONT> <a name="line.254"></a>
<FONT color="green">255</FONT> String uri = dtm.getNodeValue(namespace);<a name="line.255"></a>
<FONT color="green">256</FONT> String prefix = dtm.getNodeNameX(namespace);<a name="line.256"></a>
<FONT color="green">257</FONT> <a name="line.257"></a>
<FONT color="green">258</FONT> if ((uri != null &amp;&amp; uri.length() &gt; 0) &amp;&amp; (null != prefix))<a name="line.258"></a>
<FONT color="green">259</FONT> {<a name="line.259"></a>
<FONT color="green">260</FONT> String foundURI;<a name="line.260"></a>
<FONT color="green">261</FONT> NamespaceMappings ns = handler.getNamespaceMappings();<a name="line.261"></a>
<FONT color="green">262</FONT> if (ns != null)<a name="line.262"></a>
<FONT color="green">263</FONT> {<a name="line.263"></a>
<FONT color="green">264</FONT> <a name="line.264"></a>
<FONT color="green">265</FONT> foundURI = ns.lookupNamespace(prefix);<a name="line.265"></a>
<FONT color="green">266</FONT> if ((null == foundURI) || !foundURI.equals(uri))<a name="line.266"></a>
<FONT color="green">267</FONT> {<a name="line.267"></a>
<FONT color="green">268</FONT> handler.startPrefixMapping(prefix, uri, false);<a name="line.268"></a>
<FONT color="green">269</FONT> }<a name="line.269"></a>
<FONT color="green">270</FONT> }<a name="line.270"></a>
<FONT color="green">271</FONT> }<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>
</PRE>
</BODY>
</HTML>