Класс RuleBasedCollator

public class RuleBasedCollator extends Collator

Класс RuleBasedCollator — конкретный подкласс Collator, предоставляющий простой табличный сортировщик, управляемый данными. С его помощью можно создать настраиваемый табличный Collator. RuleBasedCollator сопоставляет символы ключам сортировки.

RuleBasedCollator имеет следующие ограничения, обусловленные эффективностью (для более сложных языков могут использоваться другие подклассы):

1. Если задано специальное правило сортировки, управляемое <modifier>, оно применяется ко всему объекту сортировщика.
2. Все неупомянутые символы располагаются в конце порядка сортировки.

Таблица сортировки состоит из списка правил сортировки, каждое из которых имеет одну из трёх форм:

   <modifier>
   <relation> <text-argument>
   <reset> <text-argument>

Определения элементов правила следующие:

• Текстовый аргумент: текстовый аргумент — это любая последовательность символов, за исключением специальных символов (то есть обычных пробельных символов [0009-000D, 0020] и символов синтаксиса правил [0021-002F, 003A-0040, 005B-0060, 007B-007E]). Если требуются эти символы, их можно заключить в одинарные кавычки (например, амперсанд => '&'). Обратите внимание, что не заключённые в кавычки пробельные символы игнорируются; например, b c рассматривается как bc.
• Модификатор: в настоящее время существуют два модификатора, включающих специальные правила сортировки.
  • '@' : включает обратную сортировку акцентов (вторичных различий), как во французском языке.
  • '!' : включает перестановку гласных и согласных в тайском/лаосском языках. Если это правило действует, то тайская гласная из диапазона \U0E40-\U0E44, предшествующая тайской согласной из диапазона \U0E01-\U0E2E, ИЛИ лаосская гласная из диапазона \U0EC0-\U0EC4, предшествующая лаосской согласной из диапазона \U0E81-\U0EAE, при сортировке помещается после согласной.

  '@' : указывает, что акценты сортируются в обратном порядке, как во французском языке.

• Отношение: используются следующие отношения:
  • '<' : больше, как при различии букв (первичный уровень)
  • ';' : больше, как при различии акцентов (вторичный уровень)
  • ',' : больше, как при различии регистра (третичный уровень)
  • '=' : равно
• Сброс: существует один оператор сброса, который используется преимущественно для лигатур и расширений, но также может добавлять модификацию в конец набора правил.

  '&' : указывает, что следующее правило следует за позицией, в которой сортировался бы текстовый аргумент сброса.

На практике это проще, чем кажется. Например, следующие записи эквивалентны и выражают одно и то же:

a < b < c
a < b & b < c
a < c & a < b

Обратите внимание, что порядок важен: следующий элемент располагается непосредственно после текстового аргумента. Следующие записи не эквивалентны:

a < b & a < c
a < c & a < b

Текстовый аргумент должен уже присутствовать в последовательности либо в ней должна присутствовать начальная подстрока этого текстового аргумента. (Например, "a < b & ae < e" — допустимая запись, поскольку "a" присутствует в последовательности до сброса "ae".) В последнем случае "ae" не добавляется и не рассматривается как один символ; вместо этого "e" сортируется так, как если бы оно было расширено до двух символов: "a", за которым следует "e". Такое различие встречается в естественных языках: в традиционном испанском "ch" рассматривается как последовательность, объединяющаяся в один символ (выражается как "c < ch < d"), тогда как в традиционном немецком умлаут a рассматривается как последовательность, расширяющаяся до двух символов (выражается как "a,A < b,B ... &ae;\u00e3&AE;\u00c3"). [\u00e3 и \u00c3 — это, разумеется, escape-последовательности для умлаута a.]

Игнорируемые символы

Для игнорируемых символов первое правило должно начинаться с отношения (приведённые выше примеры на самом деле являются фрагментами; вместо "a < b" должно быть "< a < b"). Однако если первое отношение не равно "<", все текстовые аргументы до первого "<" игнорируются. Например, ", - < a < b" делает "-" игнорируемым символом, как мы видели ранее на примере слова "black-birds". В примерах для разных языков видно, что большинство акцентов игнорируются.

Нормализация и акценты

RuleBasedCollator автоматически обрабатывает таблицу правил, добавляя в неё как предварительно составленные символы с акцентами, так и их варианты с комбинируемыми символами. Даже если переданная строка правил содержит только базовые символы и отдельные комбинируемые символы акцентов, в таблицу будут добавлены предварительно составленные символы с акцентами, соответствующие всем каноническим комбинациям символов из строки правил.

Это позволяет использовать RuleBasedCollator для сравнения строк с акцентами, даже если для сортировщика установлен режим NO_DECOMPOSITION. Однако есть два нюанса. Во-первых, если сортируемые строки содержат комбинируемые последовательности, которые могут быть расположены не в каноническом порядке, для сортировки таких последовательностей следует установить режим CANONICAL_DECOMPOSITION или FULL_DECOMPOSITION. Во-вторых, если строки содержат символы с совместимыми разложениями (например, полноширинные и полуширинные формы), необходимо использовать FULL_DECOMPOSITION, поскольку таблицы правил содержат только канонические соответствия.

Ошибки

Ошибками являются следующие случаи:

• Текстовый аргумент содержит не заключённые в кавычки знаки пунктуации (например, "a < b-c < d").
• За символом отношения или сброса не следует текстовый аргумент (например, "a < ,b").
• Сброс, при котором текстовый аргумент (или его начальная подстрока) ещё не присутствует в последовательности (например, "a < b & e < f").

При возникновении одной из этих ошибок RuleBasedCollator выбрасывает ParseException.

Примеры

Простой: "< a < b < c < d"

Норвежский: "< a, A < b, B < c, C < d, D < e, E < f, F < g, G < h, H < i, I < j, J < k, K < l, L < m, M < n, N < o, O < p, P < q, Q < r, R < s, S < t, T < u, U < v, V < w, W < x, X < y, Y < z, Z < \u00E6, \u00C6 < \u00F8, \u00D8 < \u00E5 = a\u030A, \u00C5 = A\u030A; aa, AA"

Чтобы создать объект RuleBasedCollator со специальными правилами, настроенными под ваши задачи, создайте RuleBasedCollator, используя правила, содержащиеся в объекте String. Например:

String simple = "< a< b< c< d";
RuleBasedCollator mySimple = new RuleBasedCollator(simple);

Или:

String Norwegian = "< a, A < b, B < c, C < d, D < e, E < f, F < g, G < h, H < i, I" +
                   "< j, J < k, K < l, L < m, M < n, N < o, O < p, P < q, Q < r, R" +
                   "< s, S < t, T < u, U < v, V < w, W < x, X < y, Y < z, Z" +
                   "< \u00E6, \u00C6" +     // Latin letter ae & AE
                   "< \u00F8, \u00D8" +     // Latin letter o & O with stroke
                   "< \u00E5 = a\u030A," +  // Latin letter a with ring above
                   "  \u00C5 = A\u030A;" +  // Latin letter A with ring above
                   "  aa, AA";
RuleBasedCollator myNorwegian = new RuleBasedCollator(Norwegian);

Новую строку правил сортировки можно создать, объединив строки правил. Например, правила, возвращаемые методом getRules(), можно объединить, чтобы составить несколько RuleBasedCollator.

В следующем примере показано, как изменить порядок неинтервалных акцентов,

// old rule
String oldRules = "=\u0301;\u0300;\u0302;\u0308"    // main accents
                + ";\u0327;\u0303;\u0304;\u0305"    // main accents
                + ";\u0306;\u0307;\u0309;\u030A"    // main accents
                + ";\u030B;\u030C;\u030D;\u030E"    // main accents
                + ";\u030F;\u0310;\u0311;\u0312"    // main accents
                + "< a , A ; ae, AE ; \u00e6 , \u00c6"
                + "< b , B < c, C < e, E & C < d, D";
// change the order of accent characters
String addOn = "& \u0300 ; \u0308 ; \u0302";
RuleBasedCollator myCollator = new RuleBasedCollator(oldRules + addOn);