blob: 553cca98236a027f56d75e143c3282c099674324 [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: XPathExpressionImpl.java 1225426 2011-12-29 04:13:08Z mrglavas $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> package org.apache.xpath.domapi;<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.xpath.XPath;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xpath.XPathContext;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xpath.objects.XObject;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xpath.res.XPATHErrorResources;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.xpath.res.XPATHMessages;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.w3c.dom.DOMException;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.w3c.dom.Document;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.w3c.dom.Node;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.w3c.dom.xpath.XPathException;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.w3c.dom.xpath.XPathExpression;<a name="line.36"></a>
<FONT color="green">037</FONT> import org.w3c.dom.xpath.XPathNamespace;<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> * <a name="line.40"></a>
<FONT color="green">041</FONT> * The class provides an implementation of XPathExpression according <a name="line.41"></a>
<FONT color="green">042</FONT> * to the DOM L3 XPath Specification, Working Group Note 26 February 2004.<a name="line.42"></a>
<FONT color="green">043</FONT> *<a name="line.43"></a>
<FONT color="green">044</FONT> * &lt;p&gt;See also the &lt;a href='http://www.w3.org/TR/2004/NOTE-DOM-Level-3-XPath-20040226'&gt;Document Object Model (DOM) Level 3 XPath Specification&lt;/a&gt;.&lt;/p&gt;<a name="line.44"></a>
<FONT color="green">045</FONT> *<a name="line.45"></a>
<FONT color="green">046</FONT> * &lt;p&gt;The &lt;code&gt;XPathExpression&lt;/code&gt; interface represents a parsed and resolved <a name="line.46"></a>
<FONT color="green">047</FONT> * XPath expression.&lt;/p&gt;<a name="line.47"></a>
<FONT color="green">048</FONT> * <a name="line.48"></a>
<FONT color="green">049</FONT> * @see org.w3c.dom.xpath.XPathExpression<a name="line.49"></a>
<FONT color="green">050</FONT> * <a name="line.50"></a>
<FONT color="green">051</FONT> * @xsl.usage internal<a name="line.51"></a>
<FONT color="green">052</FONT> */<a name="line.52"></a>
<FONT color="green">053</FONT> class XPathExpressionImpl implements XPathExpression {<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> /**<a name="line.55"></a>
<FONT color="green">056</FONT> * The xpath object that this expression wraps<a name="line.56"></a>
<FONT color="green">057</FONT> */<a name="line.57"></a>
<FONT color="green">058</FONT> final private XPath m_xpath;<a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> /**<a name="line.60"></a>
<FONT color="green">061</FONT> * The document to be searched to parallel the case where the XPathEvaluator<a name="line.61"></a>
<FONT color="green">062</FONT> * is obtained by casting a Document.<a name="line.62"></a>
<FONT color="green">063</FONT> */ <a name="line.63"></a>
<FONT color="green">064</FONT> final private Document m_doc; <a name="line.64"></a>
<FONT color="green">065</FONT> <a name="line.65"></a>
<FONT color="green">066</FONT> /**<a name="line.66"></a>
<FONT color="green">067</FONT> * Constructor for XPathExpressionImpl.<a name="line.67"></a>
<FONT color="green">068</FONT> * <a name="line.68"></a>
<FONT color="green">069</FONT> * @param xpath The wrapped XPath object.<a name="line.69"></a>
<FONT color="green">070</FONT> * @param doc The document to be searched, to parallel the case where''<a name="line.70"></a>
<FONT color="green">071</FONT> * the XPathEvaluator is obtained by casting the document.<a name="line.71"></a>
<FONT color="green">072</FONT> */<a name="line.72"></a>
<FONT color="green">073</FONT> XPathExpressionImpl(XPath xpath, Document doc) {<a name="line.73"></a>
<FONT color="green">074</FONT> m_xpath = xpath;<a name="line.74"></a>
<FONT color="green">075</FONT> m_doc = doc;<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> /**<a name="line.78"></a>
<FONT color="green">079</FONT> *<a name="line.79"></a>
<FONT color="green">080</FONT> * This method provides an implementation XPathResult.evaluate according <a name="line.80"></a>
<FONT color="green">081</FONT> * to the DOM L3 XPath Specification, Working Group Note 26 February 2004.<a name="line.81"></a>
<FONT color="green">082</FONT> *<a name="line.82"></a>
<FONT color="green">083</FONT> * &lt;p&gt;See also the &lt;a href='http://www.w3.org/TR/2004/NOTE-DOM-Level-3-XPath-20040226'&gt;Document Object Model (DOM) Level 3 XPath Specification&lt;/a&gt;.&lt;/p&gt;<a name="line.83"></a>
<FONT color="green">084</FONT> * <a name="line.84"></a>
<FONT color="green">085</FONT> * &lt;p&gt;Evaluates this XPath expression and returns a result.&lt;/p&gt;<a name="line.85"></a>
<FONT color="green">086</FONT> * @param contextNode The &lt;code&gt;context&lt;/code&gt; is context node for the <a name="line.86"></a>
<FONT color="green">087</FONT> * evaluation of this XPath expression.If the XPathEvaluator was <a name="line.87"></a>
<FONT color="green">088</FONT> * obtained by casting the &lt;code&gt;Document&lt;/code&gt; then this must be <a name="line.88"></a>
<FONT color="green">089</FONT> * owned by the same document and must be a &lt;code&gt;Document&lt;/code&gt;, <a name="line.89"></a>
<FONT color="green">090</FONT> * &lt;code&gt;Element&lt;/code&gt;, &lt;code&gt;Attribute&lt;/code&gt;, &lt;code&gt;Text&lt;/code&gt;, <a name="line.90"></a>
<FONT color="green">091</FONT> * &lt;code&gt;CDATASection&lt;/code&gt;, &lt;code&gt;Comment&lt;/code&gt;, <a name="line.91"></a>
<FONT color="green">092</FONT> * &lt;code&gt;ProcessingInstruction&lt;/code&gt;, or &lt;code&gt;XPathNamespace&lt;/code&gt; <a name="line.92"></a>
<FONT color="green">093</FONT> * node.If the context node is a &lt;code&gt;Text&lt;/code&gt; or a <a name="line.93"></a>
<FONT color="green">094</FONT> * &lt;code&gt;CDATASection&lt;/code&gt;, then the context is interpreted as the <a name="line.94"></a>
<FONT color="green">095</FONT> * whole logical text node as seen by XPath, unless the node is empty <a name="line.95"></a>
<FONT color="green">096</FONT> * in which case it may not serve as the XPath context.<a name="line.96"></a>
<FONT color="green">097</FONT> * @param type If a specific &lt;code&gt;type&lt;/code&gt; is specified, then the <a name="line.97"></a>
<FONT color="green">098</FONT> * result will be coerced to return the specified type relying on <a name="line.98"></a>
<FONT color="green">099</FONT> * XPath conversions and fail if the desired coercion is not possible. <a name="line.99"></a>
<FONT color="green">100</FONT> * This must be one of the type codes of &lt;code&gt;XPathResult&lt;/code&gt;.<a name="line.100"></a>
<FONT color="green">101</FONT> * @param result The &lt;code&gt;result&lt;/code&gt; specifies a specific result <a name="line.101"></a>
<FONT color="green">102</FONT> * object which may be reused and returned by this method. If this is <a name="line.102"></a>
<FONT color="green">103</FONT> * specified as &lt;code&gt;null&lt;/code&gt;or the implementation does not reuse <a name="line.103"></a>
<FONT color="green">104</FONT> * the specified result, a new result object will be constructed and <a name="line.104"></a>
<FONT color="green">105</FONT> * returned.For XPath 1.0 results, this object will be of type <a name="line.105"></a>
<FONT color="green">106</FONT> * &lt;code&gt;XPathResult&lt;/code&gt;.<a name="line.106"></a>
<FONT color="green">107</FONT> * @return The result of the evaluation of the XPath expression.For XPath <a name="line.107"></a>
<FONT color="green">108</FONT> * 1.0 results, this object will be of type &lt;code&gt;XPathResult&lt;/code&gt;.<a name="line.108"></a>
<FONT color="green">109</FONT> * @exception XPathException<a name="line.109"></a>
<FONT color="green">110</FONT> * TYPE_ERR: Raised if the result cannot be converted to return the <a name="line.110"></a>
<FONT color="green">111</FONT> * specified type.<a name="line.111"></a>
<FONT color="green">112</FONT> * @exception DOMException<a name="line.112"></a>
<FONT color="green">113</FONT> * WRONG_DOCUMENT_ERR: The Node is from a document that is not supported <a name="line.113"></a>
<FONT color="green">114</FONT> * by the XPathEvaluator that created this <a name="line.114"></a>
<FONT color="green">115</FONT> * &lt;code&gt;XPathExpression&lt;/code&gt;.<a name="line.115"></a>
<FONT color="green">116</FONT> * &lt;br&gt;NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath <a name="line.116"></a>
<FONT color="green">117</FONT> * context node. <a name="line.117"></a>
<FONT color="green">118</FONT> * <a name="line.118"></a>
<FONT color="green">119</FONT> * @see org.w3c.dom.xpath.XPathExpression#evaluate(Node, short, XPathResult)<a name="line.119"></a>
<FONT color="green">120</FONT> * @xsl.usage internal<a name="line.120"></a>
<FONT color="green">121</FONT> */<a name="line.121"></a>
<FONT color="green">122</FONT> public Object evaluate(<a name="line.122"></a>
<FONT color="green">123</FONT> Node contextNode,<a name="line.123"></a>
<FONT color="green">124</FONT> short type,<a name="line.124"></a>
<FONT color="green">125</FONT> Object result)<a name="line.125"></a>
<FONT color="green">126</FONT> throws XPathException, DOMException {<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> // If the XPathEvaluator was determined by "casting" the document <a name="line.128"></a>
<FONT color="green">129</FONT> if (m_doc != null) {<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> // Check that the context node is owned by the same document<a name="line.131"></a>
<FONT color="green">132</FONT> if ((contextNode != m_doc) &amp;&amp; (!contextNode.getOwnerDocument().equals(m_doc))) {<a name="line.132"></a>
<FONT color="green">133</FONT> String fmsg = XPATHMessages.createXPATHMessage(XPATHErrorResources.ER_WRONG_DOCUMENT, null); <a name="line.133"></a>
<FONT color="green">134</FONT> throw new DOMException(DOMException.WRONG_DOCUMENT_ERR, fmsg);<a name="line.134"></a>
<FONT color="green">135</FONT> }<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> // Check that the context node is an acceptable node type<a name="line.137"></a>
<FONT color="green">138</FONT> short nodeType = contextNode.getNodeType();<a name="line.138"></a>
<FONT color="green">139</FONT> if ((nodeType != Document.DOCUMENT_NODE) &amp;&amp;<a name="line.139"></a>
<FONT color="green">140</FONT> (nodeType != Document.ELEMENT_NODE) &amp;&amp; <a name="line.140"></a>
<FONT color="green">141</FONT> (nodeType != Document.ATTRIBUTE_NODE) &amp;&amp;<a name="line.141"></a>
<FONT color="green">142</FONT> (nodeType != Document.TEXT_NODE) &amp;&amp;<a name="line.142"></a>
<FONT color="green">143</FONT> (nodeType != Document.CDATA_SECTION_NODE) &amp;&amp;<a name="line.143"></a>
<FONT color="green">144</FONT> (nodeType != Document.COMMENT_NODE) &amp;&amp;<a name="line.144"></a>
<FONT color="green">145</FONT> (nodeType != Document.PROCESSING_INSTRUCTION_NODE) &amp;&amp;<a name="line.145"></a>
<FONT color="green">146</FONT> (nodeType != XPathNamespace.XPATH_NAMESPACE_NODE)) {<a name="line.146"></a>
<FONT color="green">147</FONT> String fmsg = XPATHMessages.createXPATHMessage(XPATHErrorResources.ER_WRONG_NODETYPE, null); <a name="line.147"></a>
<FONT color="green">148</FONT> throw new DOMException(DOMException.NOT_SUPPORTED_ERR, fmsg);<a name="line.148"></a>
<FONT color="green">149</FONT> }<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> // If the type is not a supported type, throw an exception and be<a name="line.153"></a>
<FONT color="green">154</FONT> // done with it!<a name="line.154"></a>
<FONT color="green">155</FONT> if (!XPathResultImpl.isValidType(type)) {<a name="line.155"></a>
<FONT color="green">156</FONT> String fmsg = XPATHMessages.createXPATHMessage(XPATHErrorResources.ER_INVALID_XPATH_TYPE, new Object[] {new Integer(type)}); <a name="line.156"></a>
<FONT color="green">157</FONT> throw new XPathException(XPathException.TYPE_ERR,fmsg); // Invalid XPath type argument: {0} <a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> <a name="line.159"></a>
<FONT color="green">160</FONT> // Create an XPathContext that doesn't support pushing and popping of<a name="line.160"></a>
<FONT color="green">161</FONT> // variable resolution scopes. Sufficient for simple XPath 1.0<a name="line.161"></a>
<FONT color="green">162</FONT> // expressions.<a name="line.162"></a>
<FONT color="green">163</FONT> // Cache xpath context?<a name="line.163"></a>
<FONT color="green">164</FONT> XPathContext xpathSupport = new XPathContext(false);<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> // if m_document is not null, build the DTM from the document <a name="line.166"></a>
<FONT color="green">167</FONT> if (null != m_doc) {<a name="line.167"></a>
<FONT color="green">168</FONT> xpathSupport.getDTMHandleFromNode(m_doc);<a name="line.168"></a>
<FONT color="green">169</FONT> }<a name="line.169"></a>
<FONT color="green">170</FONT> <a name="line.170"></a>
<FONT color="green">171</FONT> XObject xobj = null;<a name="line.171"></a>
<FONT color="green">172</FONT> try {<a name="line.172"></a>
<FONT color="green">173</FONT> xobj = m_xpath.execute(xpathSupport, contextNode, null); <a name="line.173"></a>
<FONT color="green">174</FONT> } catch (TransformerException te) {<a name="line.174"></a>
<FONT color="green">175</FONT> // What should we do here?<a name="line.175"></a>
<FONT color="green">176</FONT> throw new XPathException(XPathException.INVALID_EXPRESSION_ERR,te.getMessageAndLocation()); <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> // Create a new XPathResult object<a name="line.179"></a>
<FONT color="green">180</FONT> // Reuse result object passed in?<a name="line.180"></a>
<FONT color="green">181</FONT> // The constructor will check the compatibility of type and xobj and<a name="line.181"></a>
<FONT color="green">182</FONT> // throw an exception if they are not compatible.<a name="line.182"></a>
<FONT color="green">183</FONT> return new XPathResultImpl(type,xobj,contextNode, m_xpath);<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>
</PRE>
</BODY>
</HTML>