blob: d198310e585f7c8491ffd94546fc4ee4fcede2b6 [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: ElemTextLiteral.java 468643 2006-10-28 06:56:03Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xalan.templates;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import javax.xml.transform.TransformerException;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xalan.transformer.TransformerImpl;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xml.serializer.SerializationHandler;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.xml.sax.SAXException;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Implement a text literal.<a name="line.30"></a>
<FONT color="green">031</FONT> * @see &lt;a href="http://www.w3.org/TR/xslt#section-Creating-Text"&gt;section-Creating-Text in XSLT Specification&lt;/a&gt;<a name="line.31"></a>
<FONT color="green">032</FONT> * @xsl.usage advanced<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public class ElemTextLiteral extends ElemTemplateElement<a name="line.34"></a>
<FONT color="green">035</FONT> {<a name="line.35"></a>
<FONT color="green">036</FONT> static final long serialVersionUID = -7872620006767660088L;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /**<a name="line.38"></a>
<FONT color="green">039</FONT> * Tell if space should be preserved.<a name="line.39"></a>
<FONT color="green">040</FONT> * @serial<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> private boolean m_preserveSpace;<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * Set whether or not space should be preserved.<a name="line.45"></a>
<FONT color="green">046</FONT> *<a name="line.46"></a>
<FONT color="green">047</FONT> * @param v Boolean flag indicating whether <a name="line.47"></a>
<FONT color="green">048</FONT> * or not space should be preserved<a name="line.48"></a>
<FONT color="green">049</FONT> */<a name="line.49"></a>
<FONT color="green">050</FONT> public void setPreserveSpace(boolean v)<a name="line.50"></a>
<FONT color="green">051</FONT> {<a name="line.51"></a>
<FONT color="green">052</FONT> m_preserveSpace = v;<a name="line.52"></a>
<FONT color="green">053</FONT> }<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> * Get whether or not space should be preserved.<a name="line.56"></a>
<FONT color="green">057</FONT> *<a name="line.57"></a>
<FONT color="green">058</FONT> * @return Boolean flag indicating whether <a name="line.58"></a>
<FONT color="green">059</FONT> * or not space should be preserved <a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public boolean getPreserveSpace()<a name="line.61"></a>
<FONT color="green">062</FONT> {<a name="line.62"></a>
<FONT color="green">063</FONT> return m_preserveSpace;<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> * The character array.<a name="line.67"></a>
<FONT color="green">068</FONT> * @serial<a name="line.68"></a>
<FONT color="green">069</FONT> */<a name="line.69"></a>
<FONT color="green">070</FONT> private char m_ch[];<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> * The character array as a string.<a name="line.73"></a>
<FONT color="green">074</FONT> * @serial<a name="line.74"></a>
<FONT color="green">075</FONT> */<a name="line.75"></a>
<FONT color="green">076</FONT> private String m_str;<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> * Set the characters that will be output to the result tree..<a name="line.79"></a>
<FONT color="green">080</FONT> *<a name="line.80"></a>
<FONT color="green">081</FONT> * @param v Array of characters that will be output to the result tree <a name="line.81"></a>
<FONT color="green">082</FONT> */<a name="line.82"></a>
<FONT color="green">083</FONT> public void setChars(char[] v)<a name="line.83"></a>
<FONT color="green">084</FONT> {<a name="line.84"></a>
<FONT color="green">085</FONT> m_ch = v;<a name="line.85"></a>
<FONT color="green">086</FONT> }<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> * Get the characters that will be output to the result tree..<a name="line.89"></a>
<FONT color="green">090</FONT> *<a name="line.90"></a>
<FONT color="green">091</FONT> * @return Array of characters that will be output to the result tree<a name="line.91"></a>
<FONT color="green">092</FONT> */<a name="line.92"></a>
<FONT color="green">093</FONT> public char[] getChars()<a name="line.93"></a>
<FONT color="green">094</FONT> {<a name="line.94"></a>
<FONT color="green">095</FONT> return m_ch;<a name="line.95"></a>
<FONT color="green">096</FONT> }<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> * Get the value of the node as a string.<a name="line.99"></a>
<FONT color="green">100</FONT> *<a name="line.100"></a>
<FONT color="green">101</FONT> * @return null<a name="line.101"></a>
<FONT color="green">102</FONT> */<a name="line.102"></a>
<FONT color="green">103</FONT> public synchronized String getNodeValue()<a name="line.103"></a>
<FONT color="green">104</FONT> {<a name="line.104"></a>
<FONT color="green">105</FONT> <a name="line.105"></a>
<FONT color="green">106</FONT> if(null == m_str)<a name="line.106"></a>
<FONT color="green">107</FONT> {<a name="line.107"></a>
<FONT color="green">108</FONT> m_str = new String(m_ch);<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> return m_str;<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> <a name="line.114"></a>
<FONT color="green">115</FONT> /**<a name="line.115"></a>
<FONT color="green">116</FONT> * Tells if this element should disable escaping.<a name="line.116"></a>
<FONT color="green">117</FONT> * @serial<a name="line.117"></a>
<FONT color="green">118</FONT> */<a name="line.118"></a>
<FONT color="green">119</FONT> private boolean m_disableOutputEscaping = false;<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> * Set the "disable-output-escaping" attribute.<a name="line.122"></a>
<FONT color="green">123</FONT> * Normally, the xml output method escapes &amp; and &lt; (and<a name="line.123"></a>
<FONT color="green">124</FONT> * possibly other characters) when outputting text nodes.<a name="line.124"></a>
<FONT color="green">125</FONT> * This ensures that the output is well-formed XML. However,<a name="line.125"></a>
<FONT color="green">126</FONT> * it is sometimes convenient to be able to produce output<a name="line.126"></a>
<FONT color="green">127</FONT> * that is almost, but not quite well-formed XML; for<a name="line.127"></a>
<FONT color="green">128</FONT> * example, the output may include ill-formed sections<a name="line.128"></a>
<FONT color="green">129</FONT> * which are intended to be transformed into well-formed<a name="line.129"></a>
<FONT color="green">130</FONT> * XML by a subsequent non-XML aware process. For this reason,<a name="line.130"></a>
<FONT color="green">131</FONT> * XSLT provides a mechanism for disabling output escaping.<a name="line.131"></a>
<FONT color="green">132</FONT> * An xsl:value-of or xsl:text element may have a<a name="line.132"></a>
<FONT color="green">133</FONT> * disable-output-escaping attribute; the allowed values<a name="line.133"></a>
<FONT color="green">134</FONT> * are yes or no; the default is no; if the value is yes,<a name="line.134"></a>
<FONT color="green">135</FONT> * then a text node generated by instantiating the xsl:value-of<a name="line.135"></a>
<FONT color="green">136</FONT> * or xsl:text element should be output without any escaping.<a name="line.136"></a>
<FONT color="green">137</FONT> * @see &lt;a href="http://www.w3.org/TR/xslt#disable-output-escaping"&gt;disable-output-escaping in XSLT Specification&lt;/a&gt;<a name="line.137"></a>
<FONT color="green">138</FONT> *<a name="line.138"></a>
<FONT color="green">139</FONT> * @param v Boolean value for "disable-output-escaping" attribute.<a name="line.139"></a>
<FONT color="green">140</FONT> */<a name="line.140"></a>
<FONT color="green">141</FONT> public void setDisableOutputEscaping(boolean v)<a name="line.141"></a>
<FONT color="green">142</FONT> {<a name="line.142"></a>
<FONT color="green">143</FONT> m_disableOutputEscaping = v;<a name="line.143"></a>
<FONT color="green">144</FONT> }<a name="line.144"></a>
<FONT color="green">145</FONT> <a name="line.145"></a>
<FONT color="green">146</FONT> /**<a name="line.146"></a>
<FONT color="green">147</FONT> * Get the "disable-output-escaping" attribute.<a name="line.147"></a>
<FONT color="green">148</FONT> * Normally, the xml output method escapes &amp; and &lt; (and<a name="line.148"></a>
<FONT color="green">149</FONT> * possibly other characters) when outputting text nodes.<a name="line.149"></a>
<FONT color="green">150</FONT> * This ensures that the output is well-formed XML. However,<a name="line.150"></a>
<FONT color="green">151</FONT> * it is sometimes convenient to be able to produce output<a name="line.151"></a>
<FONT color="green">152</FONT> * that is almost, but not quite well-formed XML; for<a name="line.152"></a>
<FONT color="green">153</FONT> * example, the output may include ill-formed sections<a name="line.153"></a>
<FONT color="green">154</FONT> * which are intended to be transformed into well-formed<a name="line.154"></a>
<FONT color="green">155</FONT> * XML by a subsequent non-XML aware process. For this reason,<a name="line.155"></a>
<FONT color="green">156</FONT> * XSLT provides a mechanism for disabling output escaping.<a name="line.156"></a>
<FONT color="green">157</FONT> * An xsl:value-of or xsl:text element may have a<a name="line.157"></a>
<FONT color="green">158</FONT> * disable-output-escaping attribute; the allowed values<a name="line.158"></a>
<FONT color="green">159</FONT> * are yes or no; the default is no; if the value is yes,<a name="line.159"></a>
<FONT color="green">160</FONT> * then a text node generated by instantiating the xsl:value-of<a name="line.160"></a>
<FONT color="green">161</FONT> * or xsl:text element should be output without any escaping.<a name="line.161"></a>
<FONT color="green">162</FONT> * @see &lt;a href="http://www.w3.org/TR/xslt#disable-output-escaping"&gt;disable-output-escaping in XSLT Specification&lt;/a&gt;<a name="line.162"></a>
<FONT color="green">163</FONT> *<a name="line.163"></a>
<FONT color="green">164</FONT> * @return Boolean value of "disable-output-escaping" attribute.<a name="line.164"></a>
<FONT color="green">165</FONT> */<a name="line.165"></a>
<FONT color="green">166</FONT> public boolean getDisableOutputEscaping()<a name="line.166"></a>
<FONT color="green">167</FONT> {<a name="line.167"></a>
<FONT color="green">168</FONT> return m_disableOutputEscaping;<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> /**<a name="line.171"></a>
<FONT color="green">172</FONT> * Get an integer representation of the element type.<a name="line.172"></a>
<FONT color="green">173</FONT> *<a name="line.173"></a>
<FONT color="green">174</FONT> * @return An integer representation of the element, defined in the<a name="line.174"></a>
<FONT color="green">175</FONT> * Constants class.<a name="line.175"></a>
<FONT color="green">176</FONT> * @see org.apache.xalan.templates.Constants<a name="line.176"></a>
<FONT color="green">177</FONT> */<a name="line.177"></a>
<FONT color="green">178</FONT> public int getXSLToken()<a name="line.178"></a>
<FONT color="green">179</FONT> {<a name="line.179"></a>
<FONT color="green">180</FONT> return Constants.ELEMNAME_TEXTLITERALRESULT;<a name="line.180"></a>
<FONT color="green">181</FONT> }<a name="line.181"></a>
<FONT color="green">182</FONT> <a name="line.182"></a>
<FONT color="green">183</FONT> /**<a name="line.183"></a>
<FONT color="green">184</FONT> * Return the node name.<a name="line.184"></a>
<FONT color="green">185</FONT> *<a name="line.185"></a>
<FONT color="green">186</FONT> * @return The element's name<a name="line.186"></a>
<FONT color="green">187</FONT> */<a name="line.187"></a>
<FONT color="green">188</FONT> public String getNodeName()<a name="line.188"></a>
<FONT color="green">189</FONT> {<a name="line.189"></a>
<FONT color="green">190</FONT> return "#Text";<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> * Copy the text literal to the result tree.<a name="line.194"></a>
<FONT color="green">195</FONT> *<a name="line.195"></a>
<FONT color="green">196</FONT> * @param transformer non-null reference to the the current transform-time state.<a name="line.196"></a>
<FONT color="green">197</FONT> *<a name="line.197"></a>
<FONT color="green">198</FONT> * @throws TransformerException<a name="line.198"></a>
<FONT color="green">199</FONT> */<a name="line.199"></a>
<FONT color="green">200</FONT> public void execute(<a name="line.200"></a>
<FONT color="green">201</FONT> TransformerImpl transformer)<a name="line.201"></a>
<FONT color="green">202</FONT> throws TransformerException<a name="line.202"></a>
<FONT color="green">203</FONT> {<a name="line.203"></a>
<FONT color="green">204</FONT> try<a name="line.204"></a>
<FONT color="green">205</FONT> {<a name="line.205"></a>
<FONT color="green">206</FONT> SerializationHandler rth = transformer.getResultTreeHandler();<a name="line.206"></a>
<FONT color="green">207</FONT> if (transformer.getDebug()) {<a name="line.207"></a>
<FONT color="green">208</FONT> // flush any pending cached processing before the trace event.<a name="line.208"></a>
<FONT color="green">209</FONT> rth.flushPending();<a name="line.209"></a>
<FONT color="green">210</FONT> transformer.getTraceManager().fireTraceEvent(this);<a name="line.210"></a>
<FONT color="green">211</FONT> }<a name="line.211"></a>
<FONT color="green">212</FONT> <a name="line.212"></a>
<FONT color="green">213</FONT> if (m_disableOutputEscaping)<a name="line.213"></a>
<FONT color="green">214</FONT> {<a name="line.214"></a>
<FONT color="green">215</FONT> rth.processingInstruction(javax.xml.transform.Result.PI_DISABLE_OUTPUT_ESCAPING, "");<a name="line.215"></a>
<FONT color="green">216</FONT> }<a name="line.216"></a>
<FONT color="green">217</FONT> <a name="line.217"></a>
<FONT color="green">218</FONT> rth.characters(m_ch, 0, m_ch.length);<a name="line.218"></a>
<FONT color="green">219</FONT> <a name="line.219"></a>
<FONT color="green">220</FONT> if (m_disableOutputEscaping)<a name="line.220"></a>
<FONT color="green">221</FONT> {<a name="line.221"></a>
<FONT color="green">222</FONT> rth.processingInstruction(javax.xml.transform.Result.PI_ENABLE_OUTPUT_ESCAPING, "");<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> catch(SAXException se)<a name="line.225"></a>
<FONT color="green">226</FONT> {<a name="line.226"></a>
<FONT color="green">227</FONT> throw new TransformerException(se);<a name="line.227"></a>
<FONT color="green">228</FONT> }<a name="line.228"></a>
<FONT color="green">229</FONT> finally<a name="line.229"></a>
<FONT color="green">230</FONT> {<a name="line.230"></a>
<FONT color="green">231</FONT> if (transformer.getDebug()) {<a name="line.231"></a>
<FONT color="green">232</FONT> try<a name="line.232"></a>
<FONT color="green">233</FONT> {<a name="line.233"></a>
<FONT color="green">234</FONT> // flush any pending cached processing before sending the trace event<a name="line.234"></a>
<FONT color="green">235</FONT> transformer.getResultTreeHandler().flushPending();<a name="line.235"></a>
<FONT color="green">236</FONT> transformer.getTraceManager().fireTraceEndEvent(this);<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
<FONT color="green">238</FONT> catch (SAXException se)<a name="line.238"></a>
<FONT color="green">239</FONT> {<a name="line.239"></a>
<FONT color="green">240</FONT> throw new TransformerException(se);<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> }<a name="line.243"></a>
<FONT color="green">244</FONT> }<a name="line.244"></a>
<FONT color="green">245</FONT> }<a name="line.245"></a>
</PRE>
</BODY>
</HTML>