blob: 4755d7ce8160885dbbfd3d9fbf10d2a21735dc96 [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: Arg.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 org.apache.xml.utils.QName;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.xpath.objects.XObject;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> /**<a name="line.26"></a>
<FONT color="green">027</FONT> * This class holds an instance of an argument on<a name="line.27"></a>
<FONT color="green">028</FONT> * the stack. The value of the argument can be either an<a name="line.28"></a>
<FONT color="green">029</FONT> * XObject or a String containing an expression.<a name="line.29"></a>
<FONT color="green">030</FONT> * @xsl.usage internal<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> public class Arg<a name="line.32"></a>
<FONT color="green">033</FONT> {<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> /** Field m_qname: The name of this argument, expressed as a QName<a name="line.35"></a>
<FONT color="green">036</FONT> * (Qualified Name) object.<a name="line.36"></a>
<FONT color="green">037</FONT> * @see getQName<a name="line.37"></a>
<FONT color="green">038</FONT> * @see setQName<a name="line.38"></a>
<FONT color="green">039</FONT> * */<a name="line.39"></a>
<FONT color="green">040</FONT> private QName m_qname;<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> /**<a name="line.42"></a>
<FONT color="green">043</FONT> * Get the qualified name for this argument.<a name="line.43"></a>
<FONT color="green">044</FONT> *<a name="line.44"></a>
<FONT color="green">045</FONT> * @return QName object containing the qualified name<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public final QName getQName()<a name="line.47"></a>
<FONT color="green">048</FONT> {<a name="line.48"></a>
<FONT color="green">049</FONT> return m_qname;<a name="line.49"></a>
<FONT color="green">050</FONT> }<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> /**<a name="line.52"></a>
<FONT color="green">053</FONT> * Set the qualified name for this argument.<a name="line.53"></a>
<FONT color="green">054</FONT> *<a name="line.54"></a>
<FONT color="green">055</FONT> * @param name QName object representing the new Qualified Name.<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> public final void setQName(QName name)<a name="line.57"></a>
<FONT color="green">058</FONT> {<a name="line.58"></a>
<FONT color="green">059</FONT> m_qname = name;<a name="line.59"></a>
<FONT color="green">060</FONT> }<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> /** Field m_val: Stored XObject value of this argument<a name="line.62"></a>
<FONT color="green">063</FONT> * @see #getVal()<a name="line.63"></a>
<FONT color="green">064</FONT> * @see #setVal()<a name="line.64"></a>
<FONT color="green">065</FONT> */<a name="line.65"></a>
<FONT color="green">066</FONT> private XObject m_val;<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> /**<a name="line.68"></a>
<FONT color="green">069</FONT> * Get the value for this argument.<a name="line.69"></a>
<FONT color="green">070</FONT> *<a name="line.70"></a>
<FONT color="green">071</FONT> * @return the argument's stored XObject value.<a name="line.71"></a>
<FONT color="green">072</FONT> * @see #setVal(XObject)<a name="line.72"></a>
<FONT color="green">073</FONT> */<a name="line.73"></a>
<FONT color="green">074</FONT> public final XObject getVal()<a name="line.74"></a>
<FONT color="green">075</FONT> {<a name="line.75"></a>
<FONT color="green">076</FONT> return m_val;<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> * Set the value of this argument.<a name="line.80"></a>
<FONT color="green">081</FONT> *<a name="line.81"></a>
<FONT color="green">082</FONT> * @param val an XObject representing the arguments's value.<a name="line.82"></a>
<FONT color="green">083</FONT> * @see #getVal()<a name="line.83"></a>
<FONT color="green">084</FONT> */<a name="line.84"></a>
<FONT color="green">085</FONT> public final void setVal(XObject val)<a name="line.85"></a>
<FONT color="green">086</FONT> {<a name="line.86"></a>
<FONT color="green">087</FONT> m_val = val;<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> /**<a name="line.90"></a>
<FONT color="green">091</FONT> * Have the object release it's resources.<a name="line.91"></a>
<FONT color="green">092</FONT> * Call only when the variable or argument is going out of scope.<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> public void detach()<a name="line.94"></a>
<FONT color="green">095</FONT> {<a name="line.95"></a>
<FONT color="green">096</FONT> if(null != m_val)<a name="line.96"></a>
<FONT color="green">097</FONT> {<a name="line.97"></a>
<FONT color="green">098</FONT> m_val.allowDetachToRelease(true);<a name="line.98"></a>
<FONT color="green">099</FONT> m_val.detach();<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> }<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> /** Field m_expression: Stored expression value of this argument.<a name="line.104"></a>
<FONT color="green">105</FONT> * @see #setExpression<a name="line.105"></a>
<FONT color="green">106</FONT> * @see #getExpression<a name="line.106"></a>
<FONT color="green">107</FONT> * */<a name="line.107"></a>
<FONT color="green">108</FONT> private String m_expression;<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> /**<a name="line.110"></a>
<FONT color="green">111</FONT> * Get the value expression for this argument.<a name="line.111"></a>
<FONT color="green">112</FONT> *<a name="line.112"></a>
<FONT color="green">113</FONT> * @return String containing the expression previously stored into this<a name="line.113"></a>
<FONT color="green">114</FONT> * argument<a name="line.114"></a>
<FONT color="green">115</FONT> * @see #setExpression<a name="line.115"></a>
<FONT color="green">116</FONT> */<a name="line.116"></a>
<FONT color="green">117</FONT> public String getExpression()<a name="line.117"></a>
<FONT color="green">118</FONT> {<a name="line.118"></a>
<FONT color="green">119</FONT> return m_expression;<a name="line.119"></a>
<FONT color="green">120</FONT> }<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> * Set the value expression for this argument.<a name="line.123"></a>
<FONT color="green">124</FONT> *<a name="line.124"></a>
<FONT color="green">125</FONT> * @param expr String containing the expression to be stored as this<a name="line.125"></a>
<FONT color="green">126</FONT> * argument's value.<a name="line.126"></a>
<FONT color="green">127</FONT> * @see #getExpression<a name="line.127"></a>
<FONT color="green">128</FONT> */<a name="line.128"></a>
<FONT color="green">129</FONT> public void setExpression(String expr)<a name="line.129"></a>
<FONT color="green">130</FONT> {<a name="line.130"></a>
<FONT color="green">131</FONT> m_expression = expr;<a name="line.131"></a>
<FONT color="green">132</FONT> }<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> /** <a name="line.134"></a>
<FONT color="green">135</FONT> * True if this variable was added with an xsl:with-param or<a name="line.135"></a>
<FONT color="green">136</FONT> * is added via setParameter.<a name="line.136"></a>
<FONT color="green">137</FONT> */<a name="line.137"></a>
<FONT color="green">138</FONT> private boolean m_isFromWithParam;<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> /**<a name="line.140"></a>
<FONT color="green">141</FONT> * Tell if this variable is a parameter passed with a with-param or as <a name="line.141"></a>
<FONT color="green">142</FONT> * a top-level parameter.<a name="line.142"></a>
<FONT color="green">143</FONT> */<a name="line.143"></a>
<FONT color="green">144</FONT> public boolean isFromWithParam()<a name="line.144"></a>
<FONT color="green">145</FONT> {<a name="line.145"></a>
<FONT color="green">146</FONT> return m_isFromWithParam;<a name="line.146"></a>
<FONT color="green">147</FONT> }<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> /** <a name="line.149"></a>
<FONT color="green">150</FONT> * True if this variable is currently visible. To be visible,<a name="line.150"></a>
<FONT color="green">151</FONT> * a variable needs to come either from xsl:variable or be <a name="line.151"></a>
<FONT color="green">152</FONT> * a "received" parameter, ie one for which an xsl:param has<a name="line.152"></a>
<FONT color="green">153</FONT> * been encountered.<a name="line.153"></a>
<FONT color="green">154</FONT> * Set at the time the object is constructed and updated as needed.<a name="line.154"></a>
<FONT color="green">155</FONT> */<a name="line.155"></a>
<FONT color="green">156</FONT> private boolean m_isVisible;<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> * Tell if this variable is currently visible.<a name="line.159"></a>
<FONT color="green">160</FONT> */<a name="line.160"></a>
<FONT color="green">161</FONT> public boolean isVisible()<a name="line.161"></a>
<FONT color="green">162</FONT> {<a name="line.162"></a>
<FONT color="green">163</FONT> return m_isVisible;<a name="line.163"></a>
<FONT color="green">164</FONT> }<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> /**<a name="line.166"></a>
<FONT color="green">167</FONT> * Update visibility status of this variable.<a name="line.167"></a>
<FONT color="green">168</FONT> */<a name="line.168"></a>
<FONT color="green">169</FONT> public void setIsVisible(boolean b)<a name="line.169"></a>
<FONT color="green">170</FONT> {<a name="line.170"></a>
<FONT color="green">171</FONT> m_isVisible = b;<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> * Construct a dummy parameter argument, with no QName and no<a name="line.175"></a>
<FONT color="green">176</FONT> * value (either expression string or value XObject). isVisible<a name="line.176"></a>
<FONT color="green">177</FONT> * defaults to true.<a name="line.177"></a>
<FONT color="green">178</FONT> */<a name="line.178"></a>
<FONT color="green">179</FONT> public Arg()<a name="line.179"></a>
<FONT color="green">180</FONT> {<a name="line.180"></a>
<FONT color="green">181</FONT> <a name="line.181"></a>
<FONT color="green">182</FONT> m_qname = new QName("");<a name="line.182"></a>
<FONT color="green">183</FONT> ; // so that string compares can be done.<a name="line.183"></a>
<FONT color="green">184</FONT> m_val = null;<a name="line.184"></a>
<FONT color="green">185</FONT> m_expression = null;<a name="line.185"></a>
<FONT color="green">186</FONT> m_isVisible = true;<a name="line.186"></a>
<FONT color="green">187</FONT> m_isFromWithParam = false;<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> /**<a name="line.190"></a>
<FONT color="green">191</FONT> * Construct a parameter argument that contains an expression.<a name="line.191"></a>
<FONT color="green">192</FONT> *<a name="line.192"></a>
<FONT color="green">193</FONT> * @param qname Name of the argument, expressed as a QName object.<a name="line.193"></a>
<FONT color="green">194</FONT> * @param expression String to be stored as this argument's value expression.<a name="line.194"></a>
<FONT color="green">195</FONT> * @param isFromWithParam True if this is a parameter variable.<a name="line.195"></a>
<FONT color="green">196</FONT> */<a name="line.196"></a>
<FONT color="green">197</FONT> public Arg(QName qname, String expression, boolean isFromWithParam)<a name="line.197"></a>
<FONT color="green">198</FONT> {<a name="line.198"></a>
<FONT color="green">199</FONT> <a name="line.199"></a>
<FONT color="green">200</FONT> m_qname = qname;<a name="line.200"></a>
<FONT color="green">201</FONT> m_val = null;<a name="line.201"></a>
<FONT color="green">202</FONT> m_expression = expression;<a name="line.202"></a>
<FONT color="green">203</FONT> m_isFromWithParam = isFromWithParam;<a name="line.203"></a>
<FONT color="green">204</FONT> m_isVisible = !isFromWithParam;<a name="line.204"></a>
<FONT color="green">205</FONT> }<a name="line.205"></a>
<FONT color="green">206</FONT> <a name="line.206"></a>
<FONT color="green">207</FONT> /**<a name="line.207"></a>
<FONT color="green">208</FONT> * Construct a parameter argument which has an XObject value.<a name="line.208"></a>
<FONT color="green">209</FONT> * isVisible defaults to true.<a name="line.209"></a>
<FONT color="green">210</FONT> *<a name="line.210"></a>
<FONT color="green">211</FONT> * @param qname Name of the argument, expressed as a QName object.<a name="line.211"></a>
<FONT color="green">212</FONT> * @param val Value of the argument, expressed as an XObject<a name="line.212"></a>
<FONT color="green">213</FONT> */<a name="line.213"></a>
<FONT color="green">214</FONT> public Arg(QName qname, XObject val)<a name="line.214"></a>
<FONT color="green">215</FONT> {<a name="line.215"></a>
<FONT color="green">216</FONT> <a name="line.216"></a>
<FONT color="green">217</FONT> m_qname = qname;<a name="line.217"></a>
<FONT color="green">218</FONT> m_val = val;<a name="line.218"></a>
<FONT color="green">219</FONT> m_isVisible = true;<a name="line.219"></a>
<FONT color="green">220</FONT> m_isFromWithParam = false;<a name="line.220"></a>
<FONT color="green">221</FONT> m_expression = null;<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> * Equality function specialized for the variable name. If the argument <a name="line.225"></a>
<FONT color="green">226</FONT> * is not a qname, it will deligate to the super class.<a name="line.226"></a>
<FONT color="green">227</FONT> * <a name="line.227"></a>
<FONT color="green">228</FONT> * @param obj the reference object with which to compare.<a name="line.228"></a>
<FONT color="green">229</FONT> * @return &lt;code&gt;true&lt;/code&gt; if this object is the same as the obj<a name="line.229"></a>
<FONT color="green">230</FONT> * argument; &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.230"></a>
<FONT color="green">231</FONT> */<a name="line.231"></a>
<FONT color="green">232</FONT> public boolean equals(Object obj) <a name="line.232"></a>
<FONT color="green">233</FONT> {<a name="line.233"></a>
<FONT color="green">234</FONT> if(obj instanceof QName)<a name="line.234"></a>
<FONT color="green">235</FONT> {<a name="line.235"></a>
<FONT color="green">236</FONT> return m_qname.equals(obj);<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
<FONT color="green">238</FONT> else<a name="line.238"></a>
<FONT color="green">239</FONT> return super.equals(obj);<a name="line.239"></a>
<FONT color="green">240</FONT> }<a name="line.240"></a>
<FONT color="green">241</FONT> <a name="line.241"></a>
<FONT color="green">242</FONT> /**<a name="line.242"></a>
<FONT color="green">243</FONT> * Construct a parameter argument.<a name="line.243"></a>
<FONT color="green">244</FONT> *<a name="line.244"></a>
<FONT color="green">245</FONT> * @param qname Name of the argument, expressed as a QName object.<a name="line.245"></a>
<FONT color="green">246</FONT> * @param val Value of the argument, expressed as an XObject<a name="line.246"></a>
<FONT color="green">247</FONT> * @param isFromWithParam True if this is a parameter variable.<a name="line.247"></a>
<FONT color="green">248</FONT> */<a name="line.248"></a>
<FONT color="green">249</FONT> public Arg(QName qname, XObject val, boolean isFromWithParam)<a name="line.249"></a>
<FONT color="green">250</FONT> {<a name="line.250"></a>
<FONT color="green">251</FONT> <a name="line.251"></a>
<FONT color="green">252</FONT> m_qname = qname;<a name="line.252"></a>
<FONT color="green">253</FONT> m_val = val;<a name="line.253"></a>
<FONT color="green">254</FONT> m_isFromWithParam = isFromWithParam;<a name="line.254"></a>
<FONT color="green">255</FONT> m_isVisible = !isFromWithParam;<a name="line.255"></a>
<FONT color="green">256</FONT> m_expression = null;<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>
</PRE>
</BODY>
</HTML>