blob: 958b97032b062aa18e712e6303b7ff6a0ca9b981 [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: ExsltCommon.java 468639 2006-10-28 06:52:33Z 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.lib;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.xalan.extensions.ExpressionContext;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.xml.dtm.DTMIterator;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xml.dtm.ref.DTMNodeIterator;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xpath.NodeSet;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * This class contains EXSLT common extension functions.<a name="line.29"></a>
<FONT color="green">030</FONT> * It is accessed by specifying a namespace URI as follows:<a name="line.30"></a>
<FONT color="green">031</FONT> * &lt;pre&gt;<a name="line.31"></a>
<FONT color="green">032</FONT> * xmlns:exslt="http://exslt.org/common"<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;/pre&gt;<a name="line.33"></a>
<FONT color="green">034</FONT> * <a name="line.34"></a>
<FONT color="green">035</FONT> * The documentation for each function has been copied from the relevant<a name="line.35"></a>
<FONT color="green">036</FONT> * EXSLT Implementer page.<a name="line.36"></a>
<FONT color="green">037</FONT> * <a name="line.37"></a>
<FONT color="green">038</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.38"></a>
<FONT color="green">039</FONT> * @xsl.usage general<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> public class ExsltCommon<a name="line.41"></a>
<FONT color="green">042</FONT> {<a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * The exsl:object-type function returns a string giving the type of the object passed <a name="line.44"></a>
<FONT color="green">045</FONT> * as the argument. The possible object types are: 'string', 'number', 'boolean', <a name="line.45"></a>
<FONT color="green">046</FONT> * 'node-set', 'RTF', or 'external'. <a name="line.46"></a>
<FONT color="green">047</FONT> * <a name="line.47"></a>
<FONT color="green">048</FONT> * Most XSLT object types can be coerced to each other without error. However, there are <a name="line.48"></a>
<FONT color="green">049</FONT> * certain coercions that raise errors, most importantly treating anything other than a <a name="line.49"></a>
<FONT color="green">050</FONT> * node set as a node set. Authors of utilities such as named templates or user-defined <a name="line.50"></a>
<FONT color="green">051</FONT> * extension functions may wish to give some flexibility in the parameter and argument values <a name="line.51"></a>
<FONT color="green">052</FONT> * that are accepted by the utility; the exsl:object-type function enables them to do so.<a name="line.52"></a>
<FONT color="green">053</FONT> * <a name="line.53"></a>
<FONT color="green">054</FONT> * The Xalan extensions MethodResolver converts 'object-type' to 'objectType'.<a name="line.54"></a>
<FONT color="green">055</FONT> * <a name="line.55"></a>
<FONT color="green">056</FONT> * @param obj The object to be typed.<a name="line.56"></a>
<FONT color="green">057</FONT> * @return objectType 'string', 'number', 'boolean', 'node-set', 'RTF', or 'external'.<a name="line.57"></a>
<FONT color="green">058</FONT> * <a name="line.58"></a>
<FONT color="green">059</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public static String objectType (Object obj)<a name="line.61"></a>
<FONT color="green">062</FONT> {<a name="line.62"></a>
<FONT color="green">063</FONT> if (obj instanceof String)<a name="line.63"></a>
<FONT color="green">064</FONT> return "string";<a name="line.64"></a>
<FONT color="green">065</FONT> else if (obj instanceof Boolean)<a name="line.65"></a>
<FONT color="green">066</FONT> return "boolean";<a name="line.66"></a>
<FONT color="green">067</FONT> else if (obj instanceof Number)<a name="line.67"></a>
<FONT color="green">068</FONT> return "number";<a name="line.68"></a>
<FONT color="green">069</FONT> else if (obj instanceof DTMNodeIterator)<a name="line.69"></a>
<FONT color="green">070</FONT> {<a name="line.70"></a>
<FONT color="green">071</FONT> DTMIterator dtmI = ((DTMNodeIterator)obj).getDTMIterator();<a name="line.71"></a>
<FONT color="green">072</FONT> if (dtmI instanceof org.apache.xpath.axes.RTFIterator)<a name="line.72"></a>
<FONT color="green">073</FONT> return "RTF";<a name="line.73"></a>
<FONT color="green">074</FONT> else<a name="line.74"></a>
<FONT color="green">075</FONT> return "node-set";<a name="line.75"></a>
<FONT color="green">076</FONT> }<a name="line.76"></a>
<FONT color="green">077</FONT> else<a name="line.77"></a>
<FONT color="green">078</FONT> return "unknown";<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> * The exsl:node-set function converts a result tree fragment (which is what you get <a name="line.82"></a>
<FONT color="green">083</FONT> * when you use the content of xsl:variable rather than its select attribute to give <a name="line.83"></a>
<FONT color="green">084</FONT> * a variable value) into a node set. This enables you to process the XML that you create <a name="line.84"></a>
<FONT color="green">085</FONT> * within a variable, and therefore do multi-step processing. <a name="line.85"></a>
<FONT color="green">086</FONT> * <a name="line.86"></a>
<FONT color="green">087</FONT> * You can also use this function to turn a string into a text node, which is helpful <a name="line.87"></a>
<FONT color="green">088</FONT> * if you want to pass a string to a function that only accepts a node set.<a name="line.88"></a>
<FONT color="green">089</FONT> * <a name="line.89"></a>
<FONT color="green">090</FONT> * The Xalan extensions MethodResolver converts 'node-set' to 'nodeSet'.<a name="line.90"></a>
<FONT color="green">091</FONT> * <a name="line.91"></a>
<FONT color="green">092</FONT> * @param myProcessor is passed in by the Xalan extension processor<a name="line.92"></a>
<FONT color="green">093</FONT> * @param rtf The result tree fragment to be converted to a node-set.<a name="line.93"></a>
<FONT color="green">094</FONT> * <a name="line.94"></a>
<FONT color="green">095</FONT> * @return node-set with the contents of the result tree fragment.<a name="line.95"></a>
<FONT color="green">096</FONT> * <a name="line.96"></a>
<FONT color="green">097</FONT> * Note: Already implemented in the xalan namespace as nodeset.<a name="line.97"></a>
<FONT color="green">098</FONT> * <a name="line.98"></a>
<FONT color="green">099</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.99"></a>
<FONT color="green">100</FONT> */<a name="line.100"></a>
<FONT color="green">101</FONT> public static NodeSet nodeSet(ExpressionContext myProcessor, Object rtf)<a name="line.101"></a>
<FONT color="green">102</FONT> {<a name="line.102"></a>
<FONT color="green">103</FONT> return Extensions.nodeset(myProcessor, rtf);<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> }<a name="line.106"></a>
</PRE>
</BODY>
</HTML>