Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xalan / xsltc / dom / SortSettings.html
blob: c0c53c116d8209791efbc25341485494a60d25dc [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: SortSettings.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.Collator;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.Locale;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xalan.xsltc.runtime.AbstractTranslet;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Class for carrying settings that are to be used for a particular set<a name="line.30"></a>
<FONT color="green">031</FONT> * of &lt;code&gt;xsl:sort&lt;/code&gt; elements.<a name="line.31"></a>
<FONT color="green">032</FONT> */<a name="line.32"></a>
<FONT color="green">033</FONT> final class SortSettings {<a name="line.33"></a>
<FONT color="green">034</FONT> /**<a name="line.34"></a>
<FONT color="green">035</FONT> * A reference to the translet object for the transformation.<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> private AbstractTranslet _translet;<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * The sort order (ascending or descending) for each level of<a name="line.40"></a>
<FONT color="green">041</FONT> * &lt;code&gt;xsl:sort&lt;/code&gt;<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> private int[] _sortOrders;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * The type of comparison (text or number) for each level of<a name="line.46"></a>
<FONT color="green">047</FONT> * &lt;code&gt;xsl:sort&lt;/code&gt;<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> private int[] _types;<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * The Locale for each level of &lt;code&gt;xsl:sort&lt;/code&gt;, based on any lang<a name="line.52"></a>
<FONT color="green">053</FONT> * attribute or the default Locale.<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> private Locale[] _locales;<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * The Collator object in effect for each level of &lt;code&gt;xsl:sort&lt;/code&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> private Collator[] _collators;<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> /**<a name="line.62"></a>
<FONT color="green">063</FONT> * Case ordering for each level of &lt;code&gt;xsl:sort&lt;/code&gt;.<a name="line.63"></a>
<FONT color="green">064</FONT> */<a name="line.64"></a>
<FONT color="green">065</FONT> private String[] _caseOrders;<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> /**<a name="line.67"></a>
<FONT color="green">068</FONT> * Create an instance of &lt;code&gt;SortSettings&lt;/code&gt;.<a name="line.68"></a>
<FONT color="green">069</FONT> * @param translet {@link org.apache.xalan.xsltc.runtime.AbstractTranslet}<a name="line.69"></a>
<FONT color="green">070</FONT> * object for the transformation<a name="line.70"></a>
<FONT color="green">071</FONT> * @param sortOrders an array specifying the sort order for each sort level<a name="line.71"></a>
<FONT color="green">072</FONT> * @param types an array specifying the type of comparison for each sort<a name="line.72"></a>
<FONT color="green">073</FONT> * level (text or number)<a name="line.73"></a>
<FONT color="green">074</FONT> * @param locales an array specifying the Locale for each sort level<a name="line.74"></a>
<FONT color="green">075</FONT> * @param collators an array specifying the Collation in effect for each<a name="line.75"></a>
<FONT color="green">076</FONT> * sort level<a name="line.76"></a>
<FONT color="green">077</FONT> * @param caseOrders an array specifying whether upper-case, lower-case<a name="line.77"></a>
<FONT color="green">078</FONT> * or neither is to take precedence for each sort level.<a name="line.78"></a>
<FONT color="green">079</FONT> * The value of each element is equal to one of<a name="line.79"></a>
<FONT color="green">080</FONT> * &lt;code&gt;"upper-first", "lower-first", or ""&lt;/code&gt;.<a name="line.80"></a>
<FONT color="green">081</FONT> */<a name="line.81"></a>
<FONT color="green">082</FONT> SortSettings(AbstractTranslet translet, int[] sortOrders, int[] types,<a name="line.82"></a>
<FONT color="green">083</FONT> Locale[] locales, Collator[] collators, String[] caseOrders) {<a name="line.83"></a>
<FONT color="green">084</FONT> _translet = translet;<a name="line.84"></a>
<FONT color="green">085</FONT> _sortOrders = sortOrders;<a name="line.85"></a>
<FONT color="green">086</FONT> _types = types;<a name="line.86"></a>
<FONT color="green">087</FONT> _locales = locales;<a name="line.87"></a>
<FONT color="green">088</FONT> _collators = collators;<a name="line.88"></a>
<FONT color="green">089</FONT> _caseOrders = caseOrders;<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> * @return A reference to the translet object for the transformation.<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> AbstractTranslet getTranslet() {<a name="line.95"></a>
<FONT color="green">096</FONT> return _translet;<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> /**<a name="line.99"></a>
<FONT color="green">100</FONT> * @return An array containing the sort order (ascending or descending)<a name="line.100"></a>
<FONT color="green">101</FONT> * for each level of &lt;code&gt;xsl:sort&lt;/code&gt;<a name="line.101"></a>
<FONT color="green">102</FONT> */<a name="line.102"></a>
<FONT color="green">103</FONT> int[] getSortOrders() {<a name="line.103"></a>
<FONT color="green">104</FONT> return _sortOrders;<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> * @return An array containing the type of comparison (text or number)<a name="line.108"></a>
<FONT color="green">109</FONT> * to perform for each level of &lt;code&gt;xsl:sort&lt;/code&gt;<a name="line.109"></a>
<FONT color="green">110</FONT> */<a name="line.110"></a>
<FONT color="green">111</FONT> int[] getTypes() {<a name="line.111"></a>
<FONT color="green">112</FONT> return _types;<a name="line.112"></a>
<FONT color="green">113</FONT> }<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> * @return An array containing the Locale object in effect for each level<a name="line.116"></a>
<FONT color="green">117</FONT> * of &lt;code&gt;xsl:sort&lt;/code&gt;<a name="line.117"></a>
<FONT color="green">118</FONT> */<a name="line.118"></a>
<FONT color="green">119</FONT> Locale[] getLocales() {<a name="line.119"></a>
<FONT color="green">120</FONT> return _locales;<a name="line.120"></a>
<FONT color="green">121</FONT> }<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> /**<a name="line.123"></a>
<FONT color="green">124</FONT> * @return An array containing the Collator object in effect for each level<a name="line.124"></a>
<FONT color="green">125</FONT> * of &lt;code&gt;xsl:sort&lt;/code&gt;<a name="line.125"></a>
<FONT color="green">126</FONT> */<a name="line.126"></a>
<FONT color="green">127</FONT> Collator[] getCollators() {<a name="line.127"></a>
<FONT color="green">128</FONT> return _collators;<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> * @return An array specifying the case ordering for each level of<a name="line.132"></a>
<FONT color="green">133</FONT> * &lt;code&gt;xsl:sort&lt;/code&gt;.<a name="line.133"></a>
<FONT color="green">134</FONT> */<a name="line.134"></a>
<FONT color="green">135</FONT> String[] getCaseOrders() {<a name="line.135"></a>
<FONT color="green">136</FONT> return _caseOrders;<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>
</PRE>
</BODY>
</HTML>