Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xalan / templates / AVTPart.html
blob: 81fb123f23b180532cb18fe1cf741c6ee0e1c980 [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: AVTPart.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.XPathContext;<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> * Class to hold a part, either a string or XPath,<a name="line.27"></a>
<FONT color="green">028</FONT> * of an Attribute Value Template.<a name="line.28"></a>
<FONT color="green">029</FONT> * @xsl.usage internal<a name="line.29"></a>
<FONT color="green">030</FONT> */<a name="line.30"></a>
<FONT color="green">031</FONT> public abstract class AVTPart implements java.io.Serializable, XSLTVisitable<a name="line.31"></a>
<FONT color="green">032</FONT> {<a name="line.32"></a>
<FONT color="green">033</FONT> static final long serialVersionUID = -1747749903613916025L;<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> /**<a name="line.35"></a>
<FONT color="green">036</FONT> * Construct a part.<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public AVTPart(){}<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * Get the AVT part as the original string.<a name="line.41"></a>
<FONT color="green">042</FONT> *<a name="line.42"></a>
<FONT color="green">043</FONT> * @return the AVT part as the original string.<a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> public abstract String getSimpleString();<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> /**<a name="line.47"></a>
<FONT color="green">048</FONT> * Write the evaluated value into the given<a name="line.48"></a>
<FONT color="green">049</FONT> * string buffer.<a name="line.49"></a>
<FONT color="green">050</FONT> *<a name="line.50"></a>
<FONT color="green">051</FONT> * @param xctxt The XPath context to use to evaluate this AVT.<a name="line.51"></a>
<FONT color="green">052</FONT> * @param buf Buffer to write into.<a name="line.52"></a>
<FONT color="green">053</FONT> * @param context The current source tree context.<a name="line.53"></a>
<FONT color="green">054</FONT> * @param nsNode The current namespace context (stylesheet tree context).<a name="line.54"></a>
<FONT color="green">055</FONT> *<a name="line.55"></a>
<FONT color="green">056</FONT> * @throws javax.xml.transform.TransformerException<a name="line.56"></a>
<FONT color="green">057</FONT> */<a name="line.57"></a>
<FONT color="green">058</FONT> public abstract void evaluate(<a name="line.58"></a>
<FONT color="green">059</FONT> XPathContext xctxt, FastStringBuffer buf, int context,<a name="line.59"></a>
<FONT color="green">060</FONT> org.apache.xml.utils.PrefixResolver nsNode)<a name="line.60"></a>
<FONT color="green">061</FONT> throws javax.xml.transform.TransformerException;<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> /**<a name="line.63"></a>
<FONT color="green">064</FONT> * Set the XPath support.<a name="line.64"></a>
<FONT color="green">065</FONT> *<a name="line.65"></a>
<FONT color="green">066</FONT> * @param support XPathContext to set. <a name="line.66"></a>
<FONT color="green">067</FONT> */<a name="line.67"></a>
<FONT color="green">068</FONT> public void setXPathSupport(XPathContext support){}<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> * Tell if this expression or it's subexpressions can traverse outside <a name="line.71"></a>
<FONT color="green">072</FONT> * the current subtree.<a name="line.72"></a>
<FONT color="green">073</FONT> * <a name="line.73"></a>
<FONT color="green">074</FONT> * @return true if traversal outside the context node's subtree can occur.<a name="line.74"></a>
<FONT color="green">075</FONT> */<a name="line.75"></a>
<FONT color="green">076</FONT> public boolean canTraverseOutsideSubtree()<a name="line.76"></a>
<FONT color="green">077</FONT> {<a name="line.77"></a>
<FONT color="green">078</FONT> return false;<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> /**<a name="line.81"></a>
<FONT color="green">082</FONT> * This function is used to fixup variables from QNames to stack frame <a name="line.82"></a>
<FONT color="green">083</FONT> * indexes at stylesheet build time.<a name="line.83"></a>
<FONT color="green">084</FONT> * @param vars List of QNames that correspond to variables. This list <a name="line.84"></a>
<FONT color="green">085</FONT> * should be searched backwards for the first qualified name that <a name="line.85"></a>
<FONT color="green">086</FONT> * corresponds to the variable reference qname. The position of the <a name="line.86"></a>
<FONT color="green">087</FONT> * QName in the vector from the start of the vector will be its position <a name="line.87"></a>
<FONT color="green">088</FONT> * in the stack frame (but variables above the globalsTop value will need <a name="line.88"></a>
<FONT color="green">089</FONT> * to be offset to the current stack frame).<a name="line.89"></a>
<FONT color="green">090</FONT> */<a name="line.90"></a>
<FONT color="green">091</FONT> public abstract void fixupVariables(java.util.Vector vars, int globalsSize);<a name="line.91"></a>
<FONT color="green">092</FONT> <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>
</PRE>
</BODY>
</HTML>