blob: 1e74de5532acf453285c011ac8f4ccd8841f3795 [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: ExsltSets.java 469688 2006-10-31 22:39:43Z 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 java.util.HashMap;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.Map;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xml.utils.DOMHelper;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xpath.NodeSet;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.w3c.dom.Node;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.w3c.dom.NodeList;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> /**<a name="line.31"></a>
<FONT color="green">032</FONT> * This class contains EXSLT set extension functions.<a name="line.32"></a>
<FONT color="green">033</FONT> * It is accessed by specifying a namespace URI as follows:<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;pre&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * xmlns:set="http://exslt.org/sets"<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;/pre&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * <a name="line.37"></a>
<FONT color="green">038</FONT> * The documentation for each function has been copied from the relevant<a name="line.38"></a>
<FONT color="green">039</FONT> * EXSLT Implementer page. <a name="line.39"></a>
<FONT color="green">040</FONT> * <a name="line.40"></a>
<FONT color="green">041</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.41"></a>
<FONT color="green">042</FONT> * @xsl.usage general<a name="line.42"></a>
<FONT color="green">043</FONT> */<a name="line.43"></a>
<FONT color="green">044</FONT> public class ExsltSets extends ExsltBase<a name="line.44"></a>
<FONT color="green">045</FONT> { <a name="line.45"></a>
<FONT color="green">046</FONT> /**<a name="line.46"></a>
<FONT color="green">047</FONT> * The set:leading function returns the nodes in the node set passed as the first argument that<a name="line.47"></a>
<FONT color="green">048</FONT> * precede, in document order, the first node in the node set passed as the second argument. If<a name="line.48"></a>
<FONT color="green">049</FONT> * the first node in the second node set is not contained in the first node set, then an empty<a name="line.49"></a>
<FONT color="green">050</FONT> * node set is returned. If the second node set is empty, then the first node set is returned.<a name="line.50"></a>
<FONT color="green">051</FONT> * <a name="line.51"></a>
<FONT color="green">052</FONT> * @param nl1 NodeList for first node-set.<a name="line.52"></a>
<FONT color="green">053</FONT> * @param nl2 NodeList for second node-set.<a name="line.53"></a>
<FONT color="green">054</FONT> * @return a NodeList containing the nodes in nl1 that precede in document order the first<a name="line.54"></a>
<FONT color="green">055</FONT> * node in nl2; an empty node-set if the first node in nl2 is not in nl1; all of nl1 if nl2<a name="line.55"></a>
<FONT color="green">056</FONT> * is empty.<a name="line.56"></a>
<FONT color="green">057</FONT> * <a name="line.57"></a>
<FONT color="green">058</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> public static NodeList leading (NodeList nl1, NodeList nl2)<a name="line.60"></a>
<FONT color="green">061</FONT> {<a name="line.61"></a>
<FONT color="green">062</FONT> if (nl2.getLength() == 0)<a name="line.62"></a>
<FONT color="green">063</FONT> return nl1;<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> NodeSet ns1 = new NodeSet(nl1);<a name="line.65"></a>
<FONT color="green">066</FONT> NodeSet leadNodes = new NodeSet();<a name="line.66"></a>
<FONT color="green">067</FONT> Node endNode = nl2.item(0);<a name="line.67"></a>
<FONT color="green">068</FONT> if (!ns1.contains(endNode))<a name="line.68"></a>
<FONT color="green">069</FONT> return leadNodes; // empty NodeSet<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> for (int i = 0; i &lt; nl1.getLength(); i++)<a name="line.71"></a>
<FONT color="green">072</FONT> {<a name="line.72"></a>
<FONT color="green">073</FONT> Node testNode = nl1.item(i);<a name="line.73"></a>
<FONT color="green">074</FONT> if (DOMHelper.isNodeAfter(testNode, endNode) <a name="line.74"></a>
<FONT color="green">075</FONT> &amp;&amp; !DOMHelper.isNodeTheSame(testNode, endNode))<a name="line.75"></a>
<FONT color="green">076</FONT> leadNodes.addElement(testNode);<a name="line.76"></a>
<FONT color="green">077</FONT> }<a name="line.77"></a>
<FONT color="green">078</FONT> return leadNodes;<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 set:trailing function returns the nodes in the node set passed as the first argument that <a name="line.82"></a>
<FONT color="green">083</FONT> * follow, in document order, the first node in the node set passed as the second argument. If <a name="line.83"></a>
<FONT color="green">084</FONT> * the first node in the second node set is not contained in the first node set, then an empty <a name="line.84"></a>
<FONT color="green">085</FONT> * node set is returned. If the second node set is empty, then the first node set is returned. <a name="line.85"></a>
<FONT color="green">086</FONT> * <a name="line.86"></a>
<FONT color="green">087</FONT> * @param nl1 NodeList for first node-set.<a name="line.87"></a>
<FONT color="green">088</FONT> * @param nl2 NodeList for second node-set.<a name="line.88"></a>
<FONT color="green">089</FONT> * @return a NodeList containing the nodes in nl1 that follow in document order the first<a name="line.89"></a>
<FONT color="green">090</FONT> * node in nl2; an empty node-set if the first node in nl2 is not in nl1; all of nl1 if nl2<a name="line.90"></a>
<FONT color="green">091</FONT> * is empty.<a name="line.91"></a>
<FONT color="green">092</FONT> * <a name="line.92"></a>
<FONT color="green">093</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> public static NodeList trailing (NodeList nl1, NodeList nl2)<a name="line.95"></a>
<FONT color="green">096</FONT> {<a name="line.96"></a>
<FONT color="green">097</FONT> if (nl2.getLength() == 0)<a name="line.97"></a>
<FONT color="green">098</FONT> return nl1;<a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> NodeSet ns1 = new NodeSet(nl1);<a name="line.100"></a>
<FONT color="green">101</FONT> NodeSet trailNodes = new NodeSet();<a name="line.101"></a>
<FONT color="green">102</FONT> Node startNode = nl2.item(0);<a name="line.102"></a>
<FONT color="green">103</FONT> if (!ns1.contains(startNode))<a name="line.103"></a>
<FONT color="green">104</FONT> return trailNodes; // empty NodeSet<a name="line.104"></a>
<FONT color="green">105</FONT> <a name="line.105"></a>
<FONT color="green">106</FONT> for (int i = 0; i &lt; nl1.getLength(); i++)<a name="line.106"></a>
<FONT color="green">107</FONT> {<a name="line.107"></a>
<FONT color="green">108</FONT> Node testNode = nl1.item(i);<a name="line.108"></a>
<FONT color="green">109</FONT> if (DOMHelper.isNodeAfter(startNode, testNode) <a name="line.109"></a>
<FONT color="green">110</FONT> &amp;&amp; !DOMHelper.isNodeTheSame(startNode, testNode))<a name="line.110"></a>
<FONT color="green">111</FONT> trailNodes.addElement(testNode); <a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> return trailNodes;<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> /**<a name="line.116"></a>
<FONT color="green">117</FONT> * The set:intersection function returns a node set comprising the nodes that are within <a name="line.117"></a>
<FONT color="green">118</FONT> * both the node sets passed as arguments to it.<a name="line.118"></a>
<FONT color="green">119</FONT> * <a name="line.119"></a>
<FONT color="green">120</FONT> * @param nl1 NodeList for first node-set.<a name="line.120"></a>
<FONT color="green">121</FONT> * @param nl2 NodeList for second node-set.<a name="line.121"></a>
<FONT color="green">122</FONT> * @return a NodeList containing the nodes in nl1 that are also<a name="line.122"></a>
<FONT color="green">123</FONT> * in nl2.<a name="line.123"></a>
<FONT color="green">124</FONT> * <a name="line.124"></a>
<FONT color="green">125</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.125"></a>
<FONT color="green">126</FONT> */<a name="line.126"></a>
<FONT color="green">127</FONT> public static NodeList intersection(NodeList nl1, NodeList nl2)<a name="line.127"></a>
<FONT color="green">128</FONT> {<a name="line.128"></a>
<FONT color="green">129</FONT> NodeSet ns1 = new NodeSet(nl1);<a name="line.129"></a>
<FONT color="green">130</FONT> NodeSet ns2 = new NodeSet(nl2);<a name="line.130"></a>
<FONT color="green">131</FONT> NodeSet inter = new NodeSet();<a name="line.131"></a>
<FONT color="green">132</FONT> <a name="line.132"></a>
<FONT color="green">133</FONT> inter.setShouldCacheNodes(true);<a name="line.133"></a>
<FONT color="green">134</FONT> <a name="line.134"></a>
<FONT color="green">135</FONT> for (int i = 0; i &lt; ns1.getLength(); i++)<a name="line.135"></a>
<FONT color="green">136</FONT> {<a name="line.136"></a>
<FONT color="green">137</FONT> Node n = ns1.elementAt(i);<a name="line.137"></a>
<FONT color="green">138</FONT> <a name="line.138"></a>
<FONT color="green">139</FONT> if (ns2.contains(n))<a name="line.139"></a>
<FONT color="green">140</FONT> inter.addElement(n);<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> return inter;<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> * The set:difference function returns the difference between two node sets - those nodes that <a name="line.147"></a>
<FONT color="green">148</FONT> * are in the node set passed as the first argument that are not in the node set passed as the <a name="line.148"></a>
<FONT color="green">149</FONT> * second argument.<a name="line.149"></a>
<FONT color="green">150</FONT> * <a name="line.150"></a>
<FONT color="green">151</FONT> * @param nl1 NodeList for first node-set.<a name="line.151"></a>
<FONT color="green">152</FONT> * @param nl2 NodeList for second node-set.<a name="line.152"></a>
<FONT color="green">153</FONT> * @return a NodeList containing the nodes in nl1 that are not in nl2.<a name="line.153"></a>
<FONT color="green">154</FONT> * <a name="line.154"></a>
<FONT color="green">155</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.155"></a>
<FONT color="green">156</FONT> */<a name="line.156"></a>
<FONT color="green">157</FONT> public static NodeList difference(NodeList nl1, NodeList nl2)<a name="line.157"></a>
<FONT color="green">158</FONT> {<a name="line.158"></a>
<FONT color="green">159</FONT> NodeSet ns1 = new NodeSet(nl1);<a name="line.159"></a>
<FONT color="green">160</FONT> NodeSet ns2 = new NodeSet(nl2);<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> NodeSet diff = new NodeSet();<a name="line.162"></a>
<FONT color="green">163</FONT> <a name="line.163"></a>
<FONT color="green">164</FONT> diff.setShouldCacheNodes(true);<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> for (int i = 0; i &lt; ns1.getLength(); i++)<a name="line.166"></a>
<FONT color="green">167</FONT> {<a name="line.167"></a>
<FONT color="green">168</FONT> Node n = ns1.elementAt(i);<a name="line.168"></a>
<FONT color="green">169</FONT> <a name="line.169"></a>
<FONT color="green">170</FONT> if (!ns2.contains(n))<a name="line.170"></a>
<FONT color="green">171</FONT> diff.addElement(n);<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> return diff;<a name="line.174"></a>
<FONT color="green">175</FONT> }<a name="line.175"></a>
<FONT color="green">176</FONT> <a name="line.176"></a>
<FONT color="green">177</FONT> /**<a name="line.177"></a>
<FONT color="green">178</FONT> * The set:distinct function returns a subset of the nodes contained in the node-set NS passed <a name="line.178"></a>
<FONT color="green">179</FONT> * as the first argument. Specifically, it selects a node N if there is no node in NS that has <a name="line.179"></a>
<FONT color="green">180</FONT> * the same string value as N, and that precedes N in document order. <a name="line.180"></a>
<FONT color="green">181</FONT> * <a name="line.181"></a>
<FONT color="green">182</FONT> * @param nl NodeList for the node-set.<a name="line.182"></a>
<FONT color="green">183</FONT> * @return a NodeList with nodes from nl containing distinct string values.<a name="line.183"></a>
<FONT color="green">184</FONT> * In other words, if more than one node in nl contains the same string value,<a name="line.184"></a>
<FONT color="green">185</FONT> * only include the first such node found.<a name="line.185"></a>
<FONT color="green">186</FONT> * <a name="line.186"></a>
<FONT color="green">187</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.187"></a>
<FONT color="green">188</FONT> */<a name="line.188"></a>
<FONT color="green">189</FONT> public static NodeList distinct(NodeList nl)<a name="line.189"></a>
<FONT color="green">190</FONT> {<a name="line.190"></a>
<FONT color="green">191</FONT> NodeSet dist = new NodeSet();<a name="line.191"></a>
<FONT color="green">192</FONT> dist.setShouldCacheNodes(true);<a name="line.192"></a>
<FONT color="green">193</FONT> <a name="line.193"></a>
<FONT color="green">194</FONT> Map stringTable = new HashMap();<a name="line.194"></a>
<FONT color="green">195</FONT> <a name="line.195"></a>
<FONT color="green">196</FONT> for (int i = 0; i &lt; nl.getLength(); i++)<a name="line.196"></a>
<FONT color="green">197</FONT> {<a name="line.197"></a>
<FONT color="green">198</FONT> Node currNode = nl.item(i);<a name="line.198"></a>
<FONT color="green">199</FONT> String key = toString(currNode);<a name="line.199"></a>
<FONT color="green">200</FONT> <a name="line.200"></a>
<FONT color="green">201</FONT> if (key == null)<a name="line.201"></a>
<FONT color="green">202</FONT> dist.addElement(currNode);<a name="line.202"></a>
<FONT color="green">203</FONT> else if (!stringTable.containsKey(key))<a name="line.203"></a>
<FONT color="green">204</FONT> {<a name="line.204"></a>
<FONT color="green">205</FONT> stringTable.put(key, currNode);<a name="line.205"></a>
<FONT color="green">206</FONT> dist.addElement(currNode); <a name="line.206"></a>
<FONT color="green">207</FONT> }<a name="line.207"></a>
<FONT color="green">208</FONT> }<a name="line.208"></a>
<FONT color="green">209</FONT> <a name="line.209"></a>
<FONT color="green">210</FONT> return dist;<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> /**<a name="line.213"></a>
<FONT color="green">214</FONT> * The set:has-same-node function returns true if the node set passed as the first argument shares <a name="line.214"></a>
<FONT color="green">215</FONT> * any nodes with the node set passed as the second argument. If there are no nodes that are in both<a name="line.215"></a>
<FONT color="green">216</FONT> * node sets, then it returns false. <a name="line.216"></a>
<FONT color="green">217</FONT> * <a name="line.217"></a>
<FONT color="green">218</FONT> * The Xalan extensions MethodResolver converts 'has-same-node' to 'hasSameNode'.<a name="line.218"></a>
<FONT color="green">219</FONT> * <a name="line.219"></a>
<FONT color="green">220</FONT> * Note: Not to be confused with hasSameNodes in the Xalan namespace, which returns true if<a name="line.220"></a>
<FONT color="green">221</FONT> * the two node sets contain the exactly the same nodes (perhaps in a different order), <a name="line.221"></a>
<FONT color="green">222</FONT> * otherwise false.<a name="line.222"></a>
<FONT color="green">223</FONT> * <a name="line.223"></a>
<FONT color="green">224</FONT> * @see &lt;a href="http://www.exslt.org/"&gt;EXSLT&lt;/a&gt;<a name="line.224"></a>
<FONT color="green">225</FONT> */<a name="line.225"></a>
<FONT color="green">226</FONT> public static boolean hasSameNode(NodeList nl1, NodeList nl2)<a name="line.226"></a>
<FONT color="green">227</FONT> {<a name="line.227"></a>
<FONT color="green">228</FONT> <a name="line.228"></a>
<FONT color="green">229</FONT> NodeSet ns1 = new NodeSet(nl1);<a name="line.229"></a>
<FONT color="green">230</FONT> NodeSet ns2 = new NodeSet(nl2);<a name="line.230"></a>
<FONT color="green">231</FONT> <a name="line.231"></a>
<FONT color="green">232</FONT> for (int i = 0; i &lt; ns1.getLength(); i++)<a name="line.232"></a>
<FONT color="green">233</FONT> {<a name="line.233"></a>
<FONT color="green">234</FONT> if (ns2.contains(ns1.elementAt(i)))<a name="line.234"></a>
<FONT color="green">235</FONT> return true;<a name="line.235"></a>
<FONT color="green">236</FONT> }<a name="line.236"></a>
<FONT color="green">237</FONT> return false;<a name="line.237"></a>
<FONT color="green">238</FONT> }<a name="line.238"></a>
<FONT color="green">239</FONT> <a name="line.239"></a>
<FONT color="green">240</FONT> }<a name="line.240"></a>
</PRE>
</BODY>
</HTML>