blob: 981c1b32c50cf1e36596bef021b989e9c1149181 [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: NodeSortRecord.java 468651 2006-10-28 07:04:25Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> package org.apache.xalan.xsltc.dom;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.text.CollationKey;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.text.Collator;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.Locale;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xalan.xsltc.CollatorFactory;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xalan.xsltc.DOM;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xalan.xsltc.TransletException;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.xalan.xsltc.runtime.AbstractTranslet;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.xml.utils.StringComparable;<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> /**<a name="line.34"></a>
<FONT color="green">035</FONT> * Base class for sort records containing application specific sort keys <a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> public abstract class NodeSortRecord {<a name="line.37"></a>
<FONT color="green">038</FONT> public static final int COMPARE_STRING = 0;<a name="line.38"></a>
<FONT color="green">039</FONT> public static final int COMPARE_NUMERIC = 1;<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> public static final int COMPARE_ASCENDING = 0;<a name="line.41"></a>
<FONT color="green">042</FONT> public static final int COMPARE_DESCENDING = 1;<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> * A reference to a collator. May be updated by subclass if the stylesheet<a name="line.45"></a>
<FONT color="green">046</FONT> * specifies a different language (will be updated iff _locale is updated).<a name="line.46"></a>
<FONT color="green">047</FONT> * @deprecated This field continues to exist for binary compatibility.<a name="line.47"></a>
<FONT color="green">048</FONT> * New code should not refer to it.<a name="line.48"></a>
<FONT color="green">049</FONT> */<a name="line.49"></a>
<FONT color="green">050</FONT> private static final Collator DEFAULT_COLLATOR = Collator.getInstance();<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> /**<a name="line.52"></a>
<FONT color="green">053</FONT> * A reference to the first Collator<a name="line.53"></a>
<FONT color="green">054</FONT> * @deprecated This field continues to exist for binary compatibility.<a name="line.54"></a>
<FONT color="green">055</FONT> * New code should not refer to it.<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> protected Collator _collator = DEFAULT_COLLATOR;<a name="line.57"></a>
<FONT color="green">058</FONT> protected Collator[] _collators;<a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> /**<a name="line.60"></a>
<FONT color="green">061</FONT> * A locale field that might be set by an instance of a subclass.<a name="line.61"></a>
<FONT color="green">062</FONT> * @deprecated This field continues to exist for binary compatibility.<a name="line.62"></a>
<FONT color="green">063</FONT> * New code should not refer to it.<a name="line.63"></a>
<FONT color="green">064</FONT> */<a name="line.64"></a>
<FONT color="green">065</FONT> protected Locale _locale;<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> protected CollatorFactory _collatorFactory;<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> protected SortSettings _settings;<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> private DOM _dom = null;<a name="line.71"></a>
<FONT color="green">072</FONT> private int _node; // The position in the current iterator<a name="line.72"></a>
<FONT color="green">073</FONT> private int _last = 0; // Number of nodes in the current iterator<a name="line.73"></a>
<FONT color="green">074</FONT> private int _scanned = 0; // Number of key levels extracted from DOM<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> private Object[] _values; // Contains Comparable objects<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> * This constructor is run by a call to ClassLoader in the<a name="line.79"></a>
<FONT color="green">080</FONT> * makeNodeSortRecord method in the NodeSortRecordFactory class. Since we<a name="line.80"></a>
<FONT color="green">081</FONT> * cannot pass any parameters to the constructor in that case we just set<a name="line.81"></a>
<FONT color="green">082</FONT> * the default values here and wait for new values through initialize().<a name="line.82"></a>
<FONT color="green">083</FONT> */ <a name="line.83"></a>
<FONT color="green">084</FONT> public NodeSortRecord(int node) {<a name="line.84"></a>
<FONT color="green">085</FONT> _node = node;<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> public NodeSortRecord() {<a name="line.88"></a>
<FONT color="green">089</FONT> this(0);<a name="line.89"></a>
<FONT color="green">090</FONT> }<a name="line.90"></a>
<FONT color="green">091</FONT> <a name="line.91"></a>
<FONT color="green">092</FONT> /**<a name="line.92"></a>
<FONT color="green">093</FONT> * This method allows the caller to set the values that could not be passed<a name="line.93"></a>
<FONT color="green">094</FONT> * to the default constructor.<a name="line.94"></a>
<FONT color="green">095</FONT> */<a name="line.95"></a>
<FONT color="green">096</FONT> public final void initialize(int node, int last, DOM dom,<a name="line.96"></a>
<FONT color="green">097</FONT> SortSettings settings)<a name="line.97"></a>
<FONT color="green">098</FONT> throws TransletException<a name="line.98"></a>
<FONT color="green">099</FONT> {<a name="line.99"></a>
<FONT color="green">100</FONT> _dom = dom;<a name="line.100"></a>
<FONT color="green">101</FONT> _node = node;<a name="line.101"></a>
<FONT color="green">102</FONT> _last = last;<a name="line.102"></a>
<FONT color="green">103</FONT> _settings = settings;<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> int levels = settings.getSortOrders().length;<a name="line.105"></a>
<FONT color="green">106</FONT> _values = new Object[levels];<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> // -- W. Eliot Kimber (eliot@isogen.com)<a name="line.108"></a>
<FONT color="green">109</FONT> String colFactClassname = <a name="line.109"></a>
<FONT color="green">110</FONT> System.getProperty("org.apache.xalan.xsltc.COLLATOR_FACTORY");<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> if (colFactClassname != null) {<a name="line.112"></a>
<FONT color="green">113</FONT> try {<a name="line.113"></a>
<FONT color="green">114</FONT> Object candObj = ObjectFactory.findProviderClass(<a name="line.114"></a>
<FONT color="green">115</FONT> colFactClassname, ObjectFactory.findClassLoader(), true);<a name="line.115"></a>
<FONT color="green">116</FONT> _collatorFactory = (CollatorFactory)candObj;<a name="line.116"></a>
<FONT color="green">117</FONT> } catch (ClassNotFoundException e) {<a name="line.117"></a>
<FONT color="green">118</FONT> throw new TransletException(e);<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> Locale[] locales = settings.getLocales();<a name="line.120"></a>
<FONT color="green">121</FONT> _collators = new Collator[levels];<a name="line.121"></a>
<FONT color="green">122</FONT> for (int i = 0; i &lt; levels; i++){<a name="line.122"></a>
<FONT color="green">123</FONT> _collators[i] = _collatorFactory.getCollator(locales[i]);<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
<FONT color="green">125</FONT> _collator = _collators[0];<a name="line.125"></a>
<FONT color="green">126</FONT> } else {<a name="line.126"></a>
<FONT color="green">127</FONT> _collators = settings.getCollators();<a name="line.127"></a>
<FONT color="green">128</FONT> _collator = _collators[0];<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> /**<a name="line.132"></a>
<FONT color="green">133</FONT> * Returns the node for this sort object<a name="line.133"></a>
<FONT color="green">134</FONT> */<a name="line.134"></a>
<FONT color="green">135</FONT> public final int getNode() {<a name="line.135"></a>
<FONT color="green">136</FONT> return _node;<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
<FONT color="green">138</FONT> <a name="line.138"></a>
<FONT color="green">139</FONT> /**<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> public final int compareDocOrder(NodeSortRecord other) {<a name="line.142"></a>
<FONT color="green">143</FONT> return _node - other._node;<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 string or numeric value of a specific level key for this sort<a name="line.147"></a>
<FONT color="green">148</FONT> * element. The value is extracted from the DOM if it is not already in<a name="line.148"></a>
<FONT color="green">149</FONT> * our sort key vector.<a name="line.149"></a>
<FONT color="green">150</FONT> */<a name="line.150"></a>
<FONT color="green">151</FONT> private final Comparable stringValue(int level) {<a name="line.151"></a>
<FONT color="green">152</FONT> // Get value from our array if possible<a name="line.152"></a>
<FONT color="green">153</FONT> if (_scanned &lt;= level) {<a name="line.153"></a>
<FONT color="green">154</FONT> AbstractTranslet translet = _settings.getTranslet();<a name="line.154"></a>
<FONT color="green">155</FONT> Locale[] locales = _settings.getLocales();<a name="line.155"></a>
<FONT color="green">156</FONT> String[] caseOrder = _settings.getCaseOrders();<a name="line.156"></a>
<FONT color="green">157</FONT> <a name="line.157"></a>
<FONT color="green">158</FONT> // Get value from DOM if accessed for the first time<a name="line.158"></a>
<FONT color="green">159</FONT> final String str = extractValueFromDOM(_dom, _node, level,<a name="line.159"></a>
<FONT color="green">160</FONT> translet, _last);<a name="line.160"></a>
<FONT color="green">161</FONT> final Comparable key =<a name="line.161"></a>
<FONT color="green">162</FONT> StringComparable.getComparator(str, locales[level],<a name="line.162"></a>
<FONT color="green">163</FONT> _collators[level],<a name="line.163"></a>
<FONT color="green">164</FONT> caseOrder[level]);<a name="line.164"></a>
<FONT color="green">165</FONT> _values[_scanned++] = key;<a name="line.165"></a>
<FONT color="green">166</FONT> return(key);<a name="line.166"></a>
<FONT color="green">167</FONT> }<a name="line.167"></a>
<FONT color="green">168</FONT> return((Comparable)_values[level]);<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> private final Double numericValue(int level) {<a name="line.171"></a>
<FONT color="green">172</FONT> // Get value from our vector if possible<a name="line.172"></a>
<FONT color="green">173</FONT> if (_scanned &lt;= level) {<a name="line.173"></a>
<FONT color="green">174</FONT> AbstractTranslet translet = _settings.getTranslet();<a name="line.174"></a>
<FONT color="green">175</FONT> <a name="line.175"></a>
<FONT color="green">176</FONT> // Get value from DOM if accessed for the first time<a name="line.176"></a>
<FONT color="green">177</FONT> final String str = extractValueFromDOM(_dom, _node, level,<a name="line.177"></a>
<FONT color="green">178</FONT> translet, _last);<a name="line.178"></a>
<FONT color="green">179</FONT> Double num;<a name="line.179"></a>
<FONT color="green">180</FONT> try {<a name="line.180"></a>
<FONT color="green">181</FONT> num = new Double(str);<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> // Treat number as NaN if it cannot be parsed as a double<a name="line.183"></a>
<FONT color="green">184</FONT> catch (NumberFormatException e) {<a name="line.184"></a>
<FONT color="green">185</FONT> num = new Double(Double.NEGATIVE_INFINITY);<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> _values[_scanned++] = num;<a name="line.187"></a>
<FONT color="green">188</FONT> return(num);<a name="line.188"></a>
<FONT color="green">189</FONT> }<a name="line.189"></a>
<FONT color="green">190</FONT> return((Double)_values[level]);<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> * Compare this sort element to another. The first level is checked first,<a name="line.194"></a>
<FONT color="green">195</FONT> * and we proceed to the next level only if the first level keys are<a name="line.195"></a>
<FONT color="green">196</FONT> * identical (and so the key values may not even be extracted from the DOM)<a name="line.196"></a>
<FONT color="green">197</FONT> *<a name="line.197"></a>
<FONT color="green">198</FONT> * !!!!MUST OPTIMISE - THIS IS REALLY, REALLY SLOW!!!!<a name="line.198"></a>
<FONT color="green">199</FONT> */<a name="line.199"></a>
<FONT color="green">200</FONT> public int compareTo(NodeSortRecord other) {<a name="line.200"></a>
<FONT color="green">201</FONT> int cmp, level;<a name="line.201"></a>
<FONT color="green">202</FONT> int[] sortOrder = _settings.getSortOrders();<a name="line.202"></a>
<FONT color="green">203</FONT> int levels = _settings.getSortOrders().length;<a name="line.203"></a>
<FONT color="green">204</FONT> int[] compareTypes = _settings.getTypes();<a name="line.204"></a>
<FONT color="green">205</FONT> <a name="line.205"></a>
<FONT color="green">206</FONT> for (level = 0; level &lt; levels; level++) {<a name="line.206"></a>
<FONT color="green">207</FONT> // Compare the two nodes either as numeric or text values<a name="line.207"></a>
<FONT color="green">208</FONT> if (compareTypes[level] == COMPARE_NUMERIC) {<a name="line.208"></a>
<FONT color="green">209</FONT> final Double our = numericValue(level);<a name="line.209"></a>
<FONT color="green">210</FONT> final Double their = other.numericValue(level);<a name="line.210"></a>
<FONT color="green">211</FONT> cmp = our.compareTo(their);<a name="line.211"></a>
<FONT color="green">212</FONT> }<a name="line.212"></a>
<FONT color="green">213</FONT> else {<a name="line.213"></a>
<FONT color="green">214</FONT> final Comparable our = stringValue(level);<a name="line.214"></a>
<FONT color="green">215</FONT> final Comparable their = other.stringValue(level);<a name="line.215"></a>
<FONT color="green">216</FONT> cmp = our.compareTo(their);<a name="line.216"></a>
<FONT color="green">217</FONT> }<a name="line.217"></a>
<FONT color="green">218</FONT> <a name="line.218"></a>
<FONT color="green">219</FONT> // Return inverse compare value if inverse sort order<a name="line.219"></a>
<FONT color="green">220</FONT> if (cmp != 0) {<a name="line.220"></a>
<FONT color="green">221</FONT> return sortOrder[level] == COMPARE_DESCENDING ? 0 - cmp : cmp;<a name="line.221"></a>
<FONT color="green">222</FONT> }<a name="line.222"></a>
<FONT color="green">223</FONT> }<a name="line.223"></a>
<FONT color="green">224</FONT> // Compare based on document order if all sort keys are equal<a name="line.224"></a>
<FONT color="green">225</FONT> return(_node - other._node);<a name="line.225"></a>
<FONT color="green">226</FONT> }<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> * Returns the array of Collators used for text comparisons in this object.<a name="line.229"></a>
<FONT color="green">230</FONT> * May be overridden by inheriting classes<a name="line.230"></a>
<FONT color="green">231</FONT> */<a name="line.231"></a>
<FONT color="green">232</FONT> public Collator[] getCollator() {<a name="line.232"></a>
<FONT color="green">233</FONT> return _collators;<a name="line.233"></a>
<FONT color="green">234</FONT> }<a name="line.234"></a>
<FONT color="green">235</FONT> <a name="line.235"></a>
<FONT color="green">236</FONT> /**<a name="line.236"></a>
<FONT color="green">237</FONT> * Extract the sort value for a level of this key.<a name="line.237"></a>
<FONT color="green">238</FONT> */<a name="line.238"></a>
<FONT color="green">239</FONT> public abstract String extractValueFromDOM(DOM dom, int current, int level,<a name="line.239"></a>
<FONT color="green">240</FONT> AbstractTranslet translet,<a name="line.240"></a>
<FONT color="green">241</FONT> int last);<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>
</PRE>
</BODY>
</HTML>