blob: 4a3a50a103b7670c4b5c3e56a789c54b5a155af5 [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> // $Id: XPathExpressionImpl.java 1225277 2011-12-28 18:50:56Z mrglavas $<a name="line.18"></a>
<FONT color="green">019</FONT> <a name="line.19"></a>
<FONT color="green">020</FONT> package org.apache.xpath.jaxp;<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> import javax.xml.namespace.QName;<a name="line.22"></a>
<FONT color="green">023</FONT> import javax.xml.parsers.DocumentBuilder;<a name="line.23"></a>
<FONT color="green">024</FONT> import javax.xml.parsers.DocumentBuilderFactory;<a name="line.24"></a>
<FONT color="green">025</FONT> import javax.xml.xpath.XPathConstants;<a name="line.25"></a>
<FONT color="green">026</FONT> import javax.xml.xpath.XPathExpressionException;<a name="line.26"></a>
<FONT color="green">027</FONT> import javax.xml.xpath.XPathFunctionResolver;<a name="line.27"></a>
<FONT color="green">028</FONT> import javax.xml.xpath.XPathVariableResolver;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xalan.res.XSLMessages;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.xpath.objects.XObject;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.xpath.res.XPATHErrorResources;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.w3c.dom.DOMImplementation;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.w3c.dom.Document;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.w3c.dom.Node;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.w3c.dom.traversal.NodeIterator;<a name="line.36"></a>
<FONT color="green">037</FONT> import org.xml.sax.InputSource;<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> * The XPathExpression interface encapsulates a (compiled) XPath expression.<a name="line.40"></a>
<FONT color="green">041</FONT> *<a name="line.41"></a>
<FONT color="green">042</FONT> * @version $Revision: 1225277 $<a name="line.42"></a>
<FONT color="green">043</FONT> * @author Ramesh Mandava<a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> public class XPathExpressionImpl implements javax.xml.xpath.XPathExpression{<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> private XPathFunctionResolver functionResolver;<a name="line.47"></a>
<FONT color="green">048</FONT> private XPathVariableResolver variableResolver;<a name="line.48"></a>
<FONT color="green">049</FONT> private JAXPPrefixResolver prefixResolver;<a name="line.49"></a>
<FONT color="green">050</FONT> private org.apache.xpath.XPath xpath;<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> // By default Extension Functions are allowed in XPath Expressions. If<a name="line.52"></a>
<FONT color="green">053</FONT> // Secure Processing Feature is set on XPathFactory then the invocation of<a name="line.53"></a>
<FONT color="green">054</FONT> // extensions function need to throw XPathFunctionException<a name="line.54"></a>
<FONT color="green">055</FONT> private boolean featureSecureProcessing = false;<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /** Protected constructor to prevent direct instantiation; use compile()<a name="line.57"></a>
<FONT color="green">058</FONT> * from the context.<a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> protected XPathExpressionImpl() { };<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> protected XPathExpressionImpl(org.apache.xpath.XPath xpath, <a name="line.62"></a>
<FONT color="green">063</FONT> JAXPPrefixResolver prefixResolver, <a name="line.63"></a>
<FONT color="green">064</FONT> XPathFunctionResolver functionResolver,<a name="line.64"></a>
<FONT color="green">065</FONT> XPathVariableResolver variableResolver ) { <a name="line.65"></a>
<FONT color="green">066</FONT> this.xpath = xpath;<a name="line.66"></a>
<FONT color="green">067</FONT> this.prefixResolver = prefixResolver;<a name="line.67"></a>
<FONT color="green">068</FONT> this.functionResolver = functionResolver;<a name="line.68"></a>
<FONT color="green">069</FONT> this.variableResolver = variableResolver;<a name="line.69"></a>
<FONT color="green">070</FONT> this.featureSecureProcessing = false;<a name="line.70"></a>
<FONT color="green">071</FONT> };<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> protected XPathExpressionImpl(org.apache.xpath.XPath xpath,<a name="line.73"></a>
<FONT color="green">074</FONT> JAXPPrefixResolver prefixResolver,<a name="line.74"></a>
<FONT color="green">075</FONT> XPathFunctionResolver functionResolver,<a name="line.75"></a>
<FONT color="green">076</FONT> XPathVariableResolver variableResolver,<a name="line.76"></a>
<FONT color="green">077</FONT> boolean featureSecureProcessing ) { <a name="line.77"></a>
<FONT color="green">078</FONT> this.xpath = xpath;<a name="line.78"></a>
<FONT color="green">079</FONT> this.prefixResolver = prefixResolver;<a name="line.79"></a>
<FONT color="green">080</FONT> this.functionResolver = functionResolver;<a name="line.80"></a>
<FONT color="green">081</FONT> this.variableResolver = variableResolver;<a name="line.81"></a>
<FONT color="green">082</FONT> this.featureSecureProcessing = featureSecureProcessing;<a name="line.82"></a>
<FONT color="green">083</FONT> };<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> public void setXPath (org.apache.xpath.XPath xpath ) {<a name="line.85"></a>
<FONT color="green">086</FONT> this.xpath = xpath;<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> public Object eval(Object item, QName returnType)<a name="line.89"></a>
<FONT color="green">090</FONT> throws javax.xml.transform.TransformerException {<a name="line.90"></a>
<FONT color="green">091</FONT> XObject resultObject = eval ( item );<a name="line.91"></a>
<FONT color="green">092</FONT> return getResultAsType( resultObject, returnType );<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> <a name="line.94"></a>
<FONT color="green">095</FONT> private XObject eval ( Object contextItem )<a name="line.95"></a>
<FONT color="green">096</FONT> throws javax.xml.transform.TransformerException {<a name="line.96"></a>
<FONT color="green">097</FONT> org.apache.xpath.XPathContext xpathSupport = null;<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> // Create an XPathContext that doesn't support pushing and popping of<a name="line.99"></a>
<FONT color="green">100</FONT> // variable resolution scopes. Sufficient for simple XPath 1.0<a name="line.100"></a>
<FONT color="green">101</FONT> // expressions.<a name="line.101"></a>
<FONT color="green">102</FONT> if ( functionResolver != null ) {<a name="line.102"></a>
<FONT color="green">103</FONT> JAXPExtensionsProvider jep = new JAXPExtensionsProvider(<a name="line.103"></a>
<FONT color="green">104</FONT> functionResolver, featureSecureProcessing );<a name="line.104"></a>
<FONT color="green">105</FONT> xpathSupport = new org.apache.xpath.XPathContext(jep, false);<a name="line.105"></a>
<FONT color="green">106</FONT> } else {<a name="line.106"></a>
<FONT color="green">107</FONT> xpathSupport = new org.apache.xpath.XPathContext(false);<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> xpathSupport.setVarStack(new JAXPVariableStack(variableResolver));<a name="line.110"></a>
<FONT color="green">111</FONT> XObject xobj = null;<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> Node contextNode = (Node)contextItem;<a name="line.113"></a>
<FONT color="green">114</FONT> // We always need to have a ContextNode with Xalan XPath implementation<a name="line.114"></a>
<FONT color="green">115</FONT> // To allow simple expression evaluation like 1+1 we are setting <a name="line.115"></a>
<FONT color="green">116</FONT> // dummy Document as Context Node<a name="line.116"></a>
<FONT color="green">117</FONT> if ( contextNode == null ) {<a name="line.117"></a>
<FONT color="green">118</FONT> contextNode = getDummyDocument();<a name="line.118"></a>
<FONT color="green">119</FONT> } <a name="line.119"></a>
<FONT color="green">120</FONT> <a name="line.120"></a>
<FONT color="green">121</FONT> xobj = xpath.execute(xpathSupport, contextNode, prefixResolver );<a name="line.121"></a>
<FONT color="green">122</FONT> return xobj;<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> <a name="line.125"></a>
<FONT color="green">126</FONT> /**<a name="line.126"></a>
<FONT color="green">127</FONT> * &lt;p&gt;Evaluate the compiled XPath expression in the specified context and<a name="line.127"></a>
<FONT color="green">128</FONT> * return the result as the specified type.&lt;/p&gt;<a name="line.128"></a>
<FONT color="green">129</FONT> *<a name="line.129"></a>
<FONT color="green">130</FONT> * &lt;p&gt;See "Evaluation of XPath Expressions" section of JAXP 1.3 spec<a name="line.130"></a>
<FONT color="green">131</FONT> * for context item evaluation,<a name="line.131"></a>
<FONT color="green">132</FONT> * variable, function and QName resolution and return type conversion.&lt;/p&gt;<a name="line.132"></a>
<FONT color="green">133</FONT> *<a name="line.133"></a>
<FONT color="green">134</FONT> * &lt;p&gt;If &lt;code&gt;returnType&lt;/code&gt; is not one of the types defined <a name="line.134"></a>
<FONT color="green">135</FONT> * in {@link XPathConstants},<a name="line.135"></a>
<FONT color="green">136</FONT> * then an &lt;code&gt;IllegalArgumentException&lt;/code&gt; is thrown.&lt;/p&gt;<a name="line.136"></a>
<FONT color="green">137</FONT> *<a name="line.137"></a>
<FONT color="green">138</FONT> * &lt;p&gt;If a &lt;code&gt;null&lt;/code&gt; value is provided for<a name="line.138"></a>
<FONT color="green">139</FONT> * &lt;code&gt;item&lt;/code&gt;, an empty document will be used for the<a name="line.139"></a>
<FONT color="green">140</FONT> * context.<a name="line.140"></a>
<FONT color="green">141</FONT> * If &lt;code&gt;returnType&lt;/code&gt; is &lt;code&gt;null&lt;/code&gt;, then a <a name="line.141"></a>
<FONT color="green">142</FONT> * &lt;code&gt;NullPointerException&lt;/code&gt; is thrown.&lt;/p&gt;<a name="line.142"></a>
<FONT color="green">143</FONT> *<a name="line.143"></a>
<FONT color="green">144</FONT> * @param item The starting context (node or node list, for example).<a name="line.144"></a>
<FONT color="green">145</FONT> * @param returnType The desired return type.<a name="line.145"></a>
<FONT color="green">146</FONT> *<a name="line.146"></a>
<FONT color="green">147</FONT> * @return The &lt;code&gt;Object&lt;/code&gt; that is the result of evaluating the<a name="line.147"></a>
<FONT color="green">148</FONT> * expression and converting the result to<a name="line.148"></a>
<FONT color="green">149</FONT> * &lt;code&gt;returnType&lt;/code&gt;.<a name="line.149"></a>
<FONT color="green">150</FONT> *<a name="line.150"></a>
<FONT color="green">151</FONT> * @throws XPathExpressionException If the expression cannot be evaluated.<a name="line.151"></a>
<FONT color="green">152</FONT> * @throws IllegalArgumentException If &lt;code&gt;returnType&lt;/code&gt; is not one<a name="line.152"></a>
<FONT color="green">153</FONT> * of the types defined in {@link XPathConstants}.<a name="line.153"></a>
<FONT color="green">154</FONT> * @throws NullPointerException If &lt;code&gt;returnType&lt;/code&gt; is<a name="line.154"></a>
<FONT color="green">155</FONT> * &lt;code&gt;null&lt;/code&gt;.<a name="line.155"></a>
<FONT color="green">156</FONT> */<a name="line.156"></a>
<FONT color="green">157</FONT> public Object evaluate(Object item, QName returnType)<a name="line.157"></a>
<FONT color="green">158</FONT> throws XPathExpressionException {<a name="line.158"></a>
<FONT color="green">159</FONT> //Validating parameters to enforce constraints defined by JAXP spec<a name="line.159"></a>
<FONT color="green">160</FONT> if ( returnType == null ) {<a name="line.160"></a>
<FONT color="green">161</FONT> //Throwing NullPointerException as defined in spec<a name="line.161"></a>
<FONT color="green">162</FONT> String fmsg = XSLMessages.createXPATHMessage( <a name="line.162"></a>
<FONT color="green">163</FONT> XPATHErrorResources.ER_ARG_CANNOT_BE_NULL,<a name="line.163"></a>
<FONT color="green">164</FONT> new Object[] {"returnType"} );<a name="line.164"></a>
<FONT color="green">165</FONT> throw new NullPointerException( fmsg );<a name="line.165"></a>
<FONT color="green">166</FONT> }<a name="line.166"></a>
<FONT color="green">167</FONT> // Checking if requested returnType is supported. returnType need to be<a name="line.167"></a>
<FONT color="green">168</FONT> // defined in XPathConstants <a name="line.168"></a>
<FONT color="green">169</FONT> if ( !isSupported ( returnType ) ) {<a name="line.169"></a>
<FONT color="green">170</FONT> String fmsg = XSLMessages.createXPATHMessage( <a name="line.170"></a>
<FONT color="green">171</FONT> XPATHErrorResources.ER_UNSUPPORTED_RETURN_TYPE,<a name="line.171"></a>
<FONT color="green">172</FONT> new Object[] { returnType.toString() } );<a name="line.172"></a>
<FONT color="green">173</FONT> throw new IllegalArgumentException ( fmsg );<a name="line.173"></a>
<FONT color="green">174</FONT> }<a name="line.174"></a>
<FONT color="green">175</FONT> try { <a name="line.175"></a>
<FONT color="green">176</FONT> return eval( item, returnType);<a name="line.176"></a>
<FONT color="green">177</FONT> } catch ( java.lang.NullPointerException npe ) {<a name="line.177"></a>
<FONT color="green">178</FONT> // If VariableResolver returns null Or if we get <a name="line.178"></a>
<FONT color="green">179</FONT> // NullPointerException at this stage for some other reason<a name="line.179"></a>
<FONT color="green">180</FONT> // then we have to reurn XPathException<a name="line.180"></a>
<FONT color="green">181</FONT> throw new XPathExpressionException ( npe );<a name="line.181"></a>
<FONT color="green">182</FONT> } catch ( javax.xml.transform.TransformerException te ) {<a name="line.182"></a>
<FONT color="green">183</FONT> Throwable nestedException = te.getException();<a name="line.183"></a>
<FONT color="green">184</FONT> if ( nestedException instanceof javax.xml.xpath.XPathFunctionException ) {<a name="line.184"></a>
<FONT color="green">185</FONT> throw (javax.xml.xpath.XPathFunctionException)nestedException;<a name="line.185"></a>
<FONT color="green">186</FONT> } else {<a name="line.186"></a>
<FONT color="green">187</FONT> // For any other exceptions we need to throw<a name="line.187"></a>
<FONT color="green">188</FONT> // XPathExpressionException ( as per spec )<a name="line.188"></a>
<FONT color="green">189</FONT> throw new XPathExpressionException( te);<a name="line.189"></a>
<FONT color="green">190</FONT> }<a name="line.190"></a>
<FONT color="green">191</FONT> }<a name="line.191"></a>
<FONT color="green">192</FONT> <a name="line.192"></a>
<FONT color="green">193</FONT> }<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> /**<a name="line.195"></a>
<FONT color="green">196</FONT> * &lt;p&gt;Evaluate the compiled XPath expression in the specified context and<a name="line.196"></a>
<FONT color="green">197</FONT> * return the result as a &lt;code&gt;String&lt;/code&gt;.&lt;/p&gt;<a name="line.197"></a>
<FONT color="green">198</FONT> *<a name="line.198"></a>
<FONT color="green">199</FONT> * &lt;p&gt;This method calls {@link #evaluate(Object item, QName returnType)}<a name="line.199"></a>
<FONT color="green">200</FONT> * with a &lt;code&gt;returnType&lt;/code&gt; of<a name="line.200"></a>
<FONT color="green">201</FONT> * {@link XPathConstants#STRING}.&lt;/p&gt;<a name="line.201"></a>
<FONT color="green">202</FONT> *<a name="line.202"></a>
<FONT color="green">203</FONT> * &lt;p&gt;See "Evaluation of XPath Expressions" section of JAXP 1.3 spec<a name="line.203"></a>
<FONT color="green">204</FONT> * for context item evaluation,<a name="line.204"></a>
<FONT color="green">205</FONT> * variable, function and QName resolution and return type conversion.&lt;/p&gt;<a name="line.205"></a>
<FONT color="green">206</FONT> *<a name="line.206"></a>
<FONT color="green">207</FONT> * &lt;p&gt;If a &lt;code&gt;null&lt;/code&gt; value is provided for<a name="line.207"></a>
<FONT color="green">208</FONT> * &lt;code&gt;item&lt;/code&gt;, an empty document will be used for the<a name="line.208"></a>
<FONT color="green">209</FONT> * context.<a name="line.209"></a>
<FONT color="green">210</FONT> *<a name="line.210"></a>
<FONT color="green">211</FONT> * @param item The starting context (node or node list, for example).<a name="line.211"></a>
<FONT color="green">212</FONT> *<a name="line.212"></a>
<FONT color="green">213</FONT> * @return The &lt;code&gt;String&lt;/code&gt; that is the result of evaluating the<a name="line.213"></a>
<FONT color="green">214</FONT> * expression and converting the result to a<a name="line.214"></a>
<FONT color="green">215</FONT> * &lt;code&gt;String&lt;/code&gt;.<a name="line.215"></a>
<FONT color="green">216</FONT> *<a name="line.216"></a>
<FONT color="green">217</FONT> * @throws XPathExpressionException If the expression cannot be evaluated.<a name="line.217"></a>
<FONT color="green">218</FONT> */<a name="line.218"></a>
<FONT color="green">219</FONT> public String evaluate(Object item) <a name="line.219"></a>
<FONT color="green">220</FONT> throws XPathExpressionException {<a name="line.220"></a>
<FONT color="green">221</FONT> return (String)this.evaluate( item, XPathConstants.STRING );<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> <a name="line.224"></a>
<FONT color="green">225</FONT> <a name="line.225"></a>
<FONT color="green">226</FONT> static DocumentBuilderFactory dbf = null;<a name="line.226"></a>
<FONT color="green">227</FONT> static DocumentBuilder db = null;<a name="line.227"></a>
<FONT color="green">228</FONT> static Document d = null;<a name="line.228"></a>
<FONT color="green">229</FONT> <a name="line.229"></a>
<FONT color="green">230</FONT> /**<a name="line.230"></a>
<FONT color="green">231</FONT> * &lt;p&gt;Evaluate the compiled XPath expression in the context of the <a name="line.231"></a>
<FONT color="green">232</FONT> * specified &lt;code&gt;InputSource&lt;/code&gt; and return the result as the<a name="line.232"></a>
<FONT color="green">233</FONT> * specified type.&lt;/p&gt;<a name="line.233"></a>
<FONT color="green">234</FONT> *<a name="line.234"></a>
<FONT color="green">235</FONT> * &lt;p&gt;This method builds a data model for the {@link InputSource} and calls<a name="line.235"></a>
<FONT color="green">236</FONT> * {@link #evaluate(Object item, QName returnType)} on the resulting <a name="line.236"></a>
<FONT color="green">237</FONT> * document object.&lt;/p&gt;<a name="line.237"></a>
<FONT color="green">238</FONT> *<a name="line.238"></a>
<FONT color="green">239</FONT> * &lt;p&gt;See "Evaluation of XPath Expressions" section of JAXP 1.3 spec<a name="line.239"></a>
<FONT color="green">240</FONT> * for context item evaluation,<a name="line.240"></a>
<FONT color="green">241</FONT> * variable, function and QName resolution and return type conversion.&lt;/p&gt;<a name="line.241"></a>
<FONT color="green">242</FONT> *<a name="line.242"></a>
<FONT color="green">243</FONT> * &lt;p&gt;If &lt;code&gt;returnType&lt;/code&gt; is not one of the types defined in <a name="line.243"></a>
<FONT color="green">244</FONT> * {@link XPathConstants},<a name="line.244"></a>
<FONT color="green">245</FONT> * then an &lt;code&gt;IllegalArgumentException&lt;/code&gt; is thrown.&lt;/p&gt;<a name="line.245"></a>
<FONT color="green">246</FONT> *<a name="line.246"></a>
<FONT color="green">247</FONT> *&lt;p&gt;If &lt;code&gt;source&lt;/code&gt; or &lt;code&gt;returnType&lt;/code&gt; is &lt;code&gt;null&lt;/code&gt;,<a name="line.247"></a>
<FONT color="green">248</FONT> * then a &lt;code&gt;NullPointerException&lt;/code&gt; is thrown.&lt;/p&gt;<a name="line.248"></a>
<FONT color="green">249</FONT> *<a name="line.249"></a>
<FONT color="green">250</FONT> * @param source The &lt;code&gt;InputSource&lt;/code&gt; of the document to evaluate<a name="line.250"></a>
<FONT color="green">251</FONT> * over.<a name="line.251"></a>
<FONT color="green">252</FONT> * @param returnType The desired return type.<a name="line.252"></a>
<FONT color="green">253</FONT> *<a name="line.253"></a>
<FONT color="green">254</FONT> * @return The &lt;code&gt;Object&lt;/code&gt; that is the result of evaluating the<a name="line.254"></a>
<FONT color="green">255</FONT> * expression and converting the result to<a name="line.255"></a>
<FONT color="green">256</FONT> * &lt;code&gt;returnType&lt;/code&gt;.<a name="line.256"></a>
<FONT color="green">257</FONT> *<a name="line.257"></a>
<FONT color="green">258</FONT> * @throws XPathExpressionException If the expression cannot be evaluated.<a name="line.258"></a>
<FONT color="green">259</FONT> * @throws IllegalArgumentException If &lt;code&gt;returnType&lt;/code&gt; is not one<a name="line.259"></a>
<FONT color="green">260</FONT> * of the types defined in {@link XPathConstants}.<a name="line.260"></a>
<FONT color="green">261</FONT> * @throws NullPointerException If &lt;code&gt;source&lt;/code&gt; or <a name="line.261"></a>
<FONT color="green">262</FONT> * &lt;code&gt;returnType&lt;/code&gt; is &lt;code&gt;null&lt;/code&gt;.<a name="line.262"></a>
<FONT color="green">263</FONT> */<a name="line.263"></a>
<FONT color="green">264</FONT> public Object evaluate(InputSource source, QName returnType)<a name="line.264"></a>
<FONT color="green">265</FONT> throws XPathExpressionException {<a name="line.265"></a>
<FONT color="green">266</FONT> if ( ( source == null ) || ( returnType == null ) ) {<a name="line.266"></a>
<FONT color="green">267</FONT> String fmsg = XSLMessages.createXPATHMessage( <a name="line.267"></a>
<FONT color="green">268</FONT> XPATHErrorResources.ER_SOURCE_RETURN_TYPE_CANNOT_BE_NULL,<a name="line.268"></a>
<FONT color="green">269</FONT> null );<a name="line.269"></a>
<FONT color="green">270</FONT> throw new NullPointerException ( fmsg );<a name="line.270"></a>
<FONT color="green">271</FONT> }<a name="line.271"></a>
<FONT color="green">272</FONT> // Checking if requested returnType is supported. returnType need to be<a name="line.272"></a>
<FONT color="green">273</FONT> // defined in XPathConstants <a name="line.273"></a>
<FONT color="green">274</FONT> if ( !isSupported ( returnType ) ) {<a name="line.274"></a>
<FONT color="green">275</FONT> String fmsg = XSLMessages.createXPATHMessage( <a name="line.275"></a>
<FONT color="green">276</FONT> XPATHErrorResources.ER_UNSUPPORTED_RETURN_TYPE,<a name="line.276"></a>
<FONT color="green">277</FONT> new Object[] { returnType.toString() } );<a name="line.277"></a>
<FONT color="green">278</FONT> throw new IllegalArgumentException ( fmsg );<a name="line.278"></a>
<FONT color="green">279</FONT> }<a name="line.279"></a>
<FONT color="green">280</FONT> try {<a name="line.280"></a>
<FONT color="green">281</FONT> if ( dbf == null ) {<a name="line.281"></a>
<FONT color="green">282</FONT> dbf = DocumentBuilderFactory.newInstance();<a name="line.282"></a>
<FONT color="green">283</FONT> dbf.setNamespaceAware( true );<a name="line.283"></a>
<FONT color="green">284</FONT> dbf.setValidating( false );<a name="line.284"></a>
<FONT color="green">285</FONT> }<a name="line.285"></a>
<FONT color="green">286</FONT> db = dbf.newDocumentBuilder();<a name="line.286"></a>
<FONT color="green">287</FONT> Document document = db.parse( source );<a name="line.287"></a>
<FONT color="green">288</FONT> return eval( document, returnType );<a name="line.288"></a>
<FONT color="green">289</FONT> } catch ( Exception e ) {<a name="line.289"></a>
<FONT color="green">290</FONT> throw new XPathExpressionException ( e );<a name="line.290"></a>
<FONT color="green">291</FONT> }<a name="line.291"></a>
<FONT color="green">292</FONT> }<a name="line.292"></a>
<FONT color="green">293</FONT> <a name="line.293"></a>
<FONT color="green">294</FONT> /**<a name="line.294"></a>
<FONT color="green">295</FONT> * &lt;p&gt;Evaluate the compiled XPath expression in the context of the specified &lt;code&gt;InputSource&lt;/code&gt; and return the result as a<a name="line.295"></a>
<FONT color="green">296</FONT> * &lt;code&gt;String&lt;/code&gt;.&lt;/p&gt;<a name="line.296"></a>
<FONT color="green">297</FONT> *<a name="line.297"></a>
<FONT color="green">298</FONT> * &lt;p&gt;This method calls {@link #evaluate(InputSource source, QName returnType)} with a &lt;code&gt;returnType&lt;/code&gt; of<a name="line.298"></a>
<FONT color="green">299</FONT> * {@link XPathConstants#STRING}.&lt;/p&gt;<a name="line.299"></a>
<FONT color="green">300</FONT> *<a name="line.300"></a>
<FONT color="green">301</FONT> * &lt;p&gt;See "Evaluation of XPath Expressions" section of JAXP 1.3 spec<a name="line.301"></a>
<FONT color="green">302</FONT> * for context item evaluation,<a name="line.302"></a>
<FONT color="green">303</FONT> * variable, function and QName resolution and return type conversion.&lt;/p&gt;<a name="line.303"></a>
<FONT color="green">304</FONT> *<a name="line.304"></a>
<FONT color="green">305</FONT> * &lt;p&gt;If &lt;code&gt;source&lt;/code&gt; is &lt;code&gt;null&lt;/code&gt;, then a &lt;code&gt;NullPointerException&lt;/code&gt; is thrown.&lt;/p&gt;<a name="line.305"></a>
<FONT color="green">306</FONT> *<a name="line.306"></a>
<FONT color="green">307</FONT> * @param source The &lt;code&gt;InputSource&lt;/code&gt; of the document to evaluate over.<a name="line.307"></a>
<FONT color="green">308</FONT> *<a name="line.308"></a>
<FONT color="green">309</FONT> * @return The &lt;code&gt;String&lt;/code&gt; that is the result of evaluating the expression and converting the result to a<a name="line.309"></a>
<FONT color="green">310</FONT> * &lt;code&gt;String&lt;/code&gt;.<a name="line.310"></a>
<FONT color="green">311</FONT> *<a name="line.311"></a>
<FONT color="green">312</FONT> * @throws XPathExpressionException If the expression cannot be evaluated.<a name="line.312"></a>
<FONT color="green">313</FONT> * @throws NullPointerException If &lt;code&gt;source&lt;/code&gt; is &lt;code&gt;null&lt;/code&gt;.<a name="line.313"></a>
<FONT color="green">314</FONT> */<a name="line.314"></a>
<FONT color="green">315</FONT> public String evaluate(InputSource source)<a name="line.315"></a>
<FONT color="green">316</FONT> throws XPathExpressionException {<a name="line.316"></a>
<FONT color="green">317</FONT> return (String)this.evaluate( source, XPathConstants.STRING );<a name="line.317"></a>
<FONT color="green">318</FONT> }<a name="line.318"></a>
<FONT color="green">319</FONT> <a name="line.319"></a>
<FONT color="green">320</FONT> private boolean isSupported( QName returnType ) {<a name="line.320"></a>
<FONT color="green">321</FONT> // XPathConstants.STRING<a name="line.321"></a>
<FONT color="green">322</FONT> if ( ( returnType.equals( XPathConstants.STRING ) ) ||<a name="line.322"></a>
<FONT color="green">323</FONT> ( returnType.equals( XPathConstants.NUMBER ) ) ||<a name="line.323"></a>
<FONT color="green">324</FONT> ( returnType.equals( XPathConstants.BOOLEAN ) ) ||<a name="line.324"></a>
<FONT color="green">325</FONT> ( returnType.equals( XPathConstants.NODE ) ) ||<a name="line.325"></a>
<FONT color="green">326</FONT> ( returnType.equals( XPathConstants.NODESET ) ) ) {<a name="line.326"></a>
<FONT color="green">327</FONT> <a name="line.327"></a>
<FONT color="green">328</FONT> return true;<a name="line.328"></a>
<FONT color="green">329</FONT> }<a name="line.329"></a>
<FONT color="green">330</FONT> return false;<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> private Object getResultAsType( XObject resultObject, QName returnType )<a name="line.333"></a>
<FONT color="green">334</FONT> throws javax.xml.transform.TransformerException {<a name="line.334"></a>
<FONT color="green">335</FONT> // XPathConstants.STRING<a name="line.335"></a>
<FONT color="green">336</FONT> if ( returnType.equals( XPathConstants.STRING ) ) {<a name="line.336"></a>
<FONT color="green">337</FONT> return resultObject.str();<a name="line.337"></a>
<FONT color="green">338</FONT> }<a name="line.338"></a>
<FONT color="green">339</FONT> // XPathConstants.NUMBER<a name="line.339"></a>
<FONT color="green">340</FONT> if ( returnType.equals( XPathConstants.NUMBER ) ) {<a name="line.340"></a>
<FONT color="green">341</FONT> return new Double ( resultObject.num());<a name="line.341"></a>
<FONT color="green">342</FONT> }<a name="line.342"></a>
<FONT color="green">343</FONT> // XPathConstants.BOOLEAN<a name="line.343"></a>
<FONT color="green">344</FONT> if ( returnType.equals( XPathConstants.BOOLEAN ) ) {<a name="line.344"></a>
<FONT color="green">345</FONT> return resultObject.bool() ? Boolean.TRUE : Boolean.FALSE;<a name="line.345"></a>
<FONT color="green">346</FONT> }<a name="line.346"></a>
<FONT color="green">347</FONT> // XPathConstants.NODESET ---ORdered, UNOrdered???<a name="line.347"></a>
<FONT color="green">348</FONT> if ( returnType.equals( XPathConstants.NODESET ) ) {<a name="line.348"></a>
<FONT color="green">349</FONT> return resultObject.nodelist();<a name="line.349"></a>
<FONT color="green">350</FONT> }<a name="line.350"></a>
<FONT color="green">351</FONT> // XPathConstants.NODE<a name="line.351"></a>
<FONT color="green">352</FONT> if ( returnType.equals( XPathConstants.NODE ) ) {<a name="line.352"></a>
<FONT color="green">353</FONT> NodeIterator ni = resultObject.nodeset();<a name="line.353"></a>
<FONT color="green">354</FONT> //Return the first node, or null<a name="line.354"></a>
<FONT color="green">355</FONT> return ni.nextNode();<a name="line.355"></a>
<FONT color="green">356</FONT> }<a name="line.356"></a>
<FONT color="green">357</FONT> // If isSupported check is already done then the execution path <a name="line.357"></a>
<FONT color="green">358</FONT> // shouldn't come here. Being defensive<a name="line.358"></a>
<FONT color="green">359</FONT> String fmsg = XSLMessages.createXPATHMessage( <a name="line.359"></a>
<FONT color="green">360</FONT> XPATHErrorResources.ER_UNSUPPORTED_RETURN_TYPE,<a name="line.360"></a>
<FONT color="green">361</FONT> new Object[] { returnType.toString()});<a name="line.361"></a>
<FONT color="green">362</FONT> throw new IllegalArgumentException ( fmsg );<a name="line.362"></a>
<FONT color="green">363</FONT> }<a name="line.363"></a>
<FONT color="green">364</FONT> <a name="line.364"></a>
<FONT color="green">365</FONT> <a name="line.365"></a>
<FONT color="green">366</FONT> private static Document getDummyDocument( ) {<a name="line.366"></a>
<FONT color="green">367</FONT> try {<a name="line.367"></a>
<FONT color="green">368</FONT> if ( dbf == null ) {<a name="line.368"></a>
<FONT color="green">369</FONT> dbf = DocumentBuilderFactory.newInstance();<a name="line.369"></a>
<FONT color="green">370</FONT> dbf.setNamespaceAware( true );<a name="line.370"></a>
<FONT color="green">371</FONT> dbf.setValidating( false );<a name="line.371"></a>
<FONT color="green">372</FONT> }<a name="line.372"></a>
<FONT color="green">373</FONT> db = dbf.newDocumentBuilder();<a name="line.373"></a>
<FONT color="green">374</FONT> <a name="line.374"></a>
<FONT color="green">375</FONT> DOMImplementation dim = db.getDOMImplementation();<a name="line.375"></a>
<FONT color="green">376</FONT> d = dim.createDocument("http://java.sun.com/jaxp/xpath",<a name="line.376"></a>
<FONT color="green">377</FONT> "dummyroot", null);<a name="line.377"></a>
<FONT color="green">378</FONT> return d;<a name="line.378"></a>
<FONT color="green">379</FONT> } catch ( Exception e ) {<a name="line.379"></a>
<FONT color="green">380</FONT> e.printStackTrace();<a name="line.380"></a>
<FONT color="green">381</FONT> }<a name="line.381"></a>
<FONT color="green">382</FONT> return null;<a name="line.382"></a>
<FONT color="green">383</FONT> }<a name="line.383"></a>
<FONT color="green">384</FONT> <a name="line.384"></a>
<FONT color="green">385</FONT> <a name="line.385"></a>
<FONT color="green">386</FONT> <a name="line.386"></a>
<FONT color="green">387</FONT> <a name="line.387"></a>
<FONT color="green">388</FONT> }<a name="line.388"></a>
</PRE>
</BODY>
</HTML>