1b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho/* 2b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho******************************************************************************* 3b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho* 4fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius* Copyright (C) 2011-2014 International Business Machines 5b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho* Corporation and others. All Rights Reserved. 6b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho* 7b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho******************************************************************************* 8b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho*/ 9b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 10b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho#ifndef INDEXCHARS_H 11b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho#define INDEXCHARS_H 12b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 13b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho#include "unicode/utypes.h" 14b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho#include "unicode/uobject.h" 15b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho#include "unicode/locid.h" 16b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 17fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius#if !UCONFIG_NO_COLLATION 18103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius 19b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho/** 20b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * \file 21b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * \brief C++ API: Index Characters 22b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 23b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 24b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoU_CDECL_BEGIN 25b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 26b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho/** 27b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Constants for Alphabetic Index Label Types. 28b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The form of these enum constants anticipates having a plain C API 29b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * for Alphabetic Indexes that will also use them. 30103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 31b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 32b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehotypedef enum UAlphabeticIndexLabelType { 33103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius /** 34103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * Normal Label, typically the starting letter of the names 35103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * in the bucket with this label. 36103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 37103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius */ 38103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius U_ALPHAINDEX_NORMAL = 0, 39103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius 40103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius /** 41103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * Undeflow Label. The bucket with this label contains names 42103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * in scripts that sort before any of the bucket labels in this index. 43103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 44103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius */ 45103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius U_ALPHAINDEX_UNDERFLOW = 1, 46103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius 47103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius /** 48103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * Inflow Label. The bucket with this label contains names 49103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * in scripts that sort between two of the bucket labels in this index. 50103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * Inflow labels are created when an index contains normal labels for 51103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * multiple scripts, and skips other scripts that sort between some of the 52103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * included scripts. 53103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 54103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius */ 55103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius U_ALPHAINDEX_INFLOW = 2, 56103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius 57103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius /** 58103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * Overflow Label. Te bucket with this label contains names in scripts 59103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * that sort after all of the bucket labels in this index. 60103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 61103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius */ 62103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius U_ALPHAINDEX_OVERFLOW = 3 63103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius} UAlphabeticIndexLabelType; 64b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 65b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 66b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehostruct UHashtable; 67b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoU_CDECL_END 68b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 69b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoU_NAMESPACE_BEGIN 70b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 71b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho// Forward Declarations 72b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 73f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Corneliusclass BucketList; 74b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoclass Collator; 75b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoclass RuleBasedCollator; 76b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoclass StringEnumeration; 77b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoclass UnicodeSet; 78b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoclass UVector; 79b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 80b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho/** 81f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * AlphabeticIndex supports the creation of a UI index appropriate for a given language. 82f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * It can support either direct use, or use with a client that doesn't support localized collation. 83f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The following is an example of what an index might look like in a UI: 84f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 85b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <pre> 86f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <b>... 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 ...</b> 87b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 88b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <b>A</b> 89b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Addison 90b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Albertson 91b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Azensky 92b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <b>B</b> 93b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Baker 94b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * ... 95b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * </pre> 96b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 97b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The class can generate a list of labels for use as a UI "index", that is, a list of 98b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * clickable characters (or character sequences) that allow the user to see a segment 99b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * (bucket) of a larger "target" list. That is, each label corresponds to a bucket in 100b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * the target list, where everything in the bucket is greater than or equal to the character 101b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * (according to the locale's collation). Strings can be added to the index; 102b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * they will be in sorted order in the right bucket. 103b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <p> 104b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The class also supports having buckets for strings before the first (underflow), 105b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * after the last (overflow), and between scripts (inflow). For example, if the index 106b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * is constructed with labels for Russian and English, Greek characters would fall 107b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * into an inflow bucket between the other two scripts. 108b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <p> 109b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The AlphabeticIndex class is not intended for public subclassing. 110f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 111f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <p><em>Note:</em> If you expect to have a lot of ASCII or Latin characters 112f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * as well as characters from the user's language, 113f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * then it is a good idea to call addLabels(Locale::getEnglish(), status).</p> 114f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 115f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <h2>Direct Use</h2> 116f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <p>The following shows an example of building an index directly. 117f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The "show..." methods below are just to illustrate usage. 118b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 119b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <pre> 120b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * // Create a simple index. "Item" is assumed to be an application 121b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * // defined type that the application's UI and other processing knows about, 122b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * // and that has a name. 123b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 124b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * UErrorCode status = U_ZERO_ERROR; 125b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * AlphabeticIndex index = new AlphabeticIndex(desiredLocale, status); 126b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * index->addLabels(additionalLocale, status); 127b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * for (Item *item in some source of Items ) { 128b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * index->addRecord(item->name(), item, status); 129b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * } 130b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * ... 131b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * // Show index at top. We could skip or gray out empty buckets 132b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 133b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * while (index->nextBucket(status)) { 134b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * if (showAll || index->getBucketRecordCount() != 0) { 135b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * showLabelAtTop(UI, index->getBucketLabel()); 136b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * } 137b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * } 138b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * ... 139b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * // Show the buckets with their contents, skipping empty buckets 140b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 141b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * index->resetBucketIterator(status); 142b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * while (index->nextBucket(status)) { 143b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * if (index->getBucketRecordCount() != 0) { 144b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * showLabelInList(UI, index->getBucketLabel()); 145b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * while (index->nextRecord(status)) { 146b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * showIndexedItem(UI, static_cast<Item *>(index->getRecordData())) 147b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * </pre> 148b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 149b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The caller can build different UIs using this class. 150b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * For example, an index character could be omitted or grayed-out 151b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * if its bucket is empty. Small buckets could also be combined based on size, such as: 152b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 153b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <pre> 154b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <b>... A-F G-N O-Z ...</b> 155b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * </pre> 156b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 157f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <h2>Client Support</h2> 158f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <p>Callers can also use the AlphabeticIndex::ImmutableIndex, or the AlphabeticIndex itself, 159f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * to support sorting on a client that doesn't support AlphabeticIndex functionality. 160f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 161f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <p>The ImmutableIndex is both immutable and thread-safe. 162f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The corresponding AlphabeticIndex methods are not thread-safe because 163f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * they "lazily" build the index buckets. 164b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * <ul> 165f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <li>ImmutableIndex.getBucket(index) provides random access to all 166f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * buckets and their labels and label types. 167f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <li>The AlphabeticIndex bucket iterator or ImmutableIndex.getBucket(0..getBucketCount-1) 168f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * can be used to get a list of the labels, 169f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * such as "...", "A", "B",..., and send that list to the client. 170f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <li>When the client has a new name, it sends that name to the server. 171f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The server needs to call the following methods, 172f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * and communicate the bucketIndex and collationKey back to the client. 173f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 174f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <pre> 175f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * int32_t bucketIndex = index.getBucketIndex(name, status); 176f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * const UnicodeString &label = immutableIndex.getBucket(bucketIndex)->getLabel(); // optional 177f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * int32_t skLength = collator.getSortKey(name, sk, skCapacity); 178f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * </pre> 179f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 180f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * <li>The client would put the name (and associated information) into its bucket for bucketIndex. The sort key sk is a 181f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * sequence of bytes that can be compared with a binary compare, and produce the right localized result.</li> 182b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * </ul> 183b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 184103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 185b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 186b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoclass U_I18N_API AlphabeticIndex: public UObject { 187f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Corneliuspublic: 188f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 189f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * An index "bucket" with a label string and type. 190f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * It is referenced by getBucketIndex(), 191f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * and returned by ImmutableIndex.getBucket(). 192f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 193f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The Bucket class is not intended for public subclassing. 194fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 195f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 196f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius class U_I18N_API Bucket : public UObject { 197f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius public: 198f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 199f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Destructor. 200fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 201f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 202f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius virtual ~Bucket(); 203f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 204f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 205f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Returns the label string. 206f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 207f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @return the label string for the bucket 208fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 209f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 210f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius const UnicodeString &getLabel() const { return label_; } 211f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 212f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Returns whether this bucket is a normal, underflow, overflow, or inflow bucket. 213f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 214f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @return the bucket label type 215fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 216f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 217f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UAlphabeticIndexLabelType getLabelType() const { return labelType_; } 218f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 219f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius private: 220f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius friend class AlphabeticIndex; 221f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius friend class BucketList; 222f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 223f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeString label_; 224f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeString lowerBoundary_; 225f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UAlphabeticIndexLabelType labelType_; 226f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius Bucket *displayBucket_; 227f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius int32_t displayIndex_; 228f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UVector *records_; // Records are owned by the inputList_ vector. 229f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 230f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius Bucket(const UnicodeString &label, // Parameter strings are copied. 231f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius const UnicodeString &lowerBoundary, 232f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UAlphabeticIndexLabelType type); 233f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius }; 234b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 235f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 236f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Immutable, thread-safe version of AlphabeticIndex. 237f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * This class provides thread-safe methods for bucketing, 238f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * and random access to buckets and their properties, 239f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * but does not offer adding records to the index. 240f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 241f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The ImmutableIndex class is not intended for public subclassing. 242f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 243fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 244f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 245f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius class U_I18N_API ImmutableIndex : public UObject { 246f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius public: 247f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 248f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Destructor. 249fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 250f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 251f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius virtual ~ImmutableIndex(); 252f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 253f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 254f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Returns the number of index buckets and labels, including underflow/inflow/overflow. 255f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 256f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @return the number of index buckets 257fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 258f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 259f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius int32_t getBucketCount() const; 260f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 261f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 262f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Finds the index bucket for the given name and returns the number of that bucket. 263f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Use getBucket() to get the bucket's properties. 264f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 265f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @param name the string to be sorted into an index bucket 266f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @return the bucket number for the name 267fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 268f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 269f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius int32_t getBucketIndex(const UnicodeString &name, UErrorCode &errorCode) const; 270f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 271f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 272f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Returns the index-th bucket. Returns NULL if the index is out of range. 273f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 274f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @param index bucket number 275f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @return the index-th bucket 276fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 277f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 278f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius const Bucket *getBucket(int32_t index) const; 279f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 280f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius private: 281f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius friend class AlphabeticIndex; 282f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 283f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius ImmutableIndex(BucketList *bucketList, Collator *collatorPrimaryOnly) 284f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius : buckets_(bucketList), collatorPrimaryOnly_(collatorPrimaryOnly) {} 285f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius 286f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius BucketList *buckets_; 287f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius Collator *collatorPrimaryOnly_; 288f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius }; 289b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 290b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 291b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Construct an AlphabeticIndex object for the specified locale. If the locale's 292b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * data does not include index characters, a set of them will be 293b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * synthesized based on the locale's exemplar characters. The locale 294b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * determines the sorting order for both the index characters and the 295b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * user item names appearing under each Index character. 296b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 297b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param locale the desired locale. 298b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the construction 299b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * of the AlphabeticIndex object fails. 300103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 301b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 302b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho AlphabeticIndex(const Locale &locale, UErrorCode &status); 303b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 304f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 305f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Construct an AlphabeticIndex that uses a specific collator. 306f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 307f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The index will be created with no labels; the addLabels() function must be called 308f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * after creation to add the desired labels to the index. 309f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 310f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The index adopts the collator, and is responsible for deleting it. 311f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The caller should make no further use of the collator after creating the index. 312f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 313f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @param collator The collator to use to order the contents of this index. 314f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @param status Error code, will be set with the reason if the 315f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * operation fails. 316fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 317f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 318f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius AlphabeticIndex(RuleBasedCollator *collator, UErrorCode &status); 319b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 320b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 321b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Add Labels to this Index. The labels are additions to those 322b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * that are already in the index; they do not replace the existing 323b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * ones. 324b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param additions The additional characters to add to the index, such as A-Z. 325b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the 326b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * operation fails. 327b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return this, for chaining 328103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 329b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 330f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius virtual AlphabeticIndex &addLabels(const UnicodeSet &additions, UErrorCode &status); 331b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 332b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 333b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Add the index characters from a Locale to the index. The labels 334b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * are added to those that are already in the index; they do not replace the 335b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * existing index characters. The collation order for this index is not 336b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * changed; it remains that of the locale that was originally specified 337b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * when creating this Index. 338b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 339b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param locale The locale whose index characters are to be added. 340b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the 341b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * operation fails. 342b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return this, for chaining 343103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 344b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 345f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius virtual AlphabeticIndex &addLabels(const Locale &locale, UErrorCode &status); 346b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 347b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 348b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Destructor 349103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 350b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 351f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius virtual ~AlphabeticIndex(); 352b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 353f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 354f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Builds an immutable, thread-safe version of this instance, without data records. 355f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * 356f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @return an immutable index instance 357fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius * @stable ICU 51 358f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 359f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius ImmutableIndex *buildImmutableIndex(UErrorCode &errorCode); 360b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 361b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 362b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the Collator that establishes the ordering of the items in this index. 363b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Ownership of the collator remains with the AlphabeticIndex instance. 364b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 365b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The returned collator is a reference to the internal collator used by this 366b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * index. It may be safely used to compare the names of items or to get 367b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * sort keys for names. However if any settings need to be changed, 368b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * or other non-const methods called, a cloned copy must be made first. 369b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 370b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return The collator 371103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 372b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 373b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual const RuleBasedCollator &getCollator() const; 374b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 375b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 376b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 377b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the default label used for abbreviated buckets <i>between</i> other index characters. 378b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * For example, consider the labels when Latin and Greek are used: 379b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * X Y Z ... Α Β Γ. 380b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 381b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return inflow label 382103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 383b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 384b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual const UnicodeString &getInflowLabel() const; 385b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 386b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 387b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Set the default label used for abbreviated buckets <i>between</i> other index characters. 388b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * An inflow label will be automatically inserted if two otherwise-adjacent label characters 389b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * are from different scripts, e.g. Latin and Cyrillic, and a third script, e.g. Greek, 390b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * sorts between the two. The default inflow character is an ellipsis (...) 391b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 392b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param inflowLabel the new Inflow label. 393b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 394b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return this 395103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 396b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 397b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &setInflowLabel(const UnicodeString &inflowLabel, UErrorCode &status); 398b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 399b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 400b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 401b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the special label used for items that sort after the last normal label, 402b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * and that would not otherwise have an appropriate label. 403b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 404b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return the overflow label 405103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 406b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 407b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual const UnicodeString &getOverflowLabel() const; 408b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 409b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 410b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 411b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Set the label used for items that sort after the last normal label, 412b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * and that would not otherwise have an appropriate label. 413b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 414b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param overflowLabel the new overflow label. 415b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 416b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return this 417103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 418b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 419b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &setOverflowLabel(const UnicodeString &overflowLabel, UErrorCode &status); 420b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 421b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 422b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the special label used for items that sort before the first normal label, 423b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * and that would not otherwise have an appropriate label. 424b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 425b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return underflow label 426103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 427b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 428b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual const UnicodeString &getUnderflowLabel() const; 429b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 430b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 431b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Set the label used for items that sort before the first normal label, 432b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * and that would not otherwise have an appropriate label. 433b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 434b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param underflowLabel the new underflow label. 435b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 436b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return this 437103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 438b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 439b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &setUnderflowLabel(const UnicodeString &underflowLabel, UErrorCode &status); 440b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 441b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 442b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 443b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the limit on the number of labels permitted in the index. 444b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The number does not include over, under and inflow labels. 445b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 446b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return maxLabelCount maximum number of labels. 447103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 448b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 449b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual int32_t getMaxLabelCount() const; 450b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 451b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 452b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Set a limit on the number of labels permitted in the index. 453b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * The number does not include over, under and inflow labels. 454b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Currently, if the number is exceeded, then every 455b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * nth item is removed to bring the count down. 456b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * A more sophisticated mechanism may be available in the future. 457b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 458b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param maxLabelCount the maximum number of labels. 459b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status error code 460b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return This, for chaining 461103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 462b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 463b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &setMaxLabelCount(int32_t maxLabelCount, UErrorCode &status); 464b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 465b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 466b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 467b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Add a record to the index. Each record will be associated with an index Bucket 468b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * based on the record's name. The list of records for each bucket will be sorted 469b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * based on the collation ordering of the names in the index's locale. 470b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Records with duplicate names are permitted; they will be kept in the order 471b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * that they were added. 472b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 473b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param name The display name for the Record. The Record will be placed in 474b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * a bucket based on this name. 475b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param data An optional pointer to user data associated with this 476b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * item. When iterating the contents of a bucket, both the 477b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * data pointer the name will be available for each Record. 478b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 479b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return This, for chaining. 480103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 481b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 482b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &addRecord(const UnicodeString &name, const void *data, UErrorCode &status); 483b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 484b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 485b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Remove all Records from the Index. The set of Buckets, which define the headings under 486b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * which records are classified, is not altered. 487b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 488b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 489b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return This, for chaining. 490103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 491b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 492b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &clearRecords(UErrorCode &status); 493b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 494b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 495b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** Get the number of labels in this index. 496b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Note: may trigger lazy index construction. 497b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 498b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 499b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return The number of labels in this index, including any under, over or 500b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * in-flow labels. 501103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 502b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 503b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual int32_t getBucketCount(UErrorCode &status); 504b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 505b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 506b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** Get the total number of Records in this index, that is, the number 507b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * of <name, data> pairs added. 508b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 509b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 510b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return The number of records in this index, that is, the total number 511b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * of (name, data) items added with addRecord(). 512103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 513b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 514b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual int32_t getRecordCount(UErrorCode &status); 515b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 516b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 517b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 518b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 519b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Given the name of a record, return the zero-based index of the Bucket 520b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * in which the item should appear. The name need not be in the index. 521b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * A Record will not be added to the index by this function. 522b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Bucket numbers are zero-based, in Bucket iteration order. 523b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 524b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param itemName The name whose bucket position in the index is to be determined. 525b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 526b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return The bucket number for this name. 527103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 528b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 529b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 530b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual int32_t getBucketIndex(const UnicodeString &itemName, UErrorCode &status); 531b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 532b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 533b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 534b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the zero based index of the current Bucket from an iteration 535b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * over the Buckets of this index. Return -1 if no iteration is in process. 536b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return the index of the current Bucket 537103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 538b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 539b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual int32_t getBucketIndex() const; 540b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 541b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 542b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 543b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Advance the iteration over the Buckets of this index. Return FALSE if 544b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * there are no more Buckets. 545b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 546b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 547b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * U_ENUM_OUT_OF_SYNC_ERROR will be reported if the index is modified while 548b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * an enumeration of its contents are in process. 549b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 550b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return TRUE if success, FALSE if at end of iteration 551103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 552b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 553b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual UBool nextBucket(UErrorCode &status); 554b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 555b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 556b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Return the name of the Label of the current bucket from an iteration over the buckets. 557b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * If the iteration is before the first Bucket (nextBucket() has not been called), 558b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * or after the last, return an empty string. 559b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 560b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return the bucket label. 561103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 562b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 563b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual const UnicodeString &getBucketLabel() const; 564b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 565b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 566b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Return the type of the label for the current Bucket (selected by the 567b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * iteration over Buckets.) 568b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 569b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return the label type. 570103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 571b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 572b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual UAlphabeticIndexLabelType getBucketLabelType() const; 573b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 574b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 575b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the number of <name, data> Records in the current Bucket. 576b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * If the current bucket iteration position is before the first label or after the 577b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * last, return 0. 578b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 579b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return the number of Records. 580103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 581b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 582b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual int32_t getBucketRecordCount() const; 583b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 584b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 585b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 586b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Reset the Bucket iteration for this index. The next call to nextBucket() 587b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * will restart the iteration at the first label. 588b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 589b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 590b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return this, for chaining. 591103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 592b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 593b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &resetBucketIterator(UErrorCode &status); 594b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 595b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 596b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Advance to the next record in the current Bucket. 597b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * When nextBucket() is called, Record iteration is reset to just before the 598b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * first Record in the new Bucket. 599b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 600b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @param status Error code, will be set with the reason if the operation fails. 601b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * U_ENUM_OUT_OF_SYNC_ERROR will be reported if the index is modified while 602b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * an enumeration of its contents are in process. 603b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return TRUE if successful, FALSE when the iteration advances past the last item. 604103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 605b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 606b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual UBool nextRecord(UErrorCode &status); 607b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 608b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 609b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Get the name of the current Record. 610b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Return an empty string if the Record iteration position is before first 611b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * or after the last. 612b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 613b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return The name of the current index item. 614103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 615b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 616b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual const UnicodeString &getRecordName() const; 617b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 618b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 619b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 620b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Return the data pointer of the Record currently being iterated over. 621b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Return NULL if the current iteration position before the first item in this Bucket, 622b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * or after the last. 623b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 624b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return The current Record's data pointer. 625103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 626b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 627b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual const void *getRecordData() const; 628b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 629b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 630b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 631b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Reset the Record iterator position to before the first Record in the current Bucket. 632b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * 633b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @return This, for chaining. 634103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius * @stable ICU 4.8 635b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 636b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual AlphabeticIndex &resetRecordIterator(); 637b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 638b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoprivate: 639b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 640b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * No Copy constructor. 641b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @internal 642b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 643b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho AlphabeticIndex(const AlphabeticIndex &other); 644b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 645b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 646b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * No assignment. 647b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 648b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho AlphabeticIndex &operator =(const AlphabeticIndex & /*other*/) { return *this;}; 649b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 650b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 651b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * No Equality operators. 652b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @internal 653b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 654b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual UBool operator==(const AlphabeticIndex& other) const; 655b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 656b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 657b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * Inequality operator. 658b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @internal 659b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 660b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho virtual UBool operator!=(const AlphabeticIndex& other) const; 661b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 662b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho // Common initialization, for use from all constructors. 663f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius void init(const Locale *locale, UErrorCode &status); 664b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 665f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 666f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * This method is called to get the index exemplars. Normally these come from the locale directly, 667f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * but if they aren't available, we have to synthesize them. 668f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 669fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius void addIndexExemplars(const Locale &locale, UErrorCode &status); 670f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 671f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Add Chinese index characters from the tailoring. 672f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 673f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UBool addChineseIndexCharacters(UErrorCode &errorCode); 674b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 675f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UVector *firstStringsInScript(UErrorCode &status); 676b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 677f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius static UnicodeString separated(const UnicodeString &item); 678b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 679f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius /** 680f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Determine the best labels to use. 681f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * This is based on the exemplars, but we also process to make sure that they are unique, 682f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * and sort differently, and that the overall list is small enough. 683f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 684f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius void initLabels(UVector &indexCharacters, UErrorCode &errorCode) const; 685f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius BucketList *createBucketList(UErrorCode &errorCode) const; 686f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius void initBuckets(UErrorCode &errorCode); 687f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius void clearBuckets(); 688f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius void internalResetBucketIterator(); 689b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 690f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Corneliuspublic: 691b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 692f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // The Record is declared public only to allow access from 693f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // implementation code written in plain C. 694f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // It is not intended for public use. 695b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 696103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius#ifndef U_HIDE_INTERNAL_API 697b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 698f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * A (name, data) pair, to be sorted by name into one of the index buckets. 699f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * The user data is not used by the index implementation. 700b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho * @internal 701b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho */ 702f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius struct Record: public UMemory { 703f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius const UnicodeString name_; 704f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius const void *data_; 705f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius Record(const UnicodeString &name, const void *data); 706f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius ~Record(); 707f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius }; 708103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius#endif /* U_HIDE_INTERNAL_API */ 709b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 710f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Corneliusprivate: 711b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 712b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho /** 713f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Holds all user records before they are distributed into buckets. 714f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * Type of contents is (Record *) 715f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius * @internal 716f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius */ 717f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UVector *inputList_; 718b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 719f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius int32_t labelsIterIndex_; // Index of next item to return. 720f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius int32_t itemsIterIndex_; 721f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius Bucket *currentBucket_; // While an iteration of the index in underway, 722f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // point to the bucket for the current label. 723f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // NULL when no iteration underway. 724b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 725f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius int32_t maxLabelCount_; // Limit on # of labels permitted in the index. 726b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 727f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeSet *initialLabels_; // Initial (unprocessed) set of Labels. Union 728f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // of those explicitly set by the user plus 729f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // those from locales. Raw values, before 730f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // crunching into bucket labels. 731b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 732f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UVector *firstCharsInScripts_; // The first character from each script, 733f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // in collation order. 734b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 735f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius RuleBasedCollator *collator_; 736f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius RuleBasedCollator *collatorPrimaryOnly_; 737b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 738f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius // Lazy evaluated: null means that we have not built yet. 739f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius BucketList *buckets_; 740b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 741f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeString inflowLabel_; 742f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeString overflowLabel_; 743f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeString underflowLabel_; 744f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeString overflowComparisonString_; 745b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 746f760e5e9e080f32b3afdfaea0b961ce09eb052f4Craig Cornelius UnicodeString emptyString_; 747b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho}; 748b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 749b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2clairehoU_NAMESPACE_END 750b26ce3a7367e4ed2ee7ddddcdc3f3d3377a455c2claireho 751fceb39872958b9fa2505e63f8b8699a9e0f882f4ccornelius#endif // !UCONFIG_NO_COLLATION 752103e9ffba2cba345d0078eb8b8db33249f81840aCraig Cornelius#endif 753