CollationElementIterator (Java Platform SE 7)

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').
 
```
さらに、ドイツ語の例を示します。
```
 "aeb"-> the first key is key('a'), the second key is key('e'), and
 the third key is key('b').
 
```
文字のキーは、第 1 順序 (short)、第 2 順序 (byte)、第 3 順序 (byte) からなる整数です。Java では、その基本データ型のサイズと符号の有無が厳密に定義されます。したがって、static 関数 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 は、次の文字の照合順序を返します。照合順序は、第 1 順序、第 2 順序、第 3 順序からなります。照合順序のデータ型は int です。照合順序の最初の 16 ビットがその第 1 順序、次の 8 ビットが第 2 順序、最後の 8 ビットが第 3 順序です。
注: CollationElementIterator は RuleBasedCollator 実装の一部です。RuleBasedCollator インスタンスとともにしか使用できません。
関連項目:
Collator、RuleBasedCollator

フィールドのサマリー

フィールド
修飾子と型フィールドと説明

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

フィールド
修飾子と型	フィールドと説明
`static int`	`NULLORDER` カーソルが文字列の終わりに達したことを示す null 順序です。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`int`	`getMaxExpansion(int order)` 指定された比較順序で終わるすべての展開シーケンスの最大長を返します。
`int`	`getOffset()` 次の照合要素に対応する元のテキスト内の文字オフセットを返します。
`int`	`next()` 文字列の次の照合要素を取得します。
`int`	`previous()` 文字列の前の照合要素を取得します。
`static int`	`primaryOrder(int order)` 照合要素の第 1 成分を返します。
`void`	`reset()` カーソルを文字列の先頭にリセットします。
`static short`	`secondaryOrder(int order)` 照合要素の第 2 成分を返します。
`void`	`setOffset(int newOffset)` イテレータが指定された文字に対応する照合要素を示すように設定します。パラメータは、元の文字列の文字オフセットであり、照合要素の対応するシーケンスへのオフセットではありません。
`void`	`setText(CharacterIterator source)` 繰り返し処理の対象となる新しい文字列を設定します。
`void`	`setText(String source)` 繰り返し処理の対象となる新しい文字列を設定します。
`static short`	`tertiaryOrder(int order)` 照合要素の第 3 成分を返します。

クラス 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() を次に呼び出すと、文字列の最初の照合要素が返されます。
  - next
```
public int next()
```
    文字列の次の照合要素を取得します。
    このイテレータは、その文字列で作成された照合要素のシーケンス対して繰り返し処理を実行します。文字から照合要素への 1 対 1 のマッピングが必ずしも存在しないため、これは、「文字列の次の文字の照合要素 [順序の優先順位] を返す」こととは異なります。
    
    この関数は、イテレータが現在示している照合要素を返してから、内部ポインタを更新して次の要素を示します。それに対して、previous() は最初にポインタを更新してから要素を返します。これは、繰り返し処理中に方向を変更する場合 (つまり、next() を呼び出してから previous() を呼び出すか、previous() を呼び出してから next() を呼び出す)、同じ要素を 2 回戻すことを意味します。
  - previous
```
public int previous()
```
    文字列の前の照合要素を取得します。
    このイテレータは、その文字列で作成された照合要素のシーケンス対して繰り返し処理を実行します。文字から照合要素への 1 対 1 のマッピングが必ずしも存在しないため、これは、「文字列の 1 つ前の文字の照合要素 [順序の優先順位] を返す」こととは異なります。
    
    この関数は、イテレータの内部ポインタを更新して現在示している照合要素の前の照合要素を示してから、要素を返します。それに対して、next() は現在の要素を返してからポインタを更新します。これは、繰り返し処理中に方向を変更する場合 (つまり、next() を呼び出してから previous() を呼び出すか、previous() を呼び出してから next() を呼び出す)、同じ要素を 2 回戻すことを意味します。
    
    導入されたバージョン:
    
    1.2
  - primaryOrder
```
public static final int primaryOrder(int order)
```
    照合要素の第 1 成分を返します。
    
    パラメータ:
    order - 照合要素
    
    戻り値:
    要素の第 1 成分
  - secondaryOrder
```
public static final short secondaryOrder(int order)
```
    照合要素の第 2 成分を返します。
    
    パラメータ:
    order - 照合要素
    
    戻り値:
    要素の第 2 成分
  - tertiaryOrder
```
public static final short tertiaryOrder(int order)
```
    照合要素の第 3 成分を返します。
    
    パラメータ:
    order - 照合要素
    
    戻り値:
    要素の第 3 成分
  - setOffset
```
public void setOffset(int newOffset)
```
    イテレータが指定された文字に対応する照合要素を示すように設定します。パラメータは、元の文字列の文字オフセットであり、照合要素の対応するシーケンスへのオフセットではありません。next() の次の呼び出しで返される値は、テキスト内の指定された位置に対応する照合要素になります。その位置が縮小文字シーケンスの中にある場合、next() を次に呼び出した結果は、そのシーケンスの照合要素になります。つまり、getOffset() は、setOffset() を前に呼び出しときに渡された値と同じ値を返さない場合があります。
    
    パラメータ:
    newOffset - 元のテキストへの新しい文字オフセット。
    導入されたバージョン:
    
    1.2
  - getOffset
```
public int getOffset()
```
    次の照合要素に対応する元のテキスト内の文字オフセットを返します。つまり、getOffset() は、next() の次の呼び出しで返される照合要素に対応するテキスト内の位置を返します。この値は常に照合要素に対応する最初の文字のインデックスになります (2 つ以上のすべての文字が同じ照合要素に対応する場合は縮小文字シーケンス)。つまり、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

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス CollationElementIterator

フィールドのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

NULLORDER

メソッドの詳細

reset

next

previous

primaryOrder

secondaryOrder

tertiaryOrder

setOffset

getOffset

getMaxExpansion

setText

setText