1f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes/* 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 8f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 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 Projectpackage java.text; 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 204dfae7b3e2b56160646c17d93b32b3ff495c0053Elliott Hughesimport libcore.icu.RuleBasedCollatorICU; 214dfae7b3e2b56160646c17d93b32b3ff495c0053Elliott Hughes 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * A concrete implementation class for {@code Collation}. 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator} has the following restrictions for efficiency 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (other subclasses may be used for more complex languages): 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ol> 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li> If a French secondary ordering is specified it applies to the whole 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * collator object.</li> 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li> All non-mentioned Unicode characters are at the end of the collation 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * order.</li> 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li> If a character is not located in the {@code RuleBasedCollator}, the 3303c0a8e681c776fdba0389ab8593282139afc6d6Elliott Hughes * default Unicode Collation Algorithm (UCA) rule-based table is automatically 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * searched as a backup.</li> 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ol> 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The collation table is composed of a list of collation rules, where each rule 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * is of three forms: 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 417b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <modifier> 427b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <relation> <text-argument> 437b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <reset> <text-argument> 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 45adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The rule elements are defined as follows: 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ul type="disc"> 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li><strong>Modifier</strong>: There is a single modifier which is used to 507b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * specify that all accents (secondary differences) are backwards: 517b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <ul type=square> 527b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <li>'@' : Indicates that accents are sorted backwards, as in French. 537b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * </ul> 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </li> 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li><strong>Relation</strong>: The relations are the following: 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ul type=square> 577b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <li>'<' : Greater, as a letter difference (primary) 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>';' : Greater, as an accent difference (secondary) 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>',' : Greater, as a case difference (tertiary) 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>'=' : Equal 61adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ul> 62adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </li> 637b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <li><strong>Text-Argument</strong>: A text-argument is any sequence of 647b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * characters, excluding special characters (that is, common whitespace 657b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * characters [0009-000D, 0020] and rule syntax characters [0021-002F, 667b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * 003A-0040, 005B-0060, 007B-007E]). If those characters are desired, you can 677b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * put them in single quotes (for example, use '&' for ampersand). Note that 687b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * unquoted white space characters are ignored; for example, {@code b c} is 697b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * treated as {@code bc}.</li> 70adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li><strong>Reset</strong>: There is a single reset which is used primarily 71adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * for contractions and expansions, but which can also be used to add a 727b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * modification at the end of a set of rules: 737b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <ul type=square> 747b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * <li>'&' : Indicates that the next rule follows the position to where the reset 75adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * text-argument would be sorted. 767b00ce846d4cdadceadb197e3d207946168970edElliott Hughes * </ul> 77adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </li> 78adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ul> 79adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 80adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * This sounds more complicated than it is in practice. For example, the 81adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * following are equivalent ways of expressing the same thing: 82adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 839b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 84adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 85adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < b < c 86adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < b & b < c 87adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < c & a < b 88adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 899b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 90adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 91adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 92adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Notice that the order is important, as the subsequent item goes immediately 93adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * after the text-argument. The following are not equivalent: 94adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 959b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 96adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 97adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < b & a < c 98adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a < c & a < b 99adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 1009b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 101adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 102adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 103adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Either the text-argument must already be present in the sequence, or some 104adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initial substring of the text-argument must be present. For example 105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "a < b & ae < e"} is valid since "a" is present in the sequence before 106adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * "ae" is reset. In this latter case, "ae" is not entered and treated as a 107adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * single character; instead, "e" is sorted as if it were expanded to two 108adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * characters: "a" followed by an "e". This difference appears in natural 109adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * languages: in traditional Spanish "ch" is treated as if it contracts to a 110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * single character (expressed as {@code "c < ch < d"}), while in traditional 111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * German a-umlaut is treated as if it expands to two characters (expressed as 112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "a,A < b,B ... & ae;\u00e3 & AE;\u00c3"}, where \u00e3 and \u00c3 113adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * are the escape sequences for a-umlaut). 114adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Ignorable Characters</h4> 115adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 116adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * For ignorable characters, the first rule must start with a relation (the 117adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * examples we have used above are really fragments; {@code "a < b"} really 118adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * should be {@code "< a < b"}). If, however, the first relation is not 119adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "<"}, then all text-arguments up to the first {@code "<"} are 120adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * ignorable. For example, {@code ", - < a < b"} makes {@code "-"} an ignorable 121adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * character. 122adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Normalization and Accents</h4> 123adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 124adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator} automatically processes its rule table to include 125adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * both pre-composed and combining-character versions of accented characters. 126adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Even if the provided rule string contains only base characters and separate 127adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * combining accent characters, the pre-composed accented characters matching 128adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * all canonical combinations of characters from the rule string will be entered 129adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * in the table. 130adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 131adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * This allows you to use a RuleBasedCollator to compare accented strings even 132adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * when the collator is set to NO_DECOMPOSITION. However, if the strings to be 133adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * collated contain combining sequences that may not be in canonical order, you 134adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * should set the collator to CANONICAL_DECOMPOSITION to enable sorting of 135adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * combining sequences. For more information, see <a 136adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * href="http://www.aw.com/devpress">The Unicode Standard, Version 3.0</a>. 137adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Errors</h4> 138adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 139adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The following rules are not valid: 140adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <ul type="disc"> 141adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>A text-argument contains unquoted punctuation symbols, for example 142adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code "a < b-c < d"}.</li> 143adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>A relation or reset character is not followed by a text-argument, for 144adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * example {@code "a < , b"}.</li> 145adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <li>A reset where the text-argument (or an initial substring of the 146adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * text-argument) is not already in the sequence or allocated in the default UCA 147adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * table, for example {@code "a < b & e < f"}.</li> 148adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </ul> 149adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 150adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If you produce one of these errors, {@code RuleBasedCollator} throws a 151adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code ParseException}. 152adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <h4>Examples</h4> 153adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 154adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Normally, to create a rule-based collator object, you will use 155adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code Collator}'s factory method {@code getInstance}. However, to create a 156adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * rule-based collator object with specialized rules tailored to your needs, you 157adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * construct the {@code RuleBasedCollator} with the rules contained in a 158adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code String} object. For example: 159adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 1609b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 161adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 162adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String Simple = "< a < b < c < d"; 163adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator mySimple = new RuleBasedCollator(Simple); 164adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 1659b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 166adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 167adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 168adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Or: 169adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 1709b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 171adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 172adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String Norwegian = "< a,A< b,B< c,C< d,D< e,E< f,F< g,G< h,H< i,I" 1739b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * + "< j,J< k,K< l,L< m,M< n,N< o,O< p,P< q,Q< r,R" 174adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * + "< s,S< t,T< u,U< v,V< w,W< x,X< y,Y< z,Z" 1759b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * + "< \u00E5=a\u030A,\u00C5=A\u030A" 176adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * + ";aa,AA< \u00E6,\u00C6< \u00F8,\u00D8"; 177adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator myNorwegian = new RuleBasedCollator(Norwegian); 178adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 1799b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 180adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 181adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 182adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Combining {@code Collator}s is as simple as concatenating strings. Here is 183adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * an example that combines two {@code Collator}s from two different locales: 184adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 1859b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 186adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 187adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Create an en_US Collator object 188adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator en_USCollator = (RuleBasedCollator)Collator 189adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * .getInstance(new Locale("en", "US", "")); 1909b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 191adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Create a da_DK Collator object 192adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator da_DKCollator = (RuleBasedCollator)Collator 193adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * .getInstance(new Locale("da", "DK", "")); 1949b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 195adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Combine the two collators 196adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // First, get the collation rules from en_USCollator 197adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String en_USRules = en_USCollator.getRules(); 1989b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 199adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Second, get the collation rules from da_DKCollator 200adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String da_DKRules = da_DKCollator.getRules(); 2019b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 202adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator newCollator = new RuleBasedCollator(en_USRules + da_DKRules); 203adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // newCollator has the combined rules 204adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2059b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 206adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 207adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 208adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The next example shows to make changes on an existing table to create a new 209adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code Collator} object. For example, add {@code "& C < ch, cH, Ch, CH"} to 210adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code en_USCollator} object to create your own: 211adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 2129b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 213adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 214adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // Create a new Collator object with additional rules 215adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String addRules = "& C < ch, cH, Ch, CH"; 2169b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 217adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator myCollator = new RuleBasedCollator(en_USCollator + addRules); 218adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // myCollator contains the new rules 219adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2209b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 221adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 222adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 223adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The following example demonstrates how to change the order of non-spacing 224adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * accents: 225adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 2269b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 227adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 228adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // old rule 229adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String oldRules = "= \u00a8 ; \u00af ; \u00bf" + "< a , A ; ae, AE ; \u00e6 , \u00c6" 230adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * + "< b , B < c, C < e, E & C < d, D"; 2319b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 232adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // change the order of accent characters 233adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String addOn = "& \u00bf ; \u00af ; \u00a8;"; 2349b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 235adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator myCollator = new RuleBasedCollator(oldRules + addOn); 236adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2379b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 238adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 239adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 240adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The last example shows how to put new primary ordering in before the default 241adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * setting. For example, in the Japanese {@code Collator}, you can either sort 242adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * English characters before or after Japanese characters: 243adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <blockquote> 2449b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 245adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 246adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // get en_US Collator rules 247adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * RuleBasedCollator en_USCollator = (RuleBasedCollator) 248adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Collator.getInstance(Locale.US); 2499b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 250adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // add a few Japanese character to sort before English characters 251adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // suppose the last character before the first base letter 'a' in 252adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * // the English collation rule is \u30A2 253adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * String jaString = "& \u30A2 , \u30FC < \u30C8"; 2549b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 2559b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * RuleBasedCollator myJapaneseCollator = 256adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * new RuleBasedCollator(en_USCollator.getRules() + jaString); 257adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 2589b354e75f2418e54638e02d153216660b67d01b8Jesse Wilson * 259adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </blockquote> 260adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 261adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic class RuleBasedCollator extends Collator { 2624dfae7b3e2b56160646c17d93b32b3ff495c0053Elliott Hughes RuleBasedCollator(RuleBasedCollatorICU wrapper) { 263adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project super(wrapper); 264adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 265adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 266adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 267adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code RuleBasedCollator} using the 268adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specified {@code rules}. The {@code rules} are usually either 269adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * hand-written based on the {@link RuleBasedCollator class description} or 270adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the result of a former {@link #getRules()} call. 271adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 272adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Note that the {@code rules} are actually interpreted as a delta to the 273a7d4139bed693bf6037bf5f7f49a24b077102adcElliott Hughes * standard Unicode Collation Algorithm (UCA). This differs 274adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * slightly from other implementations which work with full {@code rules} 275adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specifications and may result in different behavior. 276adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 277adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param rules 278adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the collation rules. 279adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 280a7d4139bed693bf6037bf5f7f49a24b077102adcElliott Hughes * if {@code rules == null}. 281adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws ParseException 282adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code rules} contains rules with invalid collation rule 283adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * syntax. 284adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 285adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public RuleBasedCollator(String rules) throws ParseException { 286adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (rules == null) { 28786acc043d3334651ee26c65467d78d6cefedd397Kenny Root throw new NullPointerException("rules == null"); 288adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 289a7d4139bed693bf6037bf5f7f49a24b077102adcElliott Hughes if (rules.isEmpty()) { 290a7d4139bed693bf6037bf5f7f49a24b077102adcElliott Hughes throw new ParseException("empty rules", 0); 291a7d4139bed693bf6037bf5f7f49a24b077102adcElliott Hughes } 292adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project try { 2934dfae7b3e2b56160646c17d93b32b3ff495c0053Elliott Hughes icuColl = new RuleBasedCollatorICU(rules); 294adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } catch (Exception e) { 295adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (e instanceof ParseException) { 296adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw (ParseException) e; 297adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 298adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /* 299adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * -1 means it's not a ParseException. Maybe IOException thrown when 30003c0a8e681c776fdba0389ab8593282139afc6d6Elliott Hughes * an error occurred while reading internal data. 301adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 302adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw new ParseException(e.getMessage(), -1); 303adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 304adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 305adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 306adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 307adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Obtains a {@code CollationElementIterator} for the given 308adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code CharacterIterator}. The source iterator's integrity will be 309adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * preserved since a new copy will be created for use. 310f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 311adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 312adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the source character iterator. 313adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a {@code CollationElementIterator} for {@code source}. 314adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 315a7d4139bed693bf6037bf5f7f49a24b077102adcElliott Hughes public CollationElementIterator getCollationElementIterator(CharacterIterator source) { 316adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (source == null) { 31786acc043d3334651ee26c65467d78d6cefedd397Kenny Root throw new NullPointerException("source == null"); 318adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 319866e7ae17a3da81a02b0b144e0c9c2b3196d293aElliott Hughes return new CollationElementIterator(icuColl.getCollationElementIterator(source)); 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 string. 324f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 325adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 326adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the source string. 327adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code CollationElementIterator} for {@code source}. 328adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 329adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public CollationElementIterator getCollationElementIterator(String source) { 330adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (source == null) { 33186acc043d3334651ee26c65467d78d6cefedd397Kenny Root throw new NullPointerException("source == null"); 332adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 333866e7ae17a3da81a02b0b144e0c9c2b3196d293aElliott Hughes return new CollationElementIterator(icuColl.getCollationElementIterator(source)); 334adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 335adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 336adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 337adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the collation rules of this collator. These {@code rules} can be 3385d287a9d9768195f53e244414b465ec4a6f72625The Android Open Source Project * fed into the {@code RuleBasedCollator(String)} constructor. 339adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 340adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Note that the {@code rules} are actually interpreted as a delta to the 341adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * standard Unicode Collation Algorithm (UCA). Hence, an empty {@code rules} 342adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * string results in the default UCA rules being applied. This differs 343adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * slightly from other implementations which work with full {@code rules} 344adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specifications and may result in different behavior. 345adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 346adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the collation rules. 347adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 348adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String getRules() { 349866e7ae17a3da81a02b0b144e0c9c2b3196d293aElliott Hughes return icuColl.getRules(); 350adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 351adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 352adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 353adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new collator with the same collation rules, decomposition mode and 354adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * strength value as this collator. 355f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 356adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a shallow copy of this collator. 357adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see java.lang.Cloneable 358adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 359adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 360adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public Object clone() { 361adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project RuleBasedCollator clone = (RuleBasedCollator) super.clone(); 362adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return clone; 363adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 364adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 365adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 366adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Compares the {@code source} text to the {@code target} text according to 367adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the collation rules, strength and decomposition mode for this 368adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator}. See the {@code Collator} class description 369adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * for an example of use. 370adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 371adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * General recommendation: If comparisons are to be done with the same strings 372adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * multiple times, it is more efficient to generate {@code CollationKey} 373adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * objects for the strings and use 374adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code CollationKey.compareTo(CollationKey)} for the comparisons. If each 375adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * string is compared to only once, using 376adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator.compare(String, String)} has better performance. 377f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 378adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 379adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the source text. 380adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param target 381adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the target text. 382adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return an integer which may be a negative value, zero, or else a 383adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * positive value depending on whether {@code source} is less than, 384adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * equivalent to, or greater than {@code target}. 385adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 386adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 387adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public int compare(String source, String target) { 38886acc043d3334651ee26c65467d78d6cefedd397Kenny Root if (source == null) { 38986acc043d3334651ee26c65467d78d6cefedd397Kenny Root throw new NullPointerException("source == null"); 39086acc043d3334651ee26c65467d78d6cefedd397Kenny Root } else if (target == null) { 39186acc043d3334651ee26c65467d78d6cefedd397Kenny Root throw new NullPointerException("target == null"); 392adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 3934dfae7b3e2b56160646c17d93b32b3ff495c0053Elliott Hughes return icuColl.compare(source, target); 394adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 395adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 396adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 397adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code CollationKey} for the given source text. 398f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 399adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param source 400adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the specified source text. 401adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code CollationKey} for the given source text. 402adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 403adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 404adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public CollationKey getCollationKey(String source) { 405ebe438a0734f24ded1772778e5e712c820981234Elliott Hughes return icuColl.getCollationKey(source); 406adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 407adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 408adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 409adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public int hashCode() { 410866e7ae17a3da81a02b0b144e0c9c2b3196d293aElliott Hughes return icuColl.getRules().hashCode(); 411adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 412adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 413adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 414adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Compares the specified object with this {@code RuleBasedCollator} and 415adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * indicates if they are equal. In order to be equal, {@code object} must be 416adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * an instance of {@code Collator} with the same collation rules and the 417adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * same attributes. 418f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 419adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param obj 420adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the object to compare with this object. 421adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return {@code true} if the specified object is equal to this 422adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code RuleBasedCollator}; {@code false} otherwise. 423adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see #hashCode 424adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 425adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 426adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public boolean equals(Object obj) { 427adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!(obj instanceof Collator)) { 428adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return false; 429adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 430adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return super.equals(obj); 431adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 432adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 433