Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xalan / templates / AVTPartXPath.html
blob: fdcd557ba8c149ad5fb352d13b3677d0bcf6afa8 [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: AVTPartXPath.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 org.apache.xml.utils.FastStringBuffer;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.xpath.XPath;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xpath.XPathContext;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xpath.XPathFactory;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xpath.compiler.XPathParser;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xpath.objects.XObject;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * Simple string part of a complex AVT.<a name="line.31"></a>
<FONT color="green">032</FONT> * @xsl.usage internal<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public class AVTPartXPath extends AVTPart<a name="line.34"></a>
<FONT color="green">035</FONT> {<a name="line.35"></a>
<FONT color="green">036</FONT> static final long serialVersionUID = -4460373807550527675L;<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> * The XPath object contained in this part.<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 XPath m_xpath;<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> * This function is used to fixup variables from QNames to stack frame <a name="line.45"></a>
<FONT color="green">046</FONT> * indexes at stylesheet build time.<a name="line.46"></a>
<FONT color="green">047</FONT> * @param vars List of QNames that correspond to variables. This list <a name="line.47"></a>
<FONT color="green">048</FONT> * should be searched backwards for the first qualified name that <a name="line.48"></a>
<FONT color="green">049</FONT> * corresponds to the variable reference qname. The position of the <a name="line.49"></a>
<FONT color="green">050</FONT> * QName in the vector from the start of the vector will be its position <a name="line.50"></a>
<FONT color="green">051</FONT> * in the stack frame (but variables above the globalsTop value will need <a name="line.51"></a>
<FONT color="green">052</FONT> * to be offset to the current stack frame).<a name="line.52"></a>
<FONT color="green">053</FONT> */<a name="line.53"></a>
<FONT color="green">054</FONT> public void fixupVariables(java.util.Vector vars, int globalsSize)<a name="line.54"></a>
<FONT color="green">055</FONT> {<a name="line.55"></a>
<FONT color="green">056</FONT> m_xpath.fixupVariables(vars, globalsSize);<a name="line.56"></a>
<FONT color="green">057</FONT> }<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> /**<a name="line.59"></a>
<FONT color="green">060</FONT> * Tell if this expression or it's subexpressions can traverse outside <a name="line.60"></a>
<FONT color="green">061</FONT> * the current subtree.<a name="line.61"></a>
<FONT color="green">062</FONT> * <a name="line.62"></a>
<FONT color="green">063</FONT> * @return true if traversal outside the context node's subtree can occur.<a name="line.63"></a>
<FONT color="green">064</FONT> */<a name="line.64"></a>
<FONT color="green">065</FONT> public boolean canTraverseOutsideSubtree()<a name="line.65"></a>
<FONT color="green">066</FONT> {<a name="line.66"></a>
<FONT color="green">067</FONT> return m_xpath.getExpression().canTraverseOutsideSubtree();<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> /**<a name="line.70"></a>
<FONT color="green">071</FONT> * Construct a simple AVT part.<a name="line.71"></a>
<FONT color="green">072</FONT> *<a name="line.72"></a>
<FONT color="green">073</FONT> * @param xpath Xpath section of AVT <a name="line.73"></a>
<FONT color="green">074</FONT> */<a name="line.74"></a>
<FONT color="green">075</FONT> public AVTPartXPath(XPath xpath)<a name="line.75"></a>
<FONT color="green">076</FONT> {<a name="line.76"></a>
<FONT color="green">077</FONT> m_xpath = xpath;<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> /**<a name="line.80"></a>
<FONT color="green">081</FONT> * Construct a simple AVT part.<a name="line.81"></a>
<FONT color="green">082</FONT> * <a name="line.82"></a>
<FONT color="green">083</FONT> * @param val A pure string section of an AVT.<a name="line.83"></a>
<FONT color="green">084</FONT> * @param nsNode An object which can be used to determine the<a name="line.84"></a>
<FONT color="green">085</FONT> * Namespace Name (URI) for any Namespace prefix used in the XPath. <a name="line.85"></a>
<FONT color="green">086</FONT> * Usually this is based on the context where the XPath was specified,<a name="line.86"></a>
<FONT color="green">087</FONT> * such as a node within a Stylesheet.<a name="line.87"></a>
<FONT color="green">088</FONT> * @param xpathProcessor XPath parser<a name="line.88"></a>
<FONT color="green">089</FONT> * @param factory XPath factory<a name="line.89"></a>
<FONT color="green">090</FONT> * @param liaison An XPathContext object, providing infomation specific<a name="line.90"></a>
<FONT color="green">091</FONT> * to this invocation and this thread. Maintains SAX output state, <a name="line.91"></a>
<FONT color="green">092</FONT> * variables, error handler and so on, so the transformation/XPath <a name="line.92"></a>
<FONT color="green">093</FONT> * object itself can be simultaneously invoked from multiple threads.<a name="line.93"></a>
<FONT color="green">094</FONT> *<a name="line.94"></a>
<FONT color="green">095</FONT> * @throws javax.xml.transform.TransformerException<a name="line.95"></a>
<FONT color="green">096</FONT> * TODO: Fix or remove this unused c'tor.<a name="line.96"></a>
<FONT color="green">097</FONT> */<a name="line.97"></a>
<FONT color="green">098</FONT> public AVTPartXPath(<a name="line.98"></a>
<FONT color="green">099</FONT> String val, org.apache.xml.utils.PrefixResolver nsNode, <a name="line.99"></a>
<FONT color="green">100</FONT> XPathParser xpathProcessor, XPathFactory factory, <a name="line.100"></a>
<FONT color="green">101</FONT> XPathContext liaison)<a name="line.101"></a>
<FONT color="green">102</FONT> throws javax.xml.transform.TransformerException<a name="line.102"></a>
<FONT color="green">103</FONT> {<a name="line.103"></a>
<FONT color="green">104</FONT> m_xpath = new XPath(val, null, nsNode, XPath.SELECT, liaison.getErrorListener());<a name="line.104"></a>
<FONT color="green">105</FONT> }<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> /**<a name="line.107"></a>
<FONT color="green">108</FONT> * Get the AVT part as the original string.<a name="line.108"></a>
<FONT color="green">109</FONT> *<a name="line.109"></a>
<FONT color="green">110</FONT> * @return the AVT part as the original string.<a name="line.110"></a>
<FONT color="green">111</FONT> */<a name="line.111"></a>
<FONT color="green">112</FONT> public String getSimpleString()<a name="line.112"></a>
<FONT color="green">113</FONT> {<a name="line.113"></a>
<FONT color="green">114</FONT> return "{" + m_xpath.getPatternString() + "}";<a name="line.114"></a>
<FONT color="green">115</FONT> }<a name="line.115"></a>
<FONT color="green">116</FONT> <a name="line.116"></a>
<FONT color="green">117</FONT> /**<a name="line.117"></a>
<FONT color="green">118</FONT> * Write the value into the buffer.<a name="line.118"></a>
<FONT color="green">119</FONT> *<a name="line.119"></a>
<FONT color="green">120</FONT> * @param xctxt An XPathContext object, providing infomation specific<a name="line.120"></a>
<FONT color="green">121</FONT> * to this invocation and this thread. Maintains SAX state, variables, <a name="line.121"></a>
<FONT color="green">122</FONT> * error handler and so on, so the transformation/XPath object itself<a name="line.122"></a>
<FONT color="green">123</FONT> * can be simultaneously invoked from multiple threads.<a name="line.123"></a>
<FONT color="green">124</FONT> * @param buf Buffer to write into.<a name="line.124"></a>
<FONT color="green">125</FONT> * @param context The current source tree context.<a name="line.125"></a>
<FONT color="green">126</FONT> * @param nsNode The current namespace context (stylesheet tree context).<a name="line.126"></a>
<FONT color="green">127</FONT> *<a name="line.127"></a>
<FONT color="green">128</FONT> * @throws javax.xml.transform.TransformerException<a name="line.128"></a>
<FONT color="green">129</FONT> */<a name="line.129"></a>
<FONT color="green">130</FONT> public void evaluate(<a name="line.130"></a>
<FONT color="green">131</FONT> XPathContext xctxt, FastStringBuffer buf, int context, org.apache.xml.utils.PrefixResolver nsNode)<a name="line.131"></a>
<FONT color="green">132</FONT> throws javax.xml.transform.TransformerException<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> XObject xobj = m_xpath.execute(xctxt, context, nsNode);<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> if (null != xobj)<a name="line.137"></a>
<FONT color="green">138</FONT> {<a name="line.138"></a>
<FONT color="green">139</FONT> xobj.appendToFsb(buf);<a name="line.139"></a>
<FONT color="green">140</FONT> }<a name="line.140"></a>
<FONT color="green">141</FONT> }<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> * @see XSLTVisitable#callVisitors(XSLTVisitor)<a name="line.144"></a>
<FONT color="green">145</FONT> */<a name="line.145"></a>
<FONT color="green">146</FONT> public void callVisitors(XSLTVisitor visitor)<a name="line.146"></a>
<FONT color="green">147</FONT> {<a name="line.147"></a>
<FONT color="green">148</FONT> m_xpath.getExpression().callVisitors(m_xpath, visitor);<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>
</PRE>
</BODY>
</HTML>