com.ibm.icu.text
Class IndexCharacters

java.lang.Object
  extended by com.ibm.icu.text.IndexCharacters

public class IndexCharacters
extends java.lang.Object

A set of characters for use as a UI "index", that is, a list of clickable characters (or character sequences) that allow the user to see a segment of a larger "target" list. That is, each character corresponds to a bucket in the target list, where everything in the bucket is greater than or equal to the character (according to the locale's collation). The intention is to have two main functions; one that produces an index list that is relatively static, and the other is a list that produces roughly equally-sized buckets. Only the first is currently provided.

The static list would be presented as something like

  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
 
In the UI, an index character could be omitted if its bucket is empty. For example, if there is nothing in the bucket for Q, then Q could be omitted.

Important Notes:

Author:
markdavis
Status:
Draft ICU 4.2.

Field Summary
static char CGJ
           
 
Constructor Summary
IndexCharacters(ULocale locale)
          Create the index object.
 
Method Summary
 java.util.Map getAlreadyIn()
          As the index is built, items may be discarded from the exemplars.
 java.util.Collection getIndexCharacters()
          Get the index characters.
 ULocale getLocale()
          Get the locale
 java.util.List getNoDistinctSorting()
          As the index is built, items may be discarded from the exemplars.
 java.util.List getNotAlphabetic()
          As the index is built, items may be discarded from the exemplars.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CGJ

public static final char CGJ
See Also:
Constant Field Values
Constructor Detail

IndexCharacters

public IndexCharacters(ULocale locale)
Create the index object.

Parameters:
locale -
Status:
Draft ICU 4.2.
Method Detail

getIndexCharacters

public java.util.Collection getIndexCharacters()
Get the index characters.

Returns:
A collection including the index characters
Status:
Draft ICU 4.2.

getLocale

public ULocale getLocale()
Get the locale

Returns:
The locale.
Status:
Draft ICU 4.2.

getAlreadyIn

public java.util.Map getAlreadyIn()
As the index is built, items may be discarded from the exemplars. This contains some of the discards, and is intended for debugging.

Status:
Internal. This API is ICU internal only.

getNoDistinctSorting

public java.util.List getNoDistinctSorting()
As the index is built, items may be discarded from the exemplars. This contains some of the discards, and is intended for debugging.

Status:
Internal. This API is ICU internal only.

getNotAlphabetic

public java.util.List getNotAlphabetic()
As the index is built, items may be discarded from the exemplars. This contains some of the discards, and is intended for debugging.

Status:
Internal. This API is ICU internal only.


Copyright (c) 2009 IBM Corporation and others.