Класс CollationElementIterator

java.lang.Object
- java.text.CollationElementIterator

public final class CollationElementIterator
extends Object

Класс CollationElementIterator используется в качестве итератора для обхода каждого символа в международной строке. Используйте итератор для возврата приоритета упорядочения расположенного символа. Приоритет упорядочения символа, который мы называем ключом, определяет, как символ сортируется в данном объекте сортировки.

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

"ca" → the first key is key('c') and second key is key('a').
"cha" → the first key is key('ch') and second key is key('a').

А на немецком языке

"Ã¤b" → the first key is key('a'), the second key is key('e'), and
the third key is key('b').

Ключ символа — целое число, состоящее из первичного порядка (короткое), вторичного порядка (байт) и третичного порядка (байт). Java строго определяет размер и знаковый разряд своих примитивных типов данных. Поэтому статические функции primaryOrder, secondaryOrder, и tertiaryOrder возвращают int, short, и short соответственно для обеспечения правильности значения ключа.

Пример использования итератора,

String testString = "This is a test";
Collator col = Collator.getInstance();
if (col instanceof RuleBasedCollator) {
    RuleBasedCollator ruleBasedCollator = (RuleBasedCollator)col;
    CollationElementIterator collationElementIterator = ruleBasedCollator.getCollationElementIterator(testString);
    int primaryOrder = CollationElementIterator.primaryOrder(collationElementIterator.next());
        :
}

CollationElementIterator.next возвращает порядок сортировки следующего символа. Порядок сортировки состоит из первичного, вторичного и третичного порядка. Тип данных порядка сортировки — int. Первые 16 бит порядка сортировки — это его первичный порядок; следующие 8 бит — вторичный порядок, а последние 8 бит — третичный порядок.

Примечание: CollationElementIterator является частью реализации RuleBasedCollator. Он может использоваться только с экземплярами RuleBasedCollator.

С момента:: 1.1
См. также:: Collator, RuleBasedCollator

Поля

Модификатор и тип	Поле	Описание
`static int`	`NULLORDER`	Порядок NULL, который указывает, что курсор достиг конца строки.

Методы

Модификатор и тип	Метод	Описание
`int`	`getMaxExpansion(int order)`	Возвращает максимальную длину любых последовательностей расширения, которые заканчиваются указанным порядком сравнения.
`int`	`getOffset()`	Возвращает смещение символа в исходном тексте, соответствующее следующему элементу сортировки.
`int`	`next()`	Получить следующий элемент сортировки в строке.
`int`	`previous()`	Получить предыдущий элемент сортировки в строке.
`static int`	`primaryOrder(int order)`	Возвращает первичную составляющую элемента сортировки.
`void`	`reset()`	Сбрасывает курсор в начало строки.
`static short`	`secondaryOrder(int order)`	Возвращает вторичную составляющую элемента сортировки.
`void`	`setOffset(int newOffset)`	Устанавливает итератор на элемент сортировки, соответствующий указанному символу (параметр — смещение СИМВОЛА в исходной строке, а не смещение в соответствующей последовательности элементов сортировки).
`void`	`setText(String source)`	Установить новую строку для итерации.
`void`	`setText(CharacterIterator source)`	Установить новую строку для итерации.
`static short`	`tertiaryOrder(int order)`	Возвращает третичную составляющую элемента сортировки.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Поля

NULLORDER

public static final int NULLORDER

Порядок NULL, который указывает, что курсор достиг конца строки.

См. также:: Значения константных полей

Методы

reset

public void reset()

Сбрасывает курсор в начало строки. Следующий вызов next() вернёт первый элемент сортировки в строке.

Этот итератор итерируется по последовательности элементов сортировки, созданных из строки. Поскольку не обязательно существует взаимно однозначное соответствие между символами и элементами сортировки, это не означает то же самое, что «возвратить элемент сортировки [или приоритет упорядочения] следующего символа в строке».

Эта функция возвращает элемент сортировки, на который в данный момент указывает итератор, а затем обновляет внутренний указатель, чтобы он указывал на следующий элемент. previous() сначала обновляет указатель, а затем возвращает элемент. Это означает, что при изменении направления итерации (т. е. вызов next(), а затем вызов previous(), или вызов previous(), а затем вызов next()), вы получите тот же элемент дважды.

Возвращает:: следующий элемент сортировки

Этот итератор итерируется по последовательности элементов сортировки, созданных из строки. Поскольку не обязательно существует взаимно однозначное соответствие между символами и элементами сортировки, это не означает то же самое, что «возвратить элемент сортировки [или приоритет упорядочения] предыдущего символа в строке».

Эта функция обновляет внутренний указатель итератора, чтобы он указывал на элемент сортировки, предшествующий элементу, на который он в данный момент указывает, а затем возвращает этот элемент, в то время как next() возвращает текущий элемент и затем обновляет указатель. Это означает, что при изменении направления итерации (т. е. вызов next() и затем вызов previous(), или вызов previous() и затем вызов next()), вы получите тот же элемент дважды.

Возвращает:: предыдущий элемент сортировки
С момента:: 1.2

primaryOrder

public static final int primaryOrder(int order)

Возвращает первичную составляющую элемента сортировки.

Параметры:: order - элемент сортировки
Возвращает:: первичная составляющая элемента

secondaryOrder

public static final short secondaryOrder(int order)

Возвращает вторичную составляющую элемента сортировки.

Параметры:: order - элемент сортировки
Возвращает:: вторичная составляющая элемента

tertiaryOrder

public static final short tertiaryOrder(int order)

Возвращает третичную составляющую элемента сортировки.

Параметры:: order - элемент сортировки
Возвращает:: третичная составляющая элемента

setOffset

public void setOffset(int newOffset)

Устанавливает итератор на элемент сортировки, соответствующий указанному символу (параметр — смещение СИМВОЛА в исходной строке, а не смещение в соответствующей последовательности элементов сортировки). Значение, возвращаемое следующим вызовом next(), будет элементом сортировки, соответствующим указанной позиции в тексте. Если эта позиция находится в середине последовательности сокращающихся символов, результатом следующего вызова next() будет элемент сортировки для этой последовательности. Это означает, что getOffset() не гарантирует возвращения того же значения, что и при предыдущем вызове setOffset().

Параметры:: newOffset - Новое смещение символа в исходном тексте.
С момента:: 1.2

getOffset

public int getOffset()

Возвращает смещение символа в исходном тексте, соответствующее следующему элементу сортировки. (То есть, getOffset() возвращает позицию в тексте, соответствующую элементу сортировки, который будет возвращён следующим вызовом next().) Это значение всегда будет индексом ПЕРВОГО символа, соответствующего элементу сортировки (последовательность сокращающихся символов — это когда два или более символов соответствуют одному и тому же элементу сортировки). Это означает, что если вы выполните setOffset(x) сразу же после getOffset(), getOffset() не обязательно вернёт x.

Возвращает:: Смещение символа в исходном тексте, соответствующее элементу сортировки, который будет возвращён следующим вызовом next().
С момента:: 1.2

getMaxExpansion

public int getMaxExpansion(int order)

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

Параметры:: order - порядок сортировки, возвращённый функциями previous() или next().
Возвращает:: максимальную длину последовательностей расширения, заканчивающихся указанным порядком.
С момента:: 1.2

setText

public void setText(String source)

Установить новую строку для итерации.

Параметры:: source - новый исходный текст
С момента:: 1.2

setText

public void setText(CharacterIterator source)

Установить новую строку для итерации.

Параметры:: source - новый исходный текст.
С момента:: 1.2