AlphabeticIndex

public final class AlphabeticIndex
extends Object implements Iterable<Bucket<V>>

AlphabeticIndex支持创建适合给定语言的UI索引。 它可以支持直接使用，也可以与不支持本地化整理的客户端一起使用。 以下是一个索引在UI中的样子：

  ... A B C D E F G H I J K L M N O P Q R S T U V W X Y Z  ...

  A
     Addison
     Albertson
     Azensky
  B
     Baecker
  ...
 

该类还支持在第一个（下溢），最后一个（溢出）之后以及脚本之间（流入）之间有字符串的存储区。 例如，如果索引是用俄语和英语的标签构造的，则希腊字符将落入其他两个脚本之间的流入桶中。

注意：如果你期望有很多ASCII或拉丁字符以及来自用户语言的字符，那么调用addLabels（ULocale.English）是一个好主意。

Direct Use

以下显示了直接构建索引的示例。 下面的“show ...”方法只是为了说明用法。

 // Create a simple index where the values for the strings are Integers, and add the strings
 
 AlphabeticIndex<Integer> index = new AlphabeticIndex<Integer>(desiredLocale).addLabels(additionalLocale);
 int counter = 0;
 for (String item : test) {
     index.addRecord(item, counter++); 
 }
 ...
 // Show index at top. We could skip or gray out empty buckets
 
 for (AlphabeticIndex.Bucket<Integer> bucket : index) {
     if (showAll || bucket.size() != 0) {
         showLabelAtTop(UI, bucket.getLabel());
     }
 }
  ...
 // Show the buckets with their contents, skipping empty buckets
 
 for (AlphabeticIndex.Bucket<Integer> bucket : index) {
     if (bucket.size() != 0) {
         showLabelInList(UI, bucket.getLabel());
         for (AlphabeticIndex.Record<Integer> item : bucket) {
             showIndexedItem(UI, item.getName(), item.getData());
         }
 

 ... A-F G-N O-Z ...
 

Client Support

AlphabeticIndex.ImmutableIndex者还可以使用 AlphabeticIndex.ImmutableIndex或AlphabeticIndex本身来支持在不支持AlphabeticIndex功能的客户端上进行排序。

ImmutableIndex既是不可变的，也是线程安全的。 相应的AlphabeticIndex方法不是线程安全的，因为它们“懒惰地”构建索引桶。

• ImmutableIndex.getBucket(index) provides random access to all buckets and their labels and label types.
• AlphabeticIndex.getBucketLabels() or the bucket iterator on either class can be used to get a list of the labels, such as "...", "A", "B",..., and send that list to the client.
• When the client has a new name, it sends that name to the server. The server needs to call the following methods, and communicate the bucketIndex and collationKey back to the client.

   int bucketIndex = index.getBucketIndex(name);
   String label = immutableIndex.getBucket(bucketIndex).getLabel();  // optional
   RawCollationKey collationKey = collator.getRawCollationKey(name, null);
   

• The client would put the name (and associated information) into its bucket for bucketIndex. The collationKey is a sequence of bytes that can be compared with a binary compare, and produce the right localized result.

Summary

Inherited methods
From class java.lang.Object Object clone() 创建并返回此对象的副本。 boolean equals(Object obj) 指示其他某个对象是否“等于”这一个。 void finalize() 当垃圾收集确定没有更多对该对象的引用时，由对象上的垃圾回收器调用。 final Class<?> getClass() 返回此 Object的运行时类。 int hashCode() 返回对象的哈希码值。 final void notify() 唤醒正在等待该对象监视器的单个线程。 final void notifyAll() 唤醒在该对象监视器上等待的所有线程。 String toString() 返回对象的字符串表示形式。 final void wait(long millis, int nanos) 导致当前线程等待，直到另一个线程调用此对象的方法 notify()或 notifyAll()方法，或其他某个线程中断当前线程或经过一定的实时时间。 final void wait(long millis) 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法或经过了指定的时间量。 final void wait() 导致当前线程等待，直到另一个线程调用此对象的方法 notify()或方法 notifyAll() 。
From interface java.lang.Iterable default void forEach(Consumer<? super T> action) 对 Iterable每个元素执行给定操作，直到处理 Iterable所有元素或操作抛出异常。 abstract Iterator<Bucket<V>> iterator() 返回类型为 T元素的迭代器。 default Spliterator<Bucket<V>> spliterator() 创建一个 Spliterator覆盖此 Iterable所描述的元素。

Public constructors

AlphabeticIndex (ULocale locale)

AlphabeticIndex (Locale locale)

AlphabeticIndex (RuleBasedCollator collator)

Public methods

AlphabeticIndex<V> addLabels (Locale... additions)

AlphabeticIndex<V> addLabels (UnicodeSet additions)

AlphabeticIndex<V> addLabels (ULocale... additions)

AlphabeticIndex<V> addRecord (CharSequence name, 
                V data)

ImmutableIndex<V> buildImmutableIndex ()

AlphabeticIndex<V> clearRecords ()

int getBucketCount ()

int getBucketIndex (CharSequence name)

List<String> getBucketLabels ()

RuleBasedCollator getCollator ()

String getInflowLabel ()

int getMaxLabelCount ()

String getOverflowLabel ()

int getRecordCount ()

String getUnderflowLabel ()

Iterator<Bucket<V>> iterator ()

AlphabeticIndex<V> setInflowLabel (String inflowLabel)

AlphabeticIndex<V> setMaxLabelCount (int maxLabelCount)

AlphabeticIndex<V> setOverflowLabel (String overflowLabel)

AlphabeticIndex<V> setUnderflowLabel (String underflowLabel)