<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ICU 4.8.1.1: AlphabeticIndex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ICU 4.8.1.1
 <span id="projectnumber">4.8.1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">AlphabeticIndex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>class <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> supports the creation of a UI index appropriate for a given language, such as:
<a href="classAlphabeticIndex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for AlphabeticIndex:</div>
<div class="dyncontent">
<div class="center">
<img src="classAlphabeticIndex.png" usemap="#AlphabeticIndex_map" alt=""/>
<map id="AlphabeticIndex_map" name="AlphabeticIndex_map">
<area href="classUObject.html" title="UObject is the common ICU "boilerplate" class." alt="UObject" shape="rect" coords="0,56,102,80"/>
<area href="classUMemory.html" title="UMemory is the common ICU base class." alt="UMemory" shape="rect" coords="0,0,102,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAlphabeticIndex_1_1Bucket.html">Bucket</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> holds an index label and references to everything belonging to that label. <a href="structAlphabeticIndex_1_1Bucket.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAlphabeticIndex_1_1Record.html">Record</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A record, or item, in the index. <a href="structAlphabeticIndex_1_1Record.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad20af51c0447c195a9a341c2bd990712"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712">ELangType</a> { <a class="el" href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712ae19ea3620d3a91e07e20441dda79e01b">kNormal</a>,
<a class="el" href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712aa3ced2f02625e001be2d391c7b38f8ff">kSimplified</a>,
<a class="el" href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712a3ead1bb95256b711ac30417c2d6d693d">kTraditional</a>
}</td></tr>
<tr class="memdesc:ad20af51c0447c195a9a341c2bd990712"><td class="mdescLeft"> </td><td class="mdescRight">Language Types. <a href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad037b1af32d29cc1521bf82634c808d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#ad037b1af32d29cc1521bf82634c808d9">AlphabeticIndex</a> (const <a class="el" href="classLocale.html">Locale</a> &locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:ad037b1af32d29cc1521bf82634c808d9"><td class="mdescLeft"> </td><td class="mdescRight">Construct an <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> object for the specified locale. <a href="#ad037b1af32d29cc1521bf82634c808d9"></a><br/></td></tr>
<tr class="memitem:a3e53fcf26fb65f624dad39d4c5bd8cb1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a3e53fcf26fb65f624dad39d4c5bd8cb1">addLabels</a> (const <a class="el" href="classUnicodeSet.html">UnicodeSet</a> &additions, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a3e53fcf26fb65f624dad39d4c5bd8cb1"><td class="mdescLeft"> </td><td class="mdescRight">Add Labels to this Index. <a href="#a3e53fcf26fb65f624dad39d4c5bd8cb1"></a><br/></td></tr>
<tr class="memitem:a0abd6bc7ef45e7c2eb361188e3aebea2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a0abd6bc7ef45e7c2eb361188e3aebea2">addLabels</a> (const <a class="el" href="classLocale.html">Locale</a> &locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a0abd6bc7ef45e7c2eb361188e3aebea2"><td class="mdescLeft"> </td><td class="mdescRight">Add the index characters from a <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a> to the index. <a href="#a0abd6bc7ef45e7c2eb361188e3aebea2"></a><br/></td></tr>
<tr class="memitem:a770a49eccf2b3f89d6da7f7688caef56"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a770a49eccf2b3f89d6da7f7688caef56">~AlphabeticIndex</a> ()</td></tr>
<tr class="memdesc:a770a49eccf2b3f89d6da7f7688caef56"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a770a49eccf2b3f89d6da7f7688caef56"></a><br/></td></tr>
<tr class="memitem:ad91a05e8649f7e7e8f9f2581d1fe8cf9"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#ad91a05e8649f7e7e8f9f2581d1fe8cf9">getCollator</a> () const </td></tr>
<tr class="memdesc:ad91a05e8649f7e7e8f9f2581d1fe8cf9"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classCollator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> that establishes the ordering of the items in this index. <a href="#ad91a05e8649f7e7e8f9f2581d1fe8cf9"></a><br/></td></tr>
<tr class="memitem:af47b1f1dedbf4658a7b1b3494c933daf"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#af47b1f1dedbf4658a7b1b3494c933daf">getInflowLabel</a> () const </td></tr>
<tr class="memdesc:af47b1f1dedbf4658a7b1b3494c933daf"><td class="mdescLeft"> </td><td class="mdescRight">Get the default label used for abbreviated buckets <em>between</em> other index characters. <a href="#af47b1f1dedbf4658a7b1b3494c933daf"></a><br/></td></tr>
<tr class="memitem:a9396297bd37ac793035919962b5f86c1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a9396297bd37ac793035919962b5f86c1">setInflowLabel</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &inflowLabel, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a9396297bd37ac793035919962b5f86c1"><td class="mdescLeft"> </td><td class="mdescRight">Set the default label used for abbreviated buckets <em>between</em> other index characters. <a href="#a9396297bd37ac793035919962b5f86c1"></a><br/></td></tr>
<tr class="memitem:a3c715296f67285c496a6f8ebc8cc877b"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a3c715296f67285c496a6f8ebc8cc877b">getOverflowLabel</a> () const </td></tr>
<tr class="memdesc:a3c715296f67285c496a6f8ebc8cc877b"><td class="mdescLeft"> </td><td class="mdescRight">Get the special label used for items that sort after the last normal label, and that would not otherwise have an appropriate label. <a href="#a3c715296f67285c496a6f8ebc8cc877b"></a><br/></td></tr>
<tr class="memitem:afc12abed4c5215414b26c0f95fbd2ba7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#afc12abed4c5215414b26c0f95fbd2ba7">setOverflowLabel</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &overflowLabel, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:afc12abed4c5215414b26c0f95fbd2ba7"><td class="mdescLeft"> </td><td class="mdescRight">Set the label used for items that sort after the last normal label, and that would not otherwise have an appropriate label. <a href="#afc12abed4c5215414b26c0f95fbd2ba7"></a><br/></td></tr>
<tr class="memitem:a1f69442f2421f7dbbca97e26d760dd30"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a1f69442f2421f7dbbca97e26d760dd30">getUnderflowLabel</a> () const </td></tr>
<tr class="memdesc:a1f69442f2421f7dbbca97e26d760dd30"><td class="mdescLeft"> </td><td class="mdescRight">Get the special label used for items that sort before the first normal label, and that would not otherwise have an appropriate label. <a href="#a1f69442f2421f7dbbca97e26d760dd30"></a><br/></td></tr>
<tr class="memitem:a32d8bbc8273e04ff01050de0e7e08e8e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a32d8bbc8273e04ff01050de0e7e08e8e">setUnderflowLabel</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &underflowLabel, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a32d8bbc8273e04ff01050de0e7e08e8e"><td class="mdescLeft"> </td><td class="mdescRight">Set the label used for items that sort before the first normal label, and that would not otherwise have an appropriate label. <a href="#a32d8bbc8273e04ff01050de0e7e08e8e"></a><br/></td></tr>
<tr class="memitem:ad49996f93228d8609de73f6a64168373"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#ad49996f93228d8609de73f6a64168373">getMaxLabelCount</a> () const </td></tr>
<tr class="memdesc:ad49996f93228d8609de73f6a64168373"><td class="mdescLeft"> </td><td class="mdescRight">Get the limit on the number of labels permitted in the index. <a href="#ad49996f93228d8609de73f6a64168373"></a><br/></td></tr>
<tr class="memitem:ac74db7633495b59fb86745890526fb09"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#ac74db7633495b59fb86745890526fb09">setMaxLabelCount</a> (<a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> maxLabelCount, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:ac74db7633495b59fb86745890526fb09"><td class="mdescLeft"> </td><td class="mdescRight">Set a limit on the number of labels permitted in the index. <a href="#ac74db7633495b59fb86745890526fb09"></a><br/></td></tr>
<tr class="memitem:adcbeb34197b04b075adab28de566aa35"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#adcbeb34197b04b075adab28de566aa35">getOverflowComparisonString</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &lowerLimit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:adcbeb34197b04b075adab28de566aa35"><td class="mdescLeft"> </td><td class="mdescRight">Get the Unicode character (or tailored string) that defines an overflow bucket; that is anything greater than or equal to that string should go in that bucket, instead of with the last character. <a href="#adcbeb34197b04b075adab28de566aa35"></a><br/></td></tr>
<tr class="memitem:a2d8f8ac595a41f1dd63ffaf78a4dde20"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a2d8f8ac595a41f1dd63ffaf78a4dde20">addRecord</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &name, const void *data, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a2d8f8ac595a41f1dd63ffaf78a4dde20"><td class="mdescLeft"> </td><td class="mdescRight">Add a record to the index. <a href="#a2d8f8ac595a41f1dd63ffaf78a4dde20"></a><br/></td></tr>
<tr class="memitem:a11d3077ac9d02bcb617265e67d91d38b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a11d3077ac9d02bcb617265e67d91d38b">clearRecords</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a11d3077ac9d02bcb617265e67d91d38b"><td class="mdescLeft"> </td><td class="mdescRight">Remove all Records from the Index. <a href="#a11d3077ac9d02bcb617265e67d91d38b"></a><br/></td></tr>
<tr class="memitem:a74615b5157cf44cc1cd645cf198a5bd9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a74615b5157cf44cc1cd645cf198a5bd9">getBucketCount</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a74615b5157cf44cc1cd645cf198a5bd9"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of labels in this index. <a href="#a74615b5157cf44cc1cd645cf198a5bd9"></a><br/></td></tr>
<tr class="memitem:a17f4a6c2dcccd15528e036921a26ae07"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a17f4a6c2dcccd15528e036921a26ae07">getRecordCount</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a17f4a6c2dcccd15528e036921a26ae07"><td class="mdescLeft"> </td><td class="mdescRight">Get the total number of Records in this index, that is, the number of <name, data> pairs added. <a href="#a17f4a6c2dcccd15528e036921a26ae07"></a><br/></td></tr>
<tr class="memitem:a30a605dc012b33b6b6f2cd4e4a3fa496"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a30a605dc012b33b6b6f2cd4e4a3fa496">getBucketIndex</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &itemName, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a30a605dc012b33b6b6f2cd4e4a3fa496"><td class="mdescLeft"> </td><td class="mdescRight">Given the name of a record, return the zero-based index of the <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> in which the item should appear. <a href="#a30a605dc012b33b6b6f2cd4e4a3fa496"></a><br/></td></tr>
<tr class="memitem:a787976cd5e88b44157e718f19c6847f8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a787976cd5e88b44157e718f19c6847f8">getBucketIndex</a> () const </td></tr>
<tr class="memdesc:a787976cd5e88b44157e718f19c6847f8"><td class="mdescLeft"> </td><td class="mdescRight">Get the zero based index of the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> from an iteration over the Buckets of this index. <a href="#a787976cd5e88b44157e718f19c6847f8"></a><br/></td></tr>
<tr class="memitem:aefa336cda70e3e48ae1c4396decd295a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#aefa336cda70e3e48ae1c4396decd295a">nextBucket</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:aefa336cda70e3e48ae1c4396decd295a"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iteration over the Buckets of this index. <a href="#aefa336cda70e3e48ae1c4396decd295a"></a><br/></td></tr>
<tr class="memitem:a35d4c28c749701f93da5c9d1bd6bd6f0"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a35d4c28c749701f93da5c9d1bd6bd6f0">getBucketLabel</a> () const </td></tr>
<tr class="memdesc:a35d4c28c749701f93da5c9d1bd6bd6f0"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the Label of the current bucket from an iteration over the buckets. <a href="#a35d4c28c749701f93da5c9d1bd6bd6f0"></a><br/></td></tr>
<tr class="memitem:a2ec5721b315b47b86637c8c5bb4de7bb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="alphaindex_8h.html#a969464092cba264934f2c66c7c621dc8">UAlphabeticIndexLabelType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a2ec5721b315b47b86637c8c5bb4de7bb">getBucketLabelType</a> () const </td></tr>
<tr class="memdesc:a2ec5721b315b47b86637c8c5bb4de7bb"><td class="mdescLeft"> </td><td class="mdescRight">Return the type of the label for the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> (selected by the iteration over Buckets.) <a href="#a2ec5721b315b47b86637c8c5bb4de7bb"></a><br/></td></tr>
<tr class="memitem:abc115f3f29ffd8f6a6665a091db286e0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#abc115f3f29ffd8f6a6665a091db286e0">getBucketRecordCount</a> () const </td></tr>
<tr class="memdesc:abc115f3f29ffd8f6a6665a091db286e0"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of <name, data> Records in the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>. <a href="#abc115f3f29ffd8f6a6665a091db286e0"></a><br/></td></tr>
<tr class="memitem:a7785cc956f67016ca585969aeb50a032"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a7785cc956f67016ca585969aeb50a032">resetBucketIterator</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a7785cc956f67016ca585969aeb50a032"><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> iteration for this index. <a href="#a7785cc956f67016ca585969aeb50a032"></a><br/></td></tr>
<tr class="memitem:a2caa4800a3bbd7643ab204c163ddf126"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a2caa4800a3bbd7643ab204c163ddf126">nextRecord</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a2caa4800a3bbd7643ab204c163ddf126"><td class="mdescLeft"> </td><td class="mdescRight">Advance to the next record in the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>. <a href="#a2caa4800a3bbd7643ab204c163ddf126"></a><br/></td></tr>
<tr class="memitem:a82392f8751e5f7ff423a42e29567c99f"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a82392f8751e5f7ff423a42e29567c99f">getRecordName</a> () const </td></tr>
<tr class="memdesc:a82392f8751e5f7ff423a42e29567c99f"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the current <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a>. <a href="#a82392f8751e5f7ff423a42e29567c99f"></a><br/></td></tr>
<tr class="memitem:a1d4d90a51c674ff2e794484173a41a92"><td class="memItemLeft" align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a1d4d90a51c674ff2e794484173a41a92">getRecordData</a> () const </td></tr>
<tr class="memdesc:a1d4d90a51c674ff2e794484173a41a92"><td class="mdescLeft"> </td><td class="mdescRight">Return the data pointer of the <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> currently being iterated over. <a href="#a1d4d90a51c674ff2e794484173a41a92"></a><br/></td></tr>
<tr class="memitem:a7b2c382730d338e4fabb886640319137"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a7b2c382730d338e4fabb886640319137">resetRecordIterator</a> ()</td></tr>
<tr class="memdesc:a7b2c382730d338e4fabb886640319137"><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> iterator position to before the first <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> in the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>. <a href="#a7b2c382730d338e4fabb886640319137"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classUObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classUObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classUObject.html">UObject</a></td></tr>
<tr class="memitem:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUObject.html#ace22cf29a90641ef43350deae5bedb85">~UObject</a> ()</td></tr>
<tr class="memdesc:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ace22cf29a90641ef43350deae5bedb85"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a10d496623339498a76b3238b1b407add"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a10d496623339498a76b3238b1b407add">staticCleanup</a> ()</td></tr>
<tr class="memdesc:a10d496623339498a76b3238b1b407add"><td class="mdescLeft"> </td><td class="mdescRight">Delete all shared (static) data associated with an <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a>. <a href="#a10d496623339498a76b3238b1b407add"></a><br/></td></tr>
<tr class="memitem:a78121d74fad8dc8014ff74457f0b3e95"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712">ELangType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a78121d74fad8dc8014ff74457f0b3e95">langTypeFromLocale</a> (const <a class="el" href="classLocale.html">Locale</a> &loc)</td></tr>
<tr class="memdesc:a78121d74fad8dc8014ff74457f0b3e95"><td class="mdescLeft"> </td><td class="mdescRight">Get the Language Type for this Index. <a href="#a78121d74fad8dc8014ff74457f0b3e95"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a57710f17956e43f73d9beb7943c1fdbc"><td class="memItemLeft" align="right" valign="top">UVector * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAlphabeticIndex.html#a57710f17956e43f73d9beb7943c1fdbc">inputRecords_</a></td></tr>
<tr class="memdesc:a57710f17956e43f73d9beb7943c1fdbc"><td class="mdescLeft"> </td><td class="mdescRight">Holds all user records before they are distributed into buckets. <a href="#a57710f17956e43f73d9beb7943c1fdbc"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>class <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> supports the creation of a UI index appropriate for a given language, such as: </p>
<pre>
<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 \u00C6 \u00D8 \u00C5 ...</b></pre><pre> <b>A</b>
Addison
Albertson
Azensky
<b>B</b>
Baker
...
</pre><p>The class can generate a list of labels for use as a UI "index", that is, a list of clickable characters (or character sequences) that allow the user to see a segment (bucket) of a larger "target" list. That is, each label 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). Strings can be added to the index; they will be in sorted order in the right bucket. </p>
<p>The class also supports having buckets for strings before the first (underflow), after the last (overflow), and between scripts (inflow). For example, if the index is constructed with labels for Russian and English, Greek characters would fall into an inflow bucket between the other two scripts. </p>
<p>The <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> class is not intended for public subclassing. </p>
<p><em>Example</em> </p>
<p>The "show..." methods below are just to illustrate usage.</p>
<pre>
// Create a simple index. "Item" is assumed to be an application
// defined type that the application's UI and other processing knows about,
// and that has a name.</pre><pre> UErrorCode status = U_ZERO_ERROR;
<a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> index = new AlphabeticIndex(desiredLocale, status);
index->addLabels(additionalLocale, status);
for (Item *item in some source of Items ) {
index->addRecord(item->name(), item, status);
}
...
// Show index at top. We could skip or gray out empty buckets</pre><pre> while (index->nextBucket(status)) {
if (showAll || index-><a class="el" href="classAlphabeticIndex.html#abc115f3f29ffd8f6a6665a091db286e0" title="Get the number of <name, data> Records in the current Bucket.">getBucketRecordCount()</a> != 0) {
showLabelAtTop(UI, index-><a class="el" href="classAlphabeticIndex.html#a35d4c28c749701f93da5c9d1bd6bd6f0" title="Return the name of the Label of the current bucket from an iteration over the buckets.">getBucketLabel()</a>);
}
}
...
// Show the buckets with their contents, skipping empty buckets</pre><pre> index->resetBucketIterator(status);
while (index->nextBucket(status)) {
if (index-><a class="el" href="classAlphabeticIndex.html#abc115f3f29ffd8f6a6665a091db286e0" title="Get the number of <name, data> Records in the current Bucket.">getBucketRecordCount()</a> != 0) {
showLabelInList(UI, index-><a class="el" href="classAlphabeticIndex.html#a35d4c28c749701f93da5c9d1bd6bd6f0" title="Return the name of the Label of the current bucket from an iteration over the buckets.">getBucketLabel()</a>);
while (index->nextRecord(status)) {
showIndexedItem(UI, static_cast<Item *>(index-><a class="el" href="classAlphabeticIndex.html#a1d4d90a51c674ff2e794484173a41a92" title="Return the data pointer of the Record currently being iterated over.">getRecordData()</a>))
</pre><p>The caller can build different UIs using this class. For example, an index character could be omitted or grayed-out if its bucket is empty. Small buckets could also be combined based on size, such as:</p>
<pre>
<b>... A-F G-N O-Z ...</b>
</pre><p><b>Notes:</b> </p>
<ul>
<li>
Additional collation parameters can be passed in as part of the locale name. For example, German plus numeric sorting would be "de@kn-true". </li>
</ul>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000252">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 This API might change or be removed in a future release. </dd></dl>
<p>Definition at line <a class="el" href="alphaindex_8h_source.html#l00163">163</a> of file <a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ad20af51c0447c195a9a341c2bd990712"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712">AlphabeticIndex::ELangType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Language Types. </p>
<p>For internal ICU use only. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000197">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ad20af51c0447c195a9a341c2bd990712ae19ea3620d3a91e07e20441dda79e01b"></a>kNormal</em> </td><td>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000199">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad20af51c0447c195a9a341c2bd990712aa3ced2f02625e001be2d391c7b38f8ff"></a>kSimplified</em> </td><td>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000200">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad20af51c0447c195a9a341c2bd990712a3ead1bb95256b711ac30417c2d6d693d"></a>kTraditional</em> </td><td>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000201">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="alphaindex_8h_source.html#l00622">622</a> of file <a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad037b1af32d29cc1521bf82634c808d9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AlphabeticIndex::AlphabeticIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct an <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> object for the specified locale. </p>
<p>If the locale's data does not include index characters, a set of them will be synthesized based on the locale's exemplar characters. The locale determines the sorting order for both the index characters and the user item names appearing under each Index character.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">locale</td><td>the desired locale. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the construction of the <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> object fails. </td></tr>
</table>
</dd>
</dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000257">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a770a49eccf2b3f89d6da7f7688caef56"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual AlphabeticIndex::~AlphabeticIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000260">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3e53fcf26fb65f624dad39d4c5bd8cb1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::addLabels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeSet.html">UnicodeSet</a> & </td>
<td class="paramname"><em>additions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add Labels to this Index. </p>
<p>The labels are additions to those that are already in the index; they do not replace the existing ones. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">additions</td><td>The additional characters to add to the index, such as A-Z. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>this, for chaining </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000258">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a0abd6bc7ef45e7c2eb361188e3aebea2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::addLabels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add the index characters from a <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a> to the index. </p>
<p>The labels are added to those that are already in the index; they do not replace the existing index characters. The collation order for this index is not changed; it remains that of the locale that was originally specified when creating this Index.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">locale</td><td>The locale whose index characters are to be added. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>this, for chaining </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000259">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a2d8f8ac595a41f1dd63ffaf78a4dde20"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::addRecord </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a record to the index. </p>
<p>Each record will be associated with an index <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> based on the record's name. The list of records for each bucket will be sorted based on the collation ordering of the names in the index's locale. Records with duplicate names are permitted; they will be kept in the order that they were added.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The display name for the <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a>. The <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> will be placed in a bucket based on this name. </td></tr>
<tr><td class="paramname">data</td><td>An optional pointer to user data associated with this item. When iterating the contents of a bucket, both the data pointer the name will be available for each <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a>. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>This, for chaining. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000270">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a11d3077ac9d02bcb617265e67d91d38b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::clearRecords </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all Records from the Index. </p>
<p>The set of Buckets, which define the headings under which records are classified, is not altered.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>This, for chaining. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000271">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a74615b5157cf44cc1cd645cf198a5bd9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> AlphabeticIndex::getBucketCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of labels in this index. </p>
<pre class="fragment"> Note: may trigger lazy index construction.
</pre><dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>The number of labels in this index, including any under, over or in-flow labels. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000272">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a30a605dc012b33b6b6f2cd4e4a3fa496"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> AlphabeticIndex::getBucketIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>itemName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given the name of a record, return the zero-based index of the <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> in which the item should appear. </p>
<p>The name need not be in the index. A <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> will not be added to the index by this function. <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> numbers are zero-based, in <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> iteration order.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">itemName</td><td>The name whose bucket position in the index is to be determined. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>The bucket number for this name. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000274">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8</dd></dl>
</div>
</div>
<a class="anchor" id="a787976cd5e88b44157e718f19c6847f8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> AlphabeticIndex::getBucketIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the zero based index of the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> from an iteration over the Buckets of this index. </p>
<p>Return -1 if no iteration is in process. </p>
<dl class="section return"><dt>Returns:</dt><dd>the index of the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000275">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a35d4c28c749701f93da5c9d1bd6bd6f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>& AlphabeticIndex::getBucketLabel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the name of the Label of the current bucket from an iteration over the buckets. </p>
<p>If the iteration is before the first <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> (<a class="el" href="classAlphabeticIndex.html#aefa336cda70e3e48ae1c4396decd295a" title="Advance the iteration over the Buckets of this index.">nextBucket()</a> has not been called), or after the last, return an empty string.</p>
<dl class="section return"><dt>Returns:</dt><dd>the bucket label. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000277">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a2ec5721b315b47b86637c8c5bb4de7bb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="alphaindex_8h.html#a969464092cba264934f2c66c7c621dc8">UAlphabeticIndexLabelType</a> AlphabeticIndex::getBucketLabelType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the type of the label for the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> (selected by the iteration over Buckets.) </p>
<dl class="section return"><dt>Returns:</dt><dd>the label type. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000278">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="abc115f3f29ffd8f6a6665a091db286e0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> AlphabeticIndex::getBucketRecordCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of <name, data> Records in the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>. </p>
<p>If the current bucket iteration position is before the first label or after the last, return 0.</p>
<dl class="section return"><dt>Returns:</dt><dd>the number of Records. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000279">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="ad91a05e8649f7e7e8f9f2581d1fe8cf9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a>& AlphabeticIndex::getCollator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the <a class="el" href="classCollator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> that establishes the ordering of the items in this index. </p>
<p>Ownership of the collator remains with the <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a> instance.</p>
<p>The returned collator is a reference to the internal collator used by this index. It may be safely used to compare the names of items or to get sort keys for names. However if any settings need to be changed, or other non-const methods called, a cloned copy must be made first.</p>
<dl class="section return"><dt>Returns:</dt><dd>The collator </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000261">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="af47b1f1dedbf4658a7b1b3494c933daf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>& AlphabeticIndex::getInflowLabel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the default label used for abbreviated buckets <em>between</em> other index characters. </p>
<p>For example, consider the labels when Latin and Greek are used: X Y Z ... &#x0391; &#x0392; &#x0393;.</p>
<dl class="section return"><dt>Returns:</dt><dd>inflow label </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000262">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="ad49996f93228d8609de73f6a64168373"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> AlphabeticIndex::getMaxLabelCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the limit on the number of labels permitted in the index. </p>
<p>The number does not include over, under and inflow labels.</p>
<dl class="section return"><dt>Returns:</dt><dd>maxLabelCount maximum number of labels. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000268">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="adcbeb34197b04b075adab28de566aa35"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>& AlphabeticIndex::getOverflowComparisonString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>lowerLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the Unicode character (or tailored string) that defines an overflow bucket; that is anything greater than or equal to that string should go in that bucket, instead of with the last character. </p>
<p>Normally that is the first character of the script after lowerLimit. Thus in X Y Z ... <em>Devanagari-ka</em>, the overflow character for Z would be the <em>Greek-alpha</em>.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">lowerLimit</td><td>The character below the overflow (or inflow) bucket </td></tr>
<tr><td class="paramname">status</td><td>error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>string that defines top of the overflow buck for lowerLimit, or an empty string if there is none </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000189">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="a3c715296f67285c496a6f8ebc8cc877b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>& AlphabeticIndex::getOverflowLabel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the special label used for items that sort after the last normal label, and that would not otherwise have an appropriate label. </p>
<dl class="section return"><dt>Returns:</dt><dd>the overflow label </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000264">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a17f4a6c2dcccd15528e036921a26ae07"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> AlphabeticIndex::getRecordCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the total number of Records in this index, that is, the number of <name, data> pairs added. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>The number of records in this index, that is, the total number of (name, data) items added with <a class="el" href="classAlphabeticIndex.html#a2d8f8ac595a41f1dd63ffaf78a4dde20" title="Add a record to the index.">addRecord()</a>. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000273">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a1d4d90a51c674ff2e794484173a41a92"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const void* AlphabeticIndex::getRecordData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the data pointer of the <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> currently being iterated over. </p>
<p>Return NULL if the current iteration position before the first item in this <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>, or after the last.</p>
<dl class="section return"><dt>Returns:</dt><dd>The current <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a>'s data pointer. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000283">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a82392f8751e5f7ff423a42e29567c99f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>& AlphabeticIndex::getRecordName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the current <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a>. </p>
<p>Return an empty string if the <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> iteration position is before first or after the last.</p>
<dl class="section return"><dt>Returns:</dt><dd>The name of the current index item. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000282">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a1f69442f2421f7dbbca97e26d760dd30"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>& AlphabeticIndex::getUnderflowLabel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the special label used for items that sort before the first normal label, and that would not otherwise have an appropriate label. </p>
<dl class="section return"><dt>Returns:</dt><dd>underflow label </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000266">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a78121d74fad8dc8014ff74457f0b3e95"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classAlphabeticIndex.html#ad20af51c0447c195a9a341c2bd990712">ELangType</a> AlphabeticIndex::langTypeFromLocale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"><em>loc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the Language Type for this Index. </p>
<p>Based on the locale. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000198">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="aefa336cda70e3e48ae1c4396decd295a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> AlphabeticIndex::nextBucket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the iteration over the Buckets of this index. </p>
<p>Return FALSE if there are no more Buckets.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. U_ENUM_OUT_OF_SYNC_ERROR will be reported if the index is modified while an enumeration of its contents are in process.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>TRUE if success, FALSE if at end of iteration </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000276">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a2caa4800a3bbd7643ab204c163ddf126"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> AlphabeticIndex::nextRecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance to the next record in the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>. </p>
<p>When <a class="el" href="classAlphabeticIndex.html#aefa336cda70e3e48ae1c4396decd295a" title="Advance the iteration over the Buckets of this index.">nextBucket()</a> is called, <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> iteration is reset to just before the first <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> in the new <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. U_ENUM_OUT_OF_SYNC_ERROR will be reported if the index is modified while an enumeration of its contents are in process. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>TRUE if successful, FALSE when the iteration advances past the last item. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000281">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a7785cc956f67016ca585969aeb50a032"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::resetBucketIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a> iteration for this index. </p>
<p>The next call to <a class="el" href="classAlphabeticIndex.html#aefa336cda70e3e48ae1c4396decd295a" title="Advance the iteration over the Buckets of this index.">nextBucket()</a> will restart the iteration at the first label.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>this, for chaining. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000280">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a7b2c382730d338e4fabb886640319137"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::resetRecordIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> iterator position to before the first <a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> in the current <a class="el" href="structAlphabeticIndex_1_1Bucket.html" title="A Bucket holds an index label and references to everything belonging to that label.">Bucket</a>. </p>
<dl class="section return"><dt>Returns:</dt><dd>This, for chaining. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000284">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a9396297bd37ac793035919962b5f86c1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::setInflowLabel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>inflowLabel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the default label used for abbreviated buckets <em>between</em> other index characters. </p>
<p>An inflow label will be automatically inserted if two otherwise-adjacent label characters are from different scripts, e.g. Latin and Cyrillic, and a third script, e.g. Greek, sorts between the two. The default inflow character is an ellipsis (...)</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">inflowLabel</td><td>the new Inflow label. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>this </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000263">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="ac74db7633495b59fb86745890526fb09"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::setMaxLabelCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"><em>maxLabelCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a limit on the number of labels permitted in the index. </p>
<p>The number does not include over, under and inflow labels. Currently, if the number is exceeded, then every nth item is removed to bring the count down. A more sophisticated mechanism may be available in the future.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">maxLabelCount</td><td>the maximum number of labels. </td></tr>
<tr><td class="paramname">status</td><td>error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>This, for chaining </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000269">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="afc12abed4c5215414b26c0f95fbd2ba7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::setOverflowLabel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>overflowLabel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the label used for items that sort after the last normal label, and that would not otherwise have an appropriate label. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">overflowLabel</td><td>the new overflow label. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>this </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000265">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a32d8bbc8273e04ff01050de0e7e08e8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classAlphabeticIndex.html">AlphabeticIndex</a>& AlphabeticIndex::setUnderflowLabel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>underflowLabel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the label used for items that sort before the first normal label, and that would not otherwise have an appropriate label. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">underflowLabel</td><td>the new underflow label. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>this </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000267">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a10d496623339498a76b3238b1b407add"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void AlphabeticIndex::staticCleanup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete all shared (static) data associated with an <a class="el" href="classAlphabeticIndex.html" title="class AlphabeticIndex supports the creation of a UI index appropriate for a given language...">AlphabeticIndex</a>. </p>
<p>Internal function, not intended for direct use. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000193">Internal:</a></b></dt><dd>Do not use. This API is for internal use only.. </dd></dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a57710f17956e43f73d9beb7943c1fdbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UVector* AlphabeticIndex::inputRecords_</td>
</tr>
</table>
</div><div class="memdoc">
<p>Holds all user records before they are distributed into buckets. </p>
<p>Type of contents is (<a class="el" href="structAlphabeticIndex_1_1Record.html" title="A record, or item, in the index.">Record</a> *) </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000195">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Definition at line <a class="el" href="alphaindex_8h_source.html#l00597">597</a> of file <a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="alphaindex_8h_source.html">alphaindex.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
