|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.text.CollationElementIterator
The CollationElementIterator
class is used as an iterator
to walk through each character of an international string. Use the iterator
to return the ordering priority of the positioned character. The ordering
priority of a character, which we refer to as a key, defines how a character
is collated in the given collation object.
For example, consider the following in Spanish:
And in German,"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').
The key of a character is an integer composed of primary order(short), secondary order(byte), and tertiary order(byte). Java strictly defines the size and signedness of its primitive data types. Therefore, the static functions"äb"-> the first key is key('a'), the second key is key('e'), and the third key is key('b').
primaryOrder
, secondaryOrder
, and
tertiaryOrder
return int
, short
,
and short
respectively to ensure the correctness of the key
value.
Example of the iterator usage,
// get the first key of the string String str = "This is a test"; CollationElementIterator c = new CollationElementIterator(str, 0, str.length(), Collator.getInstance()); int primaryOrder = CollationElementIterator.primaryOrder(c->next());
CollationElementIterator.next
returns the collation order
of the next character. A collation order consists of primary order,
secondary order and tertiary order. The data type of the collation
order is int. The first 16 bits of a collation order
is its primary order; the next 8 bits is the secondary order and the
last 8 bits is the tertiary order.
Collator
,
RuleBasedCollator
Field Summary | |
static int |
NULLORDER
Null order which indicates the end of string is reached by the cursor. |
Method Summary | |
int |
getMaxExpansion(int order)
Return the maximum length of any expansion sequences that end with the specified comparison order. |
int |
getOffset()
Gets the offset of the current character in the the source text. |
int |
next()
Get the ordering priority of the next character in the string. |
int |
previous()
Get the ordering priority of the previous collation element in the string. |
static int |
primaryOrder(int order)
Get the primary order of a collation order. |
void |
reset()
Resets the cursor to the beginning of the string. |
static short |
secondaryOrder(int order)
Get the secondary order of a collation order. |
void |
setOffset(int newOffset)
Sets the position within the source text. |
void |
setText(CharacterIterator source)
Set a new string over which to iterate. |
void |
setText(String source)
Set a new string over which to iterate. |
static short |
tertiaryOrder(int order)
Get the tertiary order of a collation order. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int NULLORDER
Method Detail |
public void reset()
public int next()
public int previous()
public static final int primaryOrder(int order)
order
- the collation orderpublic static final short secondaryOrder(int order)
order
- the collation orderpublic static final short tertiaryOrder(int order)
order
- the collation orderpublic void setOffset(int newOffset)
newOffset
- The new offset relative to the start of the text.public int getOffset()
public int getMaxExpansion(int order)
order
- a collation order returned by previous or next.public void setText(String source)
str
- the new source text.public void setText(CharacterIterator source)
str
- the new source text.
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |