blob: d3c98cffa45a366eb895b30db55a120fd029cb3c [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: Expression.java 468655 2006-10-28 07:12:06Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xpath;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import javax.xml.transform.ErrorListener;<a name="line.23"></a>
<FONT color="green">024</FONT> import javax.xml.transform.TransformerException;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xalan.res.XSLMessages;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xml.dtm.DTM;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xml.dtm.DTMIterator;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xml.utils.XMLString;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xpath.objects.XNodeSet;<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> <a name="line.33"></a>
<FONT color="green">034</FONT> import org.xml.sax.ContentHandler;<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * This abstract class serves as the base for all expression objects. An<a name="line.37"></a>
<FONT color="green">038</FONT> * Expression can be executed to return a {@link org.apache.xpath.objects.XObject},<a name="line.38"></a>
<FONT color="green">039</FONT> * normally has a location within a document or DOM, can send error and warning<a name="line.39"></a>
<FONT color="green">040</FONT> * events, and normally do not hold state and are meant to be immutable once<a name="line.40"></a>
<FONT color="green">041</FONT> * construction has completed. An exception to the immutibility rule is iterators<a name="line.41"></a>
<FONT color="green">042</FONT> * and walkers, which must be cloned in order to be used -- the original must<a name="line.42"></a>
<FONT color="green">043</FONT> * still be immutable.<a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> public abstract class Expression implements java.io.Serializable, ExpressionNode, XPathVisitable<a name="line.45"></a>
<FONT color="green">046</FONT> {<a name="line.46"></a>
<FONT color="green">047</FONT> static final long serialVersionUID = 565665869777906902L;<a name="line.47"></a>
<FONT color="green">048</FONT> /**<a name="line.48"></a>
<FONT color="green">049</FONT> * The location where this expression was built from. Need for diagnostic<a name="line.49"></a>
<FONT color="green">050</FONT> * messages. May be null.<a name="line.50"></a>
<FONT color="green">051</FONT> * @serial<a name="line.51"></a>
<FONT color="green">052</FONT> */<a name="line.52"></a>
<FONT color="green">053</FONT> private ExpressionNode m_parent;<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> * Tell if this expression or it's subexpressions can traverse outside<a name="line.56"></a>
<FONT color="green">057</FONT> * the current subtree.<a name="line.57"></a>
<FONT color="green">058</FONT> *<a name="line.58"></a>
<FONT color="green">059</FONT> * @return true if traversal outside the context node's subtree can occur.<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public boolean canTraverseOutsideSubtree()<a name="line.61"></a>
<FONT color="green">062</FONT> {<a name="line.62"></a>
<FONT color="green">063</FONT> return false;<a name="line.63"></a>
<FONT color="green">064</FONT> }<a name="line.64"></a>
<FONT color="green">065</FONT> <a name="line.65"></a>
<FONT color="green">066</FONT> // /**<a name="line.66"></a>
<FONT color="green">067</FONT> // * Set the location where this expression was built from.<a name="line.67"></a>
<FONT color="green">068</FONT> // *<a name="line.68"></a>
<FONT color="green">069</FONT> // *<a name="line.69"></a>
<FONT color="green">070</FONT> // * @param locator the location where this expression was built from, may be<a name="line.70"></a>
<FONT color="green">071</FONT> // * null.<a name="line.71"></a>
<FONT color="green">072</FONT> // */<a name="line.72"></a>
<FONT color="green">073</FONT> // public void setSourceLocator(SourceLocator locator)<a name="line.73"></a>
<FONT color="green">074</FONT> // {<a name="line.74"></a>
<FONT color="green">075</FONT> // m_slocator = locator;<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> * Execute an expression in the XPath runtime context, and return the<a name="line.79"></a>
<FONT color="green">080</FONT> * result of the expression.<a name="line.80"></a>
<FONT color="green">081</FONT> *<a name="line.81"></a>
<FONT color="green">082</FONT> *<a name="line.82"></a>
<FONT color="green">083</FONT> * @param xctxt The XPath runtime context.<a name="line.83"></a>
<FONT color="green">084</FONT> * @param currentNode The currentNode.<a name="line.84"></a>
<FONT color="green">085</FONT> *<a name="line.85"></a>
<FONT color="green">086</FONT> * @return The result of the expression in the form of a &lt;code&gt;XObject&lt;/code&gt;.<a name="line.86"></a>
<FONT color="green">087</FONT> *<a name="line.87"></a>
<FONT color="green">088</FONT> * @throws javax.xml.transform.TransformerException if a runtime exception<a name="line.88"></a>
<FONT color="green">089</FONT> * occurs.<a name="line.89"></a>
<FONT color="green">090</FONT> */<a name="line.90"></a>
<FONT color="green">091</FONT> public XObject execute(XPathContext xctxt, int currentNode)<a name="line.91"></a>
<FONT color="green">092</FONT> throws javax.xml.transform.TransformerException<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> // For now, the current node is already pushed.<a name="line.95"></a>
<FONT color="green">096</FONT> return execute(xctxt);<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> /**<a name="line.99"></a>
<FONT color="green">100</FONT> * Execute an expression in the XPath runtime context, and return the<a name="line.100"></a>
<FONT color="green">101</FONT> * result of the expression.<a name="line.101"></a>
<FONT color="green">102</FONT> *<a name="line.102"></a>
<FONT color="green">103</FONT> *<a name="line.103"></a>
<FONT color="green">104</FONT> * @param xctxt The XPath runtime context.<a name="line.104"></a>
<FONT color="green">105</FONT> * @param currentNode The currentNode.<a name="line.105"></a>
<FONT color="green">106</FONT> * @param dtm The DTM of the current node.<a name="line.106"></a>
<FONT color="green">107</FONT> * @param expType The expanded type ID of the current node.<a name="line.107"></a>
<FONT color="green">108</FONT> *<a name="line.108"></a>
<FONT color="green">109</FONT> * @return The result of the expression in the form of a &lt;code&gt;XObject&lt;/code&gt;.<a name="line.109"></a>
<FONT color="green">110</FONT> *<a name="line.110"></a>
<FONT color="green">111</FONT> * @throws javax.xml.transform.TransformerException if a runtime exception<a name="line.111"></a>
<FONT color="green">112</FONT> * occurs.<a name="line.112"></a>
<FONT color="green">113</FONT> */<a name="line.113"></a>
<FONT color="green">114</FONT> public XObject execute(<a name="line.114"></a>
<FONT color="green">115</FONT> XPathContext xctxt, int currentNode, DTM dtm, int expType)<a name="line.115"></a>
<FONT color="green">116</FONT> throws javax.xml.transform.TransformerException<a name="line.116"></a>
<FONT color="green">117</FONT> {<a name="line.117"></a>
<FONT color="green">118</FONT> <a name="line.118"></a>
<FONT color="green">119</FONT> // For now, the current node is already pushed.<a name="line.119"></a>
<FONT color="green">120</FONT> return execute(xctxt);<a name="line.120"></a>
<FONT color="green">121</FONT> }<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> /**<a name="line.123"></a>
<FONT color="green">124</FONT> * Execute an expression in the XPath runtime context, and return the<a name="line.124"></a>
<FONT color="green">125</FONT> * result of the expression.<a name="line.125"></a>
<FONT color="green">126</FONT> *<a name="line.126"></a>
<FONT color="green">127</FONT> *<a name="line.127"></a>
<FONT color="green">128</FONT> * @param xctxt The XPath runtime context.<a name="line.128"></a>
<FONT color="green">129</FONT> *<a name="line.129"></a>
<FONT color="green">130</FONT> * @return The result of the expression in the form of a &lt;code&gt;XObject&lt;/code&gt;.<a name="line.130"></a>
<FONT color="green">131</FONT> *<a name="line.131"></a>
<FONT color="green">132</FONT> * @throws javax.xml.transform.TransformerException if a runtime exception<a name="line.132"></a>
<FONT color="green">133</FONT> * occurs.<a name="line.133"></a>
<FONT color="green">134</FONT> */<a name="line.134"></a>
<FONT color="green">135</FONT> public abstract XObject execute(XPathContext xctxt)<a name="line.135"></a>
<FONT color="green">136</FONT> throws javax.xml.transform.TransformerException;<a name="line.136"></a>
<FONT color="green">137</FONT> <a name="line.137"></a>
<FONT color="green">138</FONT> /**<a name="line.138"></a>
<FONT color="green">139</FONT> * Execute an expression in the XPath runtime context, and return the<a name="line.139"></a>
<FONT color="green">140</FONT> * result of the expression, but tell that a "safe" object doesn't have <a name="line.140"></a>
<FONT color="green">141</FONT> * to be returned. The default implementation just calls execute(xctxt).<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> * @param xctxt The XPath runtime context.<a name="line.144"></a>
<FONT color="green">145</FONT> * @param destructiveOK true if a "safe" object doesn't need to be returned.<a name="line.145"></a>
<FONT color="green">146</FONT> *<a name="line.146"></a>
<FONT color="green">147</FONT> * @return The result of the expression in the form of a &lt;code&gt;XObject&lt;/code&gt;.<a name="line.147"></a>
<FONT color="green">148</FONT> *<a name="line.148"></a>
<FONT color="green">149</FONT> * @throws javax.xml.transform.TransformerException if a runtime exception<a name="line.149"></a>
<FONT color="green">150</FONT> * occurs.<a name="line.150"></a>
<FONT color="green">151</FONT> */<a name="line.151"></a>
<FONT color="green">152</FONT> public XObject execute(XPathContext xctxt, boolean destructiveOK)<a name="line.152"></a>
<FONT color="green">153</FONT> throws javax.xml.transform.TransformerException<a name="line.153"></a>
<FONT color="green">154</FONT> {<a name="line.154"></a>
<FONT color="green">155</FONT> return execute(xctxt);<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> <a name="line.158"></a>
<FONT color="green">159</FONT> /**<a name="line.159"></a>
<FONT color="green">160</FONT> * Evaluate expression to a number.<a name="line.160"></a>
<FONT color="green">161</FONT> *<a name="line.161"></a>
<FONT color="green">162</FONT> *<a name="line.162"></a>
<FONT color="green">163</FONT> * @param xctxt The XPath runtime context.<a name="line.163"></a>
<FONT color="green">164</FONT> * @return The expression evaluated as a double.<a name="line.164"></a>
<FONT color="green">165</FONT> *<a name="line.165"></a>
<FONT color="green">166</FONT> * @throws javax.xml.transform.TransformerException<a name="line.166"></a>
<FONT color="green">167</FONT> */<a name="line.167"></a>
<FONT color="green">168</FONT> public double num(XPathContext xctxt)<a name="line.168"></a>
<FONT color="green">169</FONT> throws javax.xml.transform.TransformerException<a name="line.169"></a>
<FONT color="green">170</FONT> {<a name="line.170"></a>
<FONT color="green">171</FONT> return execute(xctxt).num();<a name="line.171"></a>
<FONT color="green">172</FONT> }<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> * Evaluate expression to a boolean.<a name="line.175"></a>
<FONT color="green">176</FONT> *<a name="line.176"></a>
<FONT color="green">177</FONT> *<a name="line.177"></a>
<FONT color="green">178</FONT> * @param xctxt The XPath runtime context.<a name="line.178"></a>
<FONT color="green">179</FONT> * @return false<a name="line.179"></a>
<FONT color="green">180</FONT> *<a name="line.180"></a>
<FONT color="green">181</FONT> * @throws javax.xml.transform.TransformerException<a name="line.181"></a>
<FONT color="green">182</FONT> */<a name="line.182"></a>
<FONT color="green">183</FONT> public boolean bool(XPathContext xctxt)<a name="line.183"></a>
<FONT color="green">184</FONT> throws javax.xml.transform.TransformerException<a name="line.184"></a>
<FONT color="green">185</FONT> {<a name="line.185"></a>
<FONT color="green">186</FONT> return execute(xctxt).bool();<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> <a name="line.188"></a>
<FONT color="green">189</FONT> /**<a name="line.189"></a>
<FONT color="green">190</FONT> * Cast result object to a string.<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> * @param xctxt The XPath runtime context.<a name="line.193"></a>
<FONT color="green">194</FONT> * @return The string this wraps or the empty string if null<a name="line.194"></a>
<FONT color="green">195</FONT> *<a name="line.195"></a>
<FONT color="green">196</FONT> * @throws javax.xml.transform.TransformerException<a name="line.196"></a>
<FONT color="green">197</FONT> */<a name="line.197"></a>
<FONT color="green">198</FONT> public XMLString xstr(XPathContext xctxt)<a name="line.198"></a>
<FONT color="green">199</FONT> throws javax.xml.transform.TransformerException<a name="line.199"></a>
<FONT color="green">200</FONT> {<a name="line.200"></a>
<FONT color="green">201</FONT> return execute(xctxt).xstr();<a name="line.201"></a>
<FONT color="green">202</FONT> }<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> * Tell if the expression is a nodeset expression. In other words, tell<a name="line.205"></a>
<FONT color="green">206</FONT> * if you can execute {@link #asNode(XPathContext) asNode} without an exception.<a name="line.206"></a>
<FONT color="green">207</FONT> * @return true if the expression can be represented as a nodeset.<a name="line.207"></a>
<FONT color="green">208</FONT> */<a name="line.208"></a>
<FONT color="green">209</FONT> public boolean isNodesetExpr()<a name="line.209"></a>
<FONT color="green">210</FONT> {<a name="line.210"></a>
<FONT color="green">211</FONT> return false;<a name="line.211"></a>
<FONT color="green">212</FONT> }<a name="line.212"></a>
<FONT color="green">213</FONT> <a name="line.213"></a>
<FONT color="green">214</FONT> /**<a name="line.214"></a>
<FONT color="green">215</FONT> * Return the first node out of the nodeset, if this expression is<a name="line.215"></a>
<FONT color="green">216</FONT> * a nodeset expression.<a name="line.216"></a>
<FONT color="green">217</FONT> * @param xctxt The XPath runtime context.<a name="line.217"></a>
<FONT color="green">218</FONT> * @return the first node out of the nodeset, or DTM.NULL.<a name="line.218"></a>
<FONT color="green">219</FONT> *<a name="line.219"></a>
<FONT color="green">220</FONT> * @throws javax.xml.transform.TransformerException<a name="line.220"></a>
<FONT color="green">221</FONT> */<a name="line.221"></a>
<FONT color="green">222</FONT> public int asNode(XPathContext xctxt)<a name="line.222"></a>
<FONT color="green">223</FONT> throws javax.xml.transform.TransformerException<a name="line.223"></a>
<FONT color="green">224</FONT> {<a name="line.224"></a>
<FONT color="green">225</FONT> DTMIterator iter = execute(xctxt).iter();<a name="line.225"></a>
<FONT color="green">226</FONT> return iter.nextNode();<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> /**<a name="line.229"></a>
<FONT color="green">230</FONT> * Given an select expression and a context, evaluate the XPath<a name="line.230"></a>
<FONT color="green">231</FONT> * and return the resulting iterator.<a name="line.231"></a>
<FONT color="green">232</FONT> *<a name="line.232"></a>
<FONT color="green">233</FONT> * @param xctxt The execution context.<a name="line.233"></a>
<FONT color="green">234</FONT> * @param contextNode The node that "." expresses.<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> * @return A valid DTMIterator.<a name="line.237"></a>
<FONT color="green">238</FONT> * @throws TransformerException thrown if the active ProblemListener decides<a name="line.238"></a>
<FONT color="green">239</FONT> * the error condition is severe enough to halt processing.<a name="line.239"></a>
<FONT color="green">240</FONT> *<a name="line.240"></a>
<FONT color="green">241</FONT> * @throws javax.xml.transform.TransformerException<a name="line.241"></a>
<FONT color="green">242</FONT> * @xsl.usage experimental<a name="line.242"></a>
<FONT color="green">243</FONT> */<a name="line.243"></a>
<FONT color="green">244</FONT> public DTMIterator asIterator(XPathContext xctxt, int contextNode)<a name="line.244"></a>
<FONT color="green">245</FONT> throws javax.xml.transform.TransformerException<a name="line.245"></a>
<FONT color="green">246</FONT> {<a name="line.246"></a>
<FONT color="green">247</FONT> <a name="line.247"></a>
<FONT color="green">248</FONT> try<a name="line.248"></a>
<FONT color="green">249</FONT> {<a name="line.249"></a>
<FONT color="green">250</FONT> xctxt.pushCurrentNodeAndExpression(contextNode, contextNode);<a name="line.250"></a>
<FONT color="green">251</FONT> <a name="line.251"></a>
<FONT color="green">252</FONT> return execute(xctxt).iter();<a name="line.252"></a>
<FONT color="green">253</FONT> }<a name="line.253"></a>
<FONT color="green">254</FONT> finally<a name="line.254"></a>
<FONT color="green">255</FONT> {<a name="line.255"></a>
<FONT color="green">256</FONT> xctxt.popCurrentNodeAndExpression();<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>
<FONT color="green">261</FONT> * Given an select expression and a context, evaluate the XPath<a name="line.261"></a>
<FONT color="green">262</FONT> * and return the resulting iterator, but do not clone.<a name="line.262"></a>
<FONT color="green">263</FONT> *<a name="line.263"></a>
<FONT color="green">264</FONT> * @param xctxt The execution context.<a name="line.264"></a>
<FONT color="green">265</FONT> * @param contextNode The node that "." expresses.<a name="line.265"></a>
<FONT color="green">266</FONT> *<a name="line.266"></a>
<FONT color="green">267</FONT> *<a name="line.267"></a>
<FONT color="green">268</FONT> * @return A valid DTMIterator.<a name="line.268"></a>
<FONT color="green">269</FONT> * @throws TransformerException thrown if the active ProblemListener decides<a name="line.269"></a>
<FONT color="green">270</FONT> * the error condition is severe enough to halt processing.<a name="line.270"></a>
<FONT color="green">271</FONT> *<a name="line.271"></a>
<FONT color="green">272</FONT> * @throws javax.xml.transform.TransformerException<a name="line.272"></a>
<FONT color="green">273</FONT> * @xsl.usage experimental<a name="line.273"></a>
<FONT color="green">274</FONT> */<a name="line.274"></a>
<FONT color="green">275</FONT> public DTMIterator asIteratorRaw(XPathContext xctxt, int contextNode)<a name="line.275"></a>
<FONT color="green">276</FONT> throws javax.xml.transform.TransformerException<a name="line.276"></a>
<FONT color="green">277</FONT> {<a name="line.277"></a>
<FONT color="green">278</FONT> <a name="line.278"></a>
<FONT color="green">279</FONT> try<a name="line.279"></a>
<FONT color="green">280</FONT> {<a name="line.280"></a>
<FONT color="green">281</FONT> xctxt.pushCurrentNodeAndExpression(contextNode, contextNode);<a name="line.281"></a>
<FONT color="green">282</FONT> <a name="line.282"></a>
<FONT color="green">283</FONT> XNodeSet nodeset = (XNodeSet)execute(xctxt);<a name="line.283"></a>
<FONT color="green">284</FONT> return nodeset.iterRaw();<a name="line.284"></a>
<FONT color="green">285</FONT> }<a name="line.285"></a>
<FONT color="green">286</FONT> finally<a name="line.286"></a>
<FONT color="green">287</FONT> {<a name="line.287"></a>
<FONT color="green">288</FONT> xctxt.popCurrentNodeAndExpression();<a name="line.288"></a>
<FONT color="green">289</FONT> }<a name="line.289"></a>
<FONT color="green">290</FONT> }<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> * Execute an expression in the XPath runtime context, and return the<a name="line.294"></a>
<FONT color="green">295</FONT> * result of the expression.<a name="line.295"></a>
<FONT color="green">296</FONT> *<a name="line.296"></a>
<FONT color="green">297</FONT> *<a name="line.297"></a>
<FONT color="green">298</FONT> * @param xctxt The XPath runtime context.<a name="line.298"></a>
<FONT color="green">299</FONT> * NEEDSDOC @param handler<a name="line.299"></a>
<FONT color="green">300</FONT> *<a name="line.300"></a>
<FONT color="green">301</FONT> * @return The result of the expression in the form of a &lt;code&gt;XObject&lt;/code&gt;.<a name="line.301"></a>
<FONT color="green">302</FONT> *<a name="line.302"></a>
<FONT color="green">303</FONT> * @throws javax.xml.transform.TransformerException if a runtime exception<a name="line.303"></a>
<FONT color="green">304</FONT> * occurs.<a name="line.304"></a>
<FONT color="green">305</FONT> * @throws org.xml.sax.SAXException<a name="line.305"></a>
<FONT color="green">306</FONT> */<a name="line.306"></a>
<FONT color="green">307</FONT> public void executeCharsToContentHandler(<a name="line.307"></a>
<FONT color="green">308</FONT> XPathContext xctxt, ContentHandler handler)<a name="line.308"></a>
<FONT color="green">309</FONT> throws javax.xml.transform.TransformerException,<a name="line.309"></a>
<FONT color="green">310</FONT> org.xml.sax.SAXException<a name="line.310"></a>
<FONT color="green">311</FONT> {<a name="line.311"></a>
<FONT color="green">312</FONT> <a name="line.312"></a>
<FONT color="green">313</FONT> XObject obj = execute(xctxt);<a name="line.313"></a>
<FONT color="green">314</FONT> <a name="line.314"></a>
<FONT color="green">315</FONT> obj.dispatchCharactersEvents(handler);<a name="line.315"></a>
<FONT color="green">316</FONT> obj.detach();<a name="line.316"></a>
<FONT color="green">317</FONT> }<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> * Tell if this expression returns a stable number that will not change during <a name="line.320"></a>
<FONT color="green">321</FONT> * iterations within the expression. This is used to determine if a proximity <a name="line.321"></a>
<FONT color="green">322</FONT> * position predicate can indicate that no more searching has to occur.<a name="line.322"></a>
<FONT color="green">323</FONT> * <a name="line.323"></a>
<FONT color="green">324</FONT> *<a name="line.324"></a>
<FONT color="green">325</FONT> * @return true if the expression represents a stable number.<a name="line.325"></a>
<FONT color="green">326</FONT> */<a name="line.326"></a>
<FONT color="green">327</FONT> public boolean isStableNumber()<a name="line.327"></a>
<FONT color="green">328</FONT> {<a name="line.328"></a>
<FONT color="green">329</FONT> return false;<a name="line.329"></a>
<FONT color="green">330</FONT> }<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> * This function is used to fixup variables from QNames to stack frame<a name="line.333"></a>
<FONT color="green">334</FONT> * indexes at stylesheet build time.<a name="line.334"></a>
<FONT color="green">335</FONT> * @param vars List of QNames that correspond to variables. This list<a name="line.335"></a>
<FONT color="green">336</FONT> * should be searched backwards for the first qualified name that<a name="line.336"></a>
<FONT color="green">337</FONT> * corresponds to the variable reference qname. The position of the<a name="line.337"></a>
<FONT color="green">338</FONT> * QName in the vector from the start of the vector will be its position<a name="line.338"></a>
<FONT color="green">339</FONT> * in the stack frame (but variables above the globalsTop value will need<a name="line.339"></a>
<FONT color="green">340</FONT> * to be offset to the current stack frame).<a name="line.340"></a>
<FONT color="green">341</FONT> * NEEDSDOC @param globalsSize<a name="line.341"></a>
<FONT color="green">342</FONT> */<a name="line.342"></a>
<FONT color="green">343</FONT> public abstract void fixupVariables(java.util.Vector vars, int globalsSize);<a name="line.343"></a>
<FONT color="green">344</FONT> <a name="line.344"></a>
<FONT color="green">345</FONT> /**<a name="line.345"></a>
<FONT color="green">346</FONT> * Compare this object with another object and see <a name="line.346"></a>
<FONT color="green">347</FONT> * if they are equal, include the sub heararchy.<a name="line.347"></a>
<FONT color="green">348</FONT> * <a name="line.348"></a>
<FONT color="green">349</FONT> * @param expr Another expression object.<a name="line.349"></a>
<FONT color="green">350</FONT> * @return true if this objects class and the expr<a name="line.350"></a>
<FONT color="green">351</FONT> * object's class are the same, and the data contained <a name="line.351"></a>
<FONT color="green">352</FONT> * within both objects are considered equal.<a name="line.352"></a>
<FONT color="green">353</FONT> */<a name="line.353"></a>
<FONT color="green">354</FONT> public abstract boolean deepEquals(Expression expr);<a name="line.354"></a>
<FONT color="green">355</FONT> <a name="line.355"></a>
<FONT color="green">356</FONT> /**<a name="line.356"></a>
<FONT color="green">357</FONT> * This is a utility method to tell if the passed in <a name="line.357"></a>
<FONT color="green">358</FONT> * class is the same class as this. It is to be used by<a name="line.358"></a>
<FONT color="green">359</FONT> * the deepEquals method. I'm bottlenecking it here <a name="line.359"></a>
<FONT color="green">360</FONT> * because I'm not totally confident that comparing the <a name="line.360"></a>
<FONT color="green">361</FONT> * class objects is the best way to do this.<a name="line.361"></a>
<FONT color="green">362</FONT> * @return true of the passed in class is the exact same <a name="line.362"></a>
<FONT color="green">363</FONT> * class as this class.<a name="line.363"></a>
<FONT color="green">364</FONT> */<a name="line.364"></a>
<FONT color="green">365</FONT> protected final boolean isSameClass(Expression expr)<a name="line.365"></a>
<FONT color="green">366</FONT> {<a name="line.366"></a>
<FONT color="green">367</FONT> if(null == expr)<a name="line.367"></a>
<FONT color="green">368</FONT> return false;<a name="line.368"></a>
<FONT color="green">369</FONT> <a name="line.369"></a>
<FONT color="green">370</FONT> return (getClass() == expr.getClass());<a name="line.370"></a>
<FONT color="green">371</FONT> }<a name="line.371"></a>
<FONT color="green">372</FONT> <a name="line.372"></a>
<FONT color="green">373</FONT> /**<a name="line.373"></a>
<FONT color="green">374</FONT> * Warn the user of an problem.<a name="line.374"></a>
<FONT color="green">375</FONT> *<a name="line.375"></a>
<FONT color="green">376</FONT> * @param xctxt The XPath runtime context.<a name="line.376"></a>
<FONT color="green">377</FONT> * @param msg An error msgkey that corresponds to one of the conststants found<a name="line.377"></a>
<FONT color="green">378</FONT> * in {@link org.apache.xpath.res.XPATHErrorResources}, which is<a name="line.378"></a>
<FONT color="green">379</FONT> * a key for a format string.<a name="line.379"></a>
<FONT color="green">380</FONT> * @param args An array of arguments represented in the format string, which<a name="line.380"></a>
<FONT color="green">381</FONT> * may be null.<a name="line.381"></a>
<FONT color="green">382</FONT> *<a name="line.382"></a>
<FONT color="green">383</FONT> * @throws TransformerException if the current ErrorListoner determines to<a name="line.383"></a>
<FONT color="green">384</FONT> * throw an exception.<a name="line.384"></a>
<FONT color="green">385</FONT> *<a name="line.385"></a>
<FONT color="green">386</FONT> * @throws javax.xml.transform.TransformerException<a name="line.386"></a>
<FONT color="green">387</FONT> */<a name="line.387"></a>
<FONT color="green">388</FONT> public void warn(XPathContext xctxt, String msg, Object[] args)<a name="line.388"></a>
<FONT color="green">389</FONT> throws javax.xml.transform.TransformerException<a name="line.389"></a>
<FONT color="green">390</FONT> {<a name="line.390"></a>
<FONT color="green">391</FONT> <a name="line.391"></a>
<FONT color="green">392</FONT> java.lang.String fmsg = XSLMessages.createXPATHWarning(msg, args);<a name="line.392"></a>
<FONT color="green">393</FONT> <a name="line.393"></a>
<FONT color="green">394</FONT> if (null != xctxt)<a name="line.394"></a>
<FONT color="green">395</FONT> {<a name="line.395"></a>
<FONT color="green">396</FONT> ErrorListener eh = xctxt.getErrorListener();<a name="line.396"></a>
<FONT color="green">397</FONT> <a name="line.397"></a>
<FONT color="green">398</FONT> // TO DO: Need to get stylesheet Locator from here.<a name="line.398"></a>
<FONT color="green">399</FONT> eh.warning(new TransformerException(fmsg, xctxt.getSAXLocator()));<a name="line.399"></a>
<FONT color="green">400</FONT> }<a name="line.400"></a>
<FONT color="green">401</FONT> }<a name="line.401"></a>
<FONT color="green">402</FONT> <a name="line.402"></a>
<FONT color="green">403</FONT> /**<a name="line.403"></a>
<FONT color="green">404</FONT> * Tell the user of an assertion error, and probably throw an<a name="line.404"></a>
<FONT color="green">405</FONT> * exception.<a name="line.405"></a>
<FONT color="green">406</FONT> *<a name="line.406"></a>
<FONT color="green">407</FONT> * @param b If false, a runtime exception will be thrown.<a name="line.407"></a>
<FONT color="green">408</FONT> * @param msg The assertion message, which should be informative.<a name="line.408"></a>
<FONT color="green">409</FONT> *<a name="line.409"></a>
<FONT color="green">410</FONT> * @throws RuntimeException if the b argument is false.<a name="line.410"></a>
<FONT color="green">411</FONT> *<a name="line.411"></a>
<FONT color="green">412</FONT> * @throws javax.xml.transform.TransformerException<a name="line.412"></a>
<FONT color="green">413</FONT> */<a name="line.413"></a>
<FONT color="green">414</FONT> public void assertion(boolean b, java.lang.String msg)<a name="line.414"></a>
<FONT color="green">415</FONT> {<a name="line.415"></a>
<FONT color="green">416</FONT> <a name="line.416"></a>
<FONT color="green">417</FONT> if (!b)<a name="line.417"></a>
<FONT color="green">418</FONT> {<a name="line.418"></a>
<FONT color="green">419</FONT> java.lang.String fMsg = XSLMessages.createXPATHMessage(<a name="line.419"></a>
<FONT color="green">420</FONT> XPATHErrorResources.ER_INCORRECT_PROGRAMMER_ASSERTION,<a name="line.420"></a>
<FONT color="green">421</FONT> new Object[]{ msg });<a name="line.421"></a>
<FONT color="green">422</FONT> <a name="line.422"></a>
<FONT color="green">423</FONT> throw new RuntimeException(fMsg);<a name="line.423"></a>
<FONT color="green">424</FONT> }<a name="line.424"></a>
<FONT color="green">425</FONT> }<a name="line.425"></a>
<FONT color="green">426</FONT> <a name="line.426"></a>
<FONT color="green">427</FONT> /**<a name="line.427"></a>
<FONT color="green">428</FONT> * Tell the user of an error, and probably throw an<a name="line.428"></a>
<FONT color="green">429</FONT> * exception.<a name="line.429"></a>
<FONT color="green">430</FONT> *<a name="line.430"></a>
<FONT color="green">431</FONT> * @param xctxt The XPath runtime context.<a name="line.431"></a>
<FONT color="green">432</FONT> * @param msg An error msgkey that corresponds to one of the constants found<a name="line.432"></a>
<FONT color="green">433</FONT> * in {@link org.apache.xpath.res.XPATHErrorResources}, which is<a name="line.433"></a>
<FONT color="green">434</FONT> * a key for a format string.<a name="line.434"></a>
<FONT color="green">435</FONT> * @param args An array of arguments represented in the format string, which<a name="line.435"></a>
<FONT color="green">436</FONT> * may be null.<a name="line.436"></a>
<FONT color="green">437</FONT> *<a name="line.437"></a>
<FONT color="green">438</FONT> * @throws TransformerException if the current ErrorListoner determines to<a name="line.438"></a>
<FONT color="green">439</FONT> * throw an exception.<a name="line.439"></a>
<FONT color="green">440</FONT> *<a name="line.440"></a>
<FONT color="green">441</FONT> * @throws javax.xml.transform.TransformerException<a name="line.441"></a>
<FONT color="green">442</FONT> */<a name="line.442"></a>
<FONT color="green">443</FONT> public void error(XPathContext xctxt, String msg, Object[] args)<a name="line.443"></a>
<FONT color="green">444</FONT> throws javax.xml.transform.TransformerException<a name="line.444"></a>
<FONT color="green">445</FONT> {<a name="line.445"></a>
<FONT color="green">446</FONT> <a name="line.446"></a>
<FONT color="green">447</FONT> java.lang.String fmsg = XSLMessages.createXPATHMessage(msg, args);<a name="line.447"></a>
<FONT color="green">448</FONT> <a name="line.448"></a>
<FONT color="green">449</FONT> if (null != xctxt)<a name="line.449"></a>
<FONT color="green">450</FONT> {<a name="line.450"></a>
<FONT color="green">451</FONT> ErrorListener eh = xctxt.getErrorListener();<a name="line.451"></a>
<FONT color="green">452</FONT> TransformerException te = new TransformerException(fmsg, this);<a name="line.452"></a>
<FONT color="green">453</FONT> <a name="line.453"></a>
<FONT color="green">454</FONT> eh.fatalError(te);<a name="line.454"></a>
<FONT color="green">455</FONT> }<a name="line.455"></a>
<FONT color="green">456</FONT> }<a name="line.456"></a>
<FONT color="green">457</FONT> <a name="line.457"></a>
<FONT color="green">458</FONT> /**<a name="line.458"></a>
<FONT color="green">459</FONT> * Get the first non-Expression parent of this node.<a name="line.459"></a>
<FONT color="green">460</FONT> * @return null or first ancestor that is not an Expression.<a name="line.460"></a>
<FONT color="green">461</FONT> */<a name="line.461"></a>
<FONT color="green">462</FONT> public ExpressionNode getExpressionOwner()<a name="line.462"></a>
<FONT color="green">463</FONT> {<a name="line.463"></a>
<FONT color="green">464</FONT> ExpressionNode parent = exprGetParent();<a name="line.464"></a>
<FONT color="green">465</FONT> while((null != parent) &amp;&amp; (parent instanceof Expression))<a name="line.465"></a>
<FONT color="green">466</FONT> parent = parent.exprGetParent();<a name="line.466"></a>
<FONT color="green">467</FONT> return parent;<a name="line.467"></a>
<FONT color="green">468</FONT> }<a name="line.468"></a>
<FONT color="green">469</FONT> <a name="line.469"></a>
<FONT color="green">470</FONT> //=============== ExpressionNode methods ================<a name="line.470"></a>
<FONT color="green">471</FONT> <a name="line.471"></a>
<FONT color="green">472</FONT> /** This pair of methods are used to inform the node of its<a name="line.472"></a>
<FONT color="green">473</FONT> parent. */<a name="line.473"></a>
<FONT color="green">474</FONT> public void exprSetParent(ExpressionNode n)<a name="line.474"></a>
<FONT color="green">475</FONT> {<a name="line.475"></a>
<FONT color="green">476</FONT> assertion(n != this, "Can not parent an expression to itself!");<a name="line.476"></a>
<FONT color="green">477</FONT> m_parent = n;<a name="line.477"></a>
<FONT color="green">478</FONT> }<a name="line.478"></a>
<FONT color="green">479</FONT> <a name="line.479"></a>
<FONT color="green">480</FONT> public ExpressionNode exprGetParent()<a name="line.480"></a>
<FONT color="green">481</FONT> {<a name="line.481"></a>
<FONT color="green">482</FONT> return m_parent;<a name="line.482"></a>
<FONT color="green">483</FONT> }<a name="line.483"></a>
<FONT color="green">484</FONT> <a name="line.484"></a>
<FONT color="green">485</FONT> /** This method tells the node to add its argument to the node's<a name="line.485"></a>
<FONT color="green">486</FONT> list of children. */<a name="line.486"></a>
<FONT color="green">487</FONT> public void exprAddChild(ExpressionNode n, int i)<a name="line.487"></a>
<FONT color="green">488</FONT> {<a name="line.488"></a>
<FONT color="green">489</FONT> assertion(false, "exprAddChild method not implemented!");<a name="line.489"></a>
<FONT color="green">490</FONT> }<a name="line.490"></a>
<FONT color="green">491</FONT> <a name="line.491"></a>
<FONT color="green">492</FONT> /** This method returns a child node. The children are numbered<a name="line.492"></a>
<FONT color="green">493</FONT> from zero, left to right. */<a name="line.493"></a>
<FONT color="green">494</FONT> public ExpressionNode exprGetChild(int i)<a name="line.494"></a>
<FONT color="green">495</FONT> {<a name="line.495"></a>
<FONT color="green">496</FONT> return null;<a name="line.496"></a>
<FONT color="green">497</FONT> }<a name="line.497"></a>
<FONT color="green">498</FONT> <a name="line.498"></a>
<FONT color="green">499</FONT> /** Return the number of children the node has. */<a name="line.499"></a>
<FONT color="green">500</FONT> public int exprGetNumChildren()<a name="line.500"></a>
<FONT color="green">501</FONT> {<a name="line.501"></a>
<FONT color="green">502</FONT> return 0;<a name="line.502"></a>
<FONT color="green">503</FONT> }<a name="line.503"></a>
<FONT color="green">504</FONT> <a name="line.504"></a>
<FONT color="green">505</FONT> //=============== SourceLocator methods ================<a name="line.505"></a>
<FONT color="green">506</FONT> <a name="line.506"></a>
<FONT color="green">507</FONT> /**<a name="line.507"></a>
<FONT color="green">508</FONT> * Return the public identifier for the current document event.<a name="line.508"></a>
<FONT color="green">509</FONT> *<a name="line.509"></a>
<FONT color="green">510</FONT> * &lt;p&gt;The return value is the public identifier of the document<a name="line.510"></a>
<FONT color="green">511</FONT> * entity or of the external parsed entity in which the markup that<a name="line.511"></a>
<FONT color="green">512</FONT> * triggered the event appears.&lt;/p&gt;<a name="line.512"></a>
<FONT color="green">513</FONT> *<a name="line.513"></a>
<FONT color="green">514</FONT> * @return A string containing the public identifier, or<a name="line.514"></a>
<FONT color="green">515</FONT> * null if none is available.<a name="line.515"></a>
<FONT color="green">516</FONT> * @see #getSystemId<a name="line.516"></a>
<FONT color="green">517</FONT> */<a name="line.517"></a>
<FONT color="green">518</FONT> public String getPublicId()<a name="line.518"></a>
<FONT color="green">519</FONT> {<a name="line.519"></a>
<FONT color="green">520</FONT> if(null == m_parent)<a name="line.520"></a>
<FONT color="green">521</FONT> return null;<a name="line.521"></a>
<FONT color="green">522</FONT> return m_parent.getPublicId();<a name="line.522"></a>
<FONT color="green">523</FONT> }<a name="line.523"></a>
<FONT color="green">524</FONT> <a name="line.524"></a>
<FONT color="green">525</FONT> /**<a name="line.525"></a>
<FONT color="green">526</FONT> * Return the system identifier for the current document event.<a name="line.526"></a>
<FONT color="green">527</FONT> *<a name="line.527"></a>
<FONT color="green">528</FONT> * &lt;p&gt;The return value is the system identifier of the document<a name="line.528"></a>
<FONT color="green">529</FONT> * entity or of the external parsed entity in which the markup that<a name="line.529"></a>
<FONT color="green">530</FONT> * triggered the event appears.&lt;/p&gt;<a name="line.530"></a>
<FONT color="green">531</FONT> *<a name="line.531"></a>
<FONT color="green">532</FONT> * &lt;p&gt;If the system identifier is a URL, the parser must resolve it<a name="line.532"></a>
<FONT color="green">533</FONT> * fully before passing it to the application.&lt;/p&gt;<a name="line.533"></a>
<FONT color="green">534</FONT> *<a name="line.534"></a>
<FONT color="green">535</FONT> * @return A string containing the system identifier, or null<a name="line.535"></a>
<FONT color="green">536</FONT> * if none is available.<a name="line.536"></a>
<FONT color="green">537</FONT> * @see #getPublicId<a name="line.537"></a>
<FONT color="green">538</FONT> */<a name="line.538"></a>
<FONT color="green">539</FONT> public String getSystemId()<a name="line.539"></a>
<FONT color="green">540</FONT> {<a name="line.540"></a>
<FONT color="green">541</FONT> if(null == m_parent)<a name="line.541"></a>
<FONT color="green">542</FONT> return null;<a name="line.542"></a>
<FONT color="green">543</FONT> return m_parent.getSystemId();<a name="line.543"></a>
<FONT color="green">544</FONT> }<a name="line.544"></a>
<FONT color="green">545</FONT> <a name="line.545"></a>
<FONT color="green">546</FONT> /**<a name="line.546"></a>
<FONT color="green">547</FONT> * Return the line number where the current document event ends.<a name="line.547"></a>
<FONT color="green">548</FONT> *<a name="line.548"></a>
<FONT color="green">549</FONT> * &lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; The return value from the method<a name="line.549"></a>
<FONT color="green">550</FONT> * is intended only as an approximation for the sake of error<a name="line.550"></a>
<FONT color="green">551</FONT> * reporting; it is not intended to provide sufficient information<a name="line.551"></a>
<FONT color="green">552</FONT> * to edit the character content of the original XML document.&lt;/p&gt;<a name="line.552"></a>
<FONT color="green">553</FONT> *<a name="line.553"></a>
<FONT color="green">554</FONT> * &lt;p&gt;The return value is an approximation of the line number<a name="line.554"></a>
<FONT color="green">555</FONT> * in the document entity or external parsed entity where the<a name="line.555"></a>
<FONT color="green">556</FONT> * markup that triggered the event appears.&lt;/p&gt;<a name="line.556"></a>
<FONT color="green">557</FONT> *<a name="line.557"></a>
<FONT color="green">558</FONT> * @return The line number, or -1 if none is available.<a name="line.558"></a>
<FONT color="green">559</FONT> * @see #getColumnNumber<a name="line.559"></a>
<FONT color="green">560</FONT> */<a name="line.560"></a>
<FONT color="green">561</FONT> public int getLineNumber()<a name="line.561"></a>
<FONT color="green">562</FONT> {<a name="line.562"></a>
<FONT color="green">563</FONT> if(null == m_parent)<a name="line.563"></a>
<FONT color="green">564</FONT> return 0;<a name="line.564"></a>
<FONT color="green">565</FONT> return m_parent.getLineNumber();<a name="line.565"></a>
<FONT color="green">566</FONT> }<a name="line.566"></a>
<FONT color="green">567</FONT> <a name="line.567"></a>
<FONT color="green">568</FONT> /**<a name="line.568"></a>
<FONT color="green">569</FONT> * Return the character position where the current document event ends.<a name="line.569"></a>
<FONT color="green">570</FONT> *<a name="line.570"></a>
<FONT color="green">571</FONT> * &lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; The return value from the method<a name="line.571"></a>
<FONT color="green">572</FONT> * is intended only as an approximation for the sake of error<a name="line.572"></a>
<FONT color="green">573</FONT> * reporting; it is not intended to provide sufficient information<a name="line.573"></a>
<FONT color="green">574</FONT> * to edit the character content of the original XML document.&lt;/p&gt;<a name="line.574"></a>
<FONT color="green">575</FONT> *<a name="line.575"></a>
<FONT color="green">576</FONT> * &lt;p&gt;The return value is an approximation of the column number<a name="line.576"></a>
<FONT color="green">577</FONT> * in the document entity or external parsed entity where the<a name="line.577"></a>
<FONT color="green">578</FONT> * markup that triggered the event appears.&lt;/p&gt;<a name="line.578"></a>
<FONT color="green">579</FONT> *<a name="line.579"></a>
<FONT color="green">580</FONT> * @return The column number, or -1 if none is available.<a name="line.580"></a>
<FONT color="green">581</FONT> * @see #getLineNumber<a name="line.581"></a>
<FONT color="green">582</FONT> */<a name="line.582"></a>
<FONT color="green">583</FONT> public int getColumnNumber()<a name="line.583"></a>
<FONT color="green">584</FONT> {<a name="line.584"></a>
<FONT color="green">585</FONT> if(null == m_parent)<a name="line.585"></a>
<FONT color="green">586</FONT> return 0;<a name="line.586"></a>
<FONT color="green">587</FONT> return m_parent.getColumnNumber();<a name="line.587"></a>
<FONT color="green">588</FONT> }<a name="line.588"></a>
<FONT color="green">589</FONT> }<a name="line.589"></a>
</PRE>
</BODY>
</HTML>