RuleBasedCollator.java revision 9b354e75f2418e54638e02d153216660b67d01b8
1adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/* 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 7adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 8adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project// BEGIN android-note 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project// The icu implementation used was changed from icu4j to icu4jni. 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project// END android-note 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage java.text; 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport org.apache.harmony.text.internal.nls.Messages; 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * A concrete implementation class for {@code Collation}. 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator} has the following restrictions for efficiency 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (other subclasses may be used for more complex languages): 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ol> 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li> If a French secondary ordering is specified it applies to the whole 33adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * collator object.</li> 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li> All non-mentioned Unicode characters are at the end of the collation 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * order.</li> 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li> If a character is not located in the {@code RuleBasedCollator}, the 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * default Unicode Collation Algorithm (UCA) rulebased table is automatically 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * searched as a backup.</li> 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ol> 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The collation table is composed of a list of collation rules, where each rule 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * is of three forms: 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 449b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 45adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <modifier> 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <relation> <text-argument> 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <reset> <text-argument> 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 509b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 51adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The rule elements are defined as follows: 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ul type="disc"> 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li><strong>Text-Argument</strong>: A text-argument is any sequence of 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * characters, excluding special characters (that is, common whitespace 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * characters [0009-000D, 0020] and rule syntax characters [0021-002F, 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 003A-0040, 005B-0060, 007B-007E]). If those characters are desired, you can 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * put them in single quotes (for example, use '&' for ampersand). Note that 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * unquoted white space characters are ignored; for example, {@code b c} is 61adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * treated as {@code bc}.</li> 62adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li><strong>Modifier</strong>: There is a single modifier which is used to 63adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specify that all accents (secondary differences) are backwards. 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 65adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * '@' : Indicates that accents are sorted backwards, as in French. 66adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </li> 67adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li><strong>Relation</strong>: The relations are the following: 68adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ul type=square> 69adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>'<' : Greater, as a letter difference (primary) 70adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>';' : Greater, as an accent difference (secondary) 71adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>',' : Greater, as a case difference (tertiary) 72adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>'=' : Equal 73adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ul> 74adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </li> 75adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li><strong>Reset</strong>: There is a single reset which is used primarily 76adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * for contractions and expansions, but which can also be used to add a 77adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * modification at the end of a set of rules. 78adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 79adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * '&' : Indicates that the next rule follows the position to where the reset 80adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * text-argument would be sorted. 81adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </li> 82adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ul> 83adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 84adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * This sounds more complicated than it is in practice. For example, the 85adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * following are equivalent ways of expressing the same thing: 86adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 879b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 88adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 89adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < b < c 90adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < b & b < c 91adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < c & a < b 92adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 939b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 94adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 95adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 96adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Notice that the order is important, as the subsequent item goes immediately 97adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * after the text-argument. The following are not equivalent: 98adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 999b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 100adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 101adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < b & a < c 102adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < c & a < b 103adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 1049b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 106adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 107adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Either the text-argument must already be present in the sequence, or some 108adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initial substring of the text-argument must be present. For example 109adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "a < b & ae < e"} is valid since "a" is present in the sequence before 110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * "ae" is reset. In this latter case, "ae" is not entered and treated as a 111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * single character; instead, "e" is sorted as if it were expanded to two 112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * characters: "a" followed by an "e". This difference appears in natural 113adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * languages: in traditional Spanish "ch" is treated as if it contracts to a 114adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * single character (expressed as {@code "c < ch < d"}), while in traditional 115adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * German a-umlaut is treated as if it expands to two characters (expressed as 116adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "a,A < b,B ... & ae;\u00e3 & AE;\u00c3"}, where \u00e3 and \u00c3 117adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * are the escape sequences for a-umlaut). 118adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Ignorable Characters</h4> 119adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 120adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * For ignorable characters, the first rule must start with a relation (the 121adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * examples we have used above are really fragments; {@code "a < b"} really 122adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * should be {@code "< a < b"}). If, however, the first relation is not 123adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "<"}, then all text-arguments up to the first {@code "<"} are 124adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * ignorable. For example, {@code ", - < a < b"} makes {@code "-"} an ignorable 125adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * character. 126adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Normalization and Accents</h4> 127adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 128adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator} automatically processes its rule table to include 129adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * both pre-composed and combining-character versions of accented characters. 130adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Even if the provided rule string contains only base characters and separate 131adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * combining accent characters, the pre-composed accented characters matching 132adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * all canonical combinations of characters from the rule string will be entered 133adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * in the table. 134adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 135adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * This allows you to use a RuleBasedCollator to compare accented strings even 136adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * when the collator is set to NO_DECOMPOSITION. However, if the strings to be 137adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * collated contain combining sequences that may not be in canonical order, you 138adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * should set the collator to CANONICAL_DECOMPOSITION to enable sorting of 139adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * combining sequences. For more information, see <a 140adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * href="http://www.aw.com/devpress">The Unicode Standard, Version 3.0</a>. 141adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Errors</h4> 142adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 143adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The following rules are not valid: 144adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ul type="disc"> 145adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>A text-argument contains unquoted punctuation symbols, for example 146adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "a < b-c < d"}.</li> 147adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>A relation or reset character is not followed by a text-argument, for 148adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * example {@code "a < , b"}.</li> 149adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>A reset where the text-argument (or an initial substring of the 150adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * text-argument) is not already in the sequence or allocated in the default UCA 151adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * table, for example {@code "a < b & e < f"}.</li> 152adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ul> 153adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 154adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If you produce one of these errors, {@code RuleBasedCollator} throws a 155adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code ParseException}. 156adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Examples</h4> 157adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 158adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Normally, to create a rule-based collator object, you will use 159adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code Collator}'s factory method {@code getInstance}. However, to create a 160adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * rule-based collator object with specialized rules tailored to your needs, you 161adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * construct the {@code RuleBasedCollator} with the rules contained in a 162adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code String} object. For example: 163adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 1649b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 165adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 166adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String Simple = "< a < b < c < d"; 1679b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 168adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator mySimple = new RuleBasedCollator(Simple); 169adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 1709b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 171adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 172adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 173adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Or: 174adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 1759b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 176adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 177adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String Norwegian = "< a,A< b,B< c,C< d,D< e,E< f,F< g,G< h,H< i,I" 1789b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * + "< j,J< k,K< l,L< m,M< n,N< o,O< p,P< q,Q< r,R" 179adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * + "< s,S< t,T< u,U< v,V< w,W< x,X< y,Y< z,Z" 1809b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * + "< \u00E5=a\u030A,\u00C5=A\u030A" 181adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * + ";aa,AA< \u00E6,\u00C6< \u00F8,\u00D8"; 1829b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 183adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator myNorwegian = new RuleBasedCollator(Norwegian); 184adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 1859b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 186adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 187adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 188adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Combining {@code Collator}s is as simple as concatenating strings. Here is 189adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * an example that combines two {@code Collator}s from two different locales: 190adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 1919b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 192adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 193adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Create an en_US Collator object 194adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator en_USCollator = (RuleBasedCollator)Collator 195adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * .getInstance(new Locale("en", "US", "")); 1969b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 197adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Create a da_DK Collator object 198adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator da_DKCollator = (RuleBasedCollator)Collator 199adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * .getInstance(new Locale("da", "DK", "")); 2009b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 201adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Combine the two collators 202adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // First, get the collation rules from en_USCollator 203adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String en_USRules = en_USCollator.getRules(); 2049b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 205adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Second, get the collation rules from da_DKCollator 206adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String da_DKRules = da_DKCollator.getRules(); 2079b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 208adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator newCollator = new RuleBasedCollator(en_USRules + da_DKRules); 209adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // newCollator has the combined rules 210adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2119b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 212adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 213adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 214adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The next example shows to make changes on an existing table to create a new 215adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code Collator} object. For example, add {@code "& C < ch, cH, Ch, CH"} to 216adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code en_USCollator} object to create your own: 217adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 2189b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 219adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 220adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Create a new Collator object with additional rules 221adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String addRules = "& C < ch, cH, Ch, CH"; 2229b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 223adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator myCollator = new RuleBasedCollator(en_USCollator + addRules); 224adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // myCollator contains the new rules 225adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2269b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 227adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 228adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 229adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The following example demonstrates how to change the order of non-spacing 230adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * accents: 231adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 2329b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 233adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 234adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // old rule 235adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String oldRules = "= \u00a8 ; \u00af ; \u00bf" + "< a , A ; ae, AE ; \u00e6 , \u00c6" 236adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * + "< b , B < c, C < e, E & C < d, D"; 2379b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 238adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // change the order of accent characters 239adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String addOn = "& \u00bf ; \u00af ; \u00a8;"; 2409b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 241adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator myCollator = new RuleBasedCollator(oldRules + addOn); 242adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2439b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 244adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 245adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 246adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The last example shows how to put new primary ordering in before the default 247adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * setting. For example, in the Japanese {@code Collator}, you can either sort 248adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * English characters before or after Japanese characters: 249adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 2509b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 251adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 252adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // get en_US Collator rules 253adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator en_USCollator = (RuleBasedCollator) 254adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Collator.getInstance(Locale.US); 2559b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 256adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // add a few Japanese character to sort before English characters 257adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // suppose the last character before the first base letter 'a' in 258adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // the English collation rule is \u30A2 259adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String jaString = "& \u30A2 , \u30FC < \u30C8"; 2609b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 2619b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * RuleBasedCollator myJapaneseCollator = 262adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * new RuleBasedCollator(en_USCollator.getRules() + jaString); 263adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2649b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 265adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 266adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 267adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic class RuleBasedCollator extends Collator { 268adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 269adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project RuleBasedCollator(com.ibm.icu4jni.text.Collator wrapper) { 270adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project super(wrapper); 271adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 272adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 273adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 274adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code RuleBasedCollator} using the 275adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specified {@code rules}. The {@code rules} are usually either 276adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * hand-written based on the {@link RuleBasedCollator class description} or 277adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the result of a former {@link #getRules()} call. 278adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 279adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Note that the {@code rules} are actually interpreted as a delta to the 280adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * standard Unicode Collation Algorithm (UCA). Hence, an empty {@code rules} 281adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * string results in the default UCA rules being applied. This differs 282adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * slightly from other implementations which work with full {@code rules} 283adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specifications and may result in different behavior. 284adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 285adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param rules 286adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the collation rules. 287adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 288adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code rules} is {@code null}. 289adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws ParseException 290adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code rules} contains rules with invalid collation rule 291adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * syntax. 292adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 293adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public RuleBasedCollator(String rules) throws ParseException { 294adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (rules == null) { 295adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw new NullPointerException(); 296adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 297adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // BEGIN android-removed 298adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // if (rules.length() == 0) { 299adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // // text.06=Build rules empty 300adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // throw new ParseException(Messages.getString("text.06"), 0); //$NON-NLS-1$ 301adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // } 302adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // END andriod-removed 303adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 304adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project try { 305adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.icuColl = new com.ibm.icu4jni.text.RuleBasedCollator(rules); 306adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // BEGIN android-added 307adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.icuColl.setDecomposition( 308adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project com.ibm.icu4jni.text.Collator.CANONICAL_DECOMPOSITION); 309adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // END android-added 310adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } catch (Exception e) { 311adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (e instanceof ParseException) { 312adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw (ParseException) e; 313adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 314adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /* 315adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * -1 means it's not a ParseException. Maybe IOException thrown when 316adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * an error occured while reading internal data. 317adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 318adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw new ParseException(e.getMessage(), -1); 319adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 320adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 321adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 322adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 323adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Obtains a {@code CollationElementIterator} for the given 324adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code CharacterIterator}. The source iterator's integrity will be 325adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * preserved since a new copy will be created for use. 326adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 327adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 328adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the source character iterator. 329adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a {@code CollationElementIterator} for {@code source}. 330adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 331adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public CollationElementIterator getCollationElementIterator( 332adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project CharacterIterator source) { 333adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (source == null) { 334adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw new NullPointerException(); 335adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 336adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return new CollationElementIterator( 337adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ((com.ibm.icu4jni.text.RuleBasedCollator) this.icuColl) 338adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .getCollationElementIterator(source)); 339adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 340adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 341adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 342adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Obtains a {@code CollationElementIterator} for the given string. 343adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 344adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 345adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the source string. 346adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code CollationElementIterator} for {@code source}. 347adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 348adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public CollationElementIterator getCollationElementIterator(String source) { 349adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (source == null) { 350adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw new NullPointerException(); 351adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 352adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return new CollationElementIterator( 353adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ((com.ibm.icu4jni.text.RuleBasedCollator) this.icuColl) 354adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .getCollationElementIterator(source)); 355adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 356adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 357adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 358adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the collation rules of this collator. These {@code rules} can be 3595d287a9d9768195f53e244414b465ec4a6f72625The Android Open Source Project * fed into the {@code RuleBasedCollator(String)} constructor. 360adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 361adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Note that the {@code rules} are actually interpreted as a delta to the 362adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * standard Unicode Collation Algorithm (UCA). Hence, an empty {@code rules} 363adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * string results in the default UCA rules being applied. This differs 364adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * slightly from other implementations which work with full {@code rules} 365adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specifications and may result in different behavior. 366adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 367adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the collation rules. 368adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 369adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String getRules() { 370adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return ((com.ibm.icu4jni.text.RuleBasedCollator) this.icuColl).getRules(); 371adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 372adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 373adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 374adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new collator with the same collation rules, decomposition mode and 375adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * strength value as this collator. 376adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 377adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a shallow copy of this collator. 378adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see java.lang.Cloneable 379adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 380adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 381adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public Object clone() { 382adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project RuleBasedCollator clone = (RuleBasedCollator) super.clone(); 383adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return clone; 384adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 385adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 386adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 387adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Compares the {@code source} text to the {@code target} text according to 388adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the collation rules, strength and decomposition mode for this 389adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator}. See the {@code Collator} class description 390adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * for an example of use. 391adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 392adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * General recommendation: If comparisons are to be done with the same strings 393adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * multiple times, it is more efficient to generate {@code CollationKey} 394adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * objects for the strings and use 395adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code CollationKey.compareTo(CollationKey)} for the comparisons. If each 396adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * string is compared to only once, using 397adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator.compare(String, String)} has better performance. 398adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 399adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 400adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the source text. 401adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param target 402adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the target text. 403adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return an integer which may be a negative value, zero, or else a 404adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * positive value depending on whether {@code source} is less than, 405adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * equivalent to, or greater than {@code target}. 406adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 407adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 408adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public int compare(String source, String target) { 409adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (source == null || target == null) { 410adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // text.08=one of arguments is null 411adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw new NullPointerException(Messages.getString("text.08")); //$NON-NLS-1$ 412adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 413adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return this.icuColl.compare(source, target); 414adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 415adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 416adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 417adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code CollationKey} for the given source text. 418adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 419adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 420adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the specified source text. 421adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code CollationKey} for the given source text. 422adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 423adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 424adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public CollationKey getCollationKey(String source) { 425adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project com.ibm.icu4jni.text.CollationKey icuKey = this.icuColl 426adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .getCollationKey(source); 427adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (icuKey == null) { 428adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return null; 429adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 430adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return new CollationKey(source, icuKey); 431adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 432adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 433adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 434adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public int hashCode() { 435adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return ((com.ibm.icu4jni.text.RuleBasedCollator) this.icuColl).getRules() 436adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .hashCode(); 437adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 438adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 439adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 440adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Compares the specified object with this {@code RuleBasedCollator} and 441adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * indicates if they are equal. In order to be equal, {@code object} must be 442adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * an instance of {@code Collator} with the same collation rules and the 443adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * same attributes. 444adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 445adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param obj 446adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the object to compare with this object. 447adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return {@code true} if the specified object is equal to this 448adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator}; {@code false} otherwise. 449adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see #hashCode 450adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 451adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 452adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public boolean equals(Object obj) { 453adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!(obj instanceof Collator)) { 454adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return false; 455adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 456adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return super.equals(obj); 457adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 458adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 459