全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス

クラス java.text.CollationElementIterator 

java.lang.Object
   |
   +----java.text.CollationElementIterator
public final class CollationElementIterator
extends Object
CollationElementIteratorクラスは、各国語文字列の各文字を処理するときの反復子として使用します。反復子は、位置づけされた文字の順序の優先順位を返すのに使用されます。順序の優先順位（キーと呼びます）とは、与えられた照合順序においてある文字がどのように照合されるかを定義するものです。

たとえば、スペイン語の例をみてください。 

 "ca" -> 最初のキーはキー('c')、2番目のキーはキー('a')です。
 "cha" -> 最初のキーはキー('ch')、2番目のキーはキー('a')です。
さらに、ドイツ語の例をみてください。 
 "臙"-> 最初のキーはキー('a')、2番目のキーはキー('e')、3番目のキーはキー('b')です。
文字のキーは、第1順序（short）、第2順序（バイト）、第3順序（バイト）からなる整数です。Javaでは、そのプリミティブデータ型のサイズと符合の有無が厳密に定義されます。したがって、static関数 primaryOrder、secondaryOrder、tertiaryOrderは、キー値の正確性を確保するために、それぞれ int、short、shortを返します。

反復子の使用例 

 // 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は、次の文字の照合順序を返します。照合順序は、第1順序、第2順序、第3順序からなります。照合順序のデータ型は intです。照合順序の最初の 16ビットがその第1順序、次の8ビットが第2順序、最後の8ビットが第3順序です。

参照:
Collator, RuleBasedCollator

Variable Index

o NULLORDER
カーソルが文字列の終わりに達したことを示す null順序です。

Method Index

o next()
文字列における次の文字の順序の優先順位を入手します。
o primaryOrder(int)
照合順序の第1順序を入手します。
o reset()
カーソルを文字列の始めにリセットします。
o secondaryOrder(int)
照合順序の第2順序を入手します。
o tertiaryOrder(int)
照合順序の第3順序を入手します。

Variables

o NULLORDER 
  public static final int NULLORDER
カーソルが文字列の終わりに達したことを示す null順序です。

Methods

o reset 
  public void reset()
カーソルを文字列の始めにリセットします。

o next 
  public int next()
文字列における次の文字の順序の優先順位を入手します。

返り値:
次の文字の順序。文字列の終わりに達すると、NULLORDERを返します。
o primaryOrder 
  public static final int primaryOrder(int order)
照合順序の第1順序を入手します。

パラメータ:
order - 照合順序
返り値:
照合順序の第1順序
o secondaryOrder 
  public static final short secondaryOrder(int order)
照合順序の第2順序を入手します。

パラメータ:
order - 照合順序
返り値:
照合順序の第2順序
o tertiaryOrder 
  public static final short tertiaryOrder(int order)
照合順序の第3順序を入手します。

パラメータ:
order - 照合順序
返り値:
照合順序の第3順序 
全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス