<!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: CollData 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="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">CollData Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classCollData.html" title="CollData.">CollData</a>.
<a href="classCollData.html#details">More...</a></p>
<p><code>#include <<a class="el" href="colldata_8h_source.html">colldata.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CollData:</div>
<div class="dyncontent">
<div class="center">
<img src="classCollData.png" usemap="#CollData_map" alt=""/>
<map id="CollData_map" name="CollData_map">
<area href="classUObject.html" title="UObject is the common ICU "boilerplate" class." alt="UObject" shape="rect" coords="0,56,66,80"/>
<area href="classUMemory.html" title="UMemory is the common ICU base class." alt="UMemory" shape="rect" coords="0,0,66,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae6e0b03b2de8ad3a51ce502b7ad737d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#ae6e0b03b2de8ad3a51ce502b7ad737d5">getCollator</a> () const </td></tr>
<tr class="memdesc:ae6e0b03b2de8ad3a51ce502b7ad737d5"><td class="mdescLeft"> </td><td class="mdescRight">Get the <code>UCollator</code> object used to create this object. <a href="#ae6e0b03b2de8ad3a51ce502b7ad737d5"></a><br/></td></tr>
<tr class="memitem:ad9a3cee8ee21ba9a15b5527c5c1e78bb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStringList.html">StringList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#ad9a3cee8ee21ba9a15b5527c5c1e78bb">getStringList</a> (<a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> ce) const </td></tr>
<tr class="memdesc:ad9a3cee8ee21ba9a15b5527c5c1e78bb"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of all the strings which generate a list of CEs starting with a given CE. <a href="#ad9a3cee8ee21ba9a15b5527c5c1e78bb"></a><br/></td></tr>
<tr class="memitem:ae329ca6f37a0c065ba1b65d52d10e98c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEList.html">CEList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#ae329ca6f37a0c065ba1b65d52d10e98c">getCEList</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> *string) const </td></tr>
<tr class="memdesc:ae329ca6f37a0c065ba1b65d52d10e98c"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of the CEs generated by a partcular stirng. <a href="#ae329ca6f37a0c065ba1b65d52d10e98c"></a><br/></td></tr>
<tr class="memitem:a77423e4703645bb956d66b335312b781"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#a77423e4703645bb956d66b335312b781">freeCEList</a> (const <a class="el" href="classCEList.html">CEList</a> *list)</td></tr>
<tr class="memdesc:a77423e4703645bb956d66b335312b781"><td class="mdescLeft"> </td><td class="mdescRight">Release a <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> returned by <code>getCEList</code>. <a href="#a77423e4703645bb956d66b335312b781"></a><br/></td></tr>
<tr class="memitem:a59f514d423aef79078bc07a5e69d3c0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#a59f514d423aef79078bc07a5e69d3c0b">minLengthInChars</a> (const <a class="el" href="classCEList.html">CEList</a> *ces, <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> offset) const </td></tr>
<tr class="memdesc:a59f514d423aef79078bc07a5e69d3c0b"><td class="mdescLeft"> </td><td class="mdescRight">Return the length of the shortest string that will generate the given list of CEs. <a href="#a59f514d423aef79078bc07a5e69d3c0b"></a><br/></td></tr>
<tr class="memitem:a8775f56ba51f054fbfed7b633ccf7b78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#a8775f56ba51f054fbfed7b633ccf7b78">minLengthInChars</a> (const <a class="el" href="classCEList.html">CEList</a> *ces, <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> offset, <a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> *history) const </td></tr>
<tr class="memdesc:a8775f56ba51f054fbfed7b633ccf7b78"><td class="mdescLeft"> </td><td class="mdescRight">Return the length of the shortest string that will generate the given list of CEs. <a href="#a8775f56ba51f054fbfed7b633ccf7b78"></a><br/></td></tr>
<tr class="memitem:a8a1215fe9adf56bd35026cbd98840371"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#a8a1215fe9adf56bd35026cbd98840371">getDynamicClassID</a> () const </td></tr>
<tr class="memdesc:a8a1215fe9adf56bd35026cbd98840371"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... <a href="#a8a1215fe9adf56bd35026cbd98840371"></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:aebf674446064095bc2527ab1c0e93dd1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCollData.html">CollData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#aebf674446064095bc2527ab1c0e93dd1">open</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *collator, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:aebf674446064095bc2527ab1c0e93dd1"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> object. <a href="#aebf674446064095bc2527ab1c0e93dd1"></a><br/></td></tr>
<tr class="memitem:ace312528a2209fa44a65c914f7c20f84"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#ace312528a2209fa44a65c914f7c20f84">close</a> (<a class="el" href="classCollData.html">CollData</a> *collData)</td></tr>
<tr class="memdesc:ace312528a2209fa44a65c914f7c20f84"><td class="mdescLeft"> </td><td class="mdescRight">Release a <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> object. <a href="#ace312528a2209fa44a65c914f7c20f84"></a><br/></td></tr>
<tr class="memitem:a95055b1bb2e59688ede407ebe5d3156b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#a95055b1bb2e59688ede407ebe5d3156b">getStaticClassID</a> ()</td></tr>
<tr class="memdesc:a95055b1bb2e59688ede407ebe5d3156b"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... <a href="#a95055b1bb2e59688ede407ebe5d3156b"></a><br/></td></tr>
<tr class="memitem:ada12238ab63535d66f993b0cdd217f53"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#ada12238ab63535d66f993b0cdd217f53">freeCollDataCache</a> ()</td></tr>
<tr class="memdesc:ada12238ab63535d66f993b0cdd217f53"><td class="mdescLeft"> </td><td class="mdescRight"><code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> objects are expensive to compute, and so may be cached. <a href="#ada12238ab63535d66f993b0cdd217f53"></a><br/></td></tr>
<tr class="memitem:aaa122c473c2459af3dce95a1e26e6ede"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollData.html#aaa122c473c2459af3dce95a1e26e6ede">flushCollDataCache</a> ()</td></tr>
<tr class="memdesc:aaa122c473c2459af3dce95a1e26e6ede"><td class="mdescLeft"> </td><td class="mdescRight"><code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> objects are expensive to compute, and so may be cached. <a href="#aaa122c473c2459af3dce95a1e26e6ede"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a22e711f86472e2cf11650bbc6554ccd8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22e711f86472e2cf11650bbc6554ccd8"></a>
class </td><td class="memItemRight" valign="bottom"><b>CollDataCache</b></td></tr>
<tr class="memitem:addbca66ab81a7349e225978c82453bae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="addbca66ab81a7349e225978c82453bae"></a>
class </td><td class="memItemRight" valign="bottom"><b>CollDataCacheEntry</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCollData.html" title="CollData.">CollData</a>. </p>
<p>This class holds the Collator-specific data needed to compute the length of the shortest string that can generate a partcular list of CEs.</p>
<p><code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> objects are quite expensive to compute. Because of this, they are cached. When you call <code><a class="el" href="classCollData.html#aebf674446064095bc2527ab1c0e93dd1" title="Construct a CollData object.">CollData::open</a></code> it returns a reference counted cached object. When you call <code><a class="el" href="classCollData.html#ace312528a2209fa44a65c914f7c20f84" title="Release a CollData object.">CollData::close</a></code> the reference count on the object is decremented but the object is not deleted.</p>
<p>If you do not need to reuse any unreferenced objects in the cache, you can call <code><a class="el" href="classCollData.html#aaa122c473c2459af3dce95a1e26e6ede" title="CollData objects are expensive to compute, and so may be cached.">CollData::flushCollDataCache</a></code>. If you no longer need any <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> objects, you can call <code><a class="el" href="classCollData.html#ada12238ab63535d66f993b0cdd217f53" title="CollData objects are expensive to compute, and so may be cached.">CollData::freeCollDataCache</a></code></p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000290">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
<p>Definition at line <a class="el" href="colldata_8h_source.html#l00279">279</a> of file <a class="el" href="colldata_8h_source.html">colldata.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ace312528a2209fa44a65c914f7c20f84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void CollData::close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCollData.html">CollData</a> * </td>
<td class="paramname"><em>collData</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>Release a <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> object. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">collData</td><td>- the object</td></tr>
</table>
</dd>
</dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000308">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="aaa122c473c2459af3dce95a1e26e6ede"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void CollData::flushCollDataCache </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><code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> objects are expensive to compute, and so may be cached. </p>
<p>This routine will remove any unused <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> objects from the cache.</p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000318">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="a77423e4703645bb956d66b335312b781"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CollData::freeCEList </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEList.html">CEList</a> * </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Release a <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> returned by <code>getCEList</code>. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>- the <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> to free.</td></tr>
</table>
</dd>
</dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000312">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="ada12238ab63535d66f993b0cdd217f53"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void CollData::freeCollDataCache </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><code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> objects are expensive to compute, and so may be cached. </p>
<p>This routine will free the cached objects and delete the cache.</p>
<p>WARNING: Don't call this until you are have called <code>close</code> for each <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> object that you have used. also, DO NOT call this if another thread may be calling <code>flushCollDataCache</code> at the same time.</p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000317">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="ae329ca6f37a0c065ba1b65d52d10e98c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEList.html">CEList</a>* CollData::getCEList </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> * </td>
<td class="paramname"><em>string</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of the CEs generated by a partcular stirng. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>- the string</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>a <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> object containt the CEs. You must call <code>freeCEList</code> when you are finished using the <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code>/</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000311">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6e0b03b2de8ad3a51ce502b7ad737d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* CollData::getCollator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the <code>UCollator</code> object used to create this object. </p>
<p>The object returned may not be the exact object that was used to create this object, but it will have the same behavior. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000309">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="a8a1215fe9adf56bd35026cbd98840371"></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="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CollData::getDynamicClassID </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><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000315">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
<p>Implements <a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.</p>
</div>
</div>
<a class="anchor" id="a95055b1bb2e59688ede407ebe5d3156b"></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="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CollData::getStaticClassID </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><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000316">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="ad9a3cee8ee21ba9a15b5527c5c1e78bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStringList.html">StringList</a>* CollData::getStringList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"><em>ce</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of all the strings which generate a list of CEs starting with a given CE. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">ce</td><td>- the CE</td></tr>
</table>
</dd>
</dl>
<p>return a <code><a class="el" href="classStringList.html" title="StringList.">StringList</a></code> object containing all the stirngs, or <code>NULL</code> if there are no such strings.</p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000310">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview. </dd></dl>
</div>
</div>
<a class="anchor" id="a59f514d423aef79078bc07a5e69d3c0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollData::minLengthInChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEList.html">CEList</a> * </td>
<td class="paramname"><em>ces</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the length of the shortest string that will generate the given list of CEs. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">ces</td><td>- the CEs </td></tr>
<tr><td class="paramname">offset</td><td>- the offset of the first CE in the list to use.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>the length of the shortest string.</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000313">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="a8775f56ba51f054fbfed7b633ccf7b78"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollData::minLengthInChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEList.html">CEList</a> * </td>
<td class="paramname"><em>ces</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#ab1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> * </td>
<td class="paramname"><em>history</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the length of the shortest string that will generate the given list of CEs. </p>
<p>Note: the algorithm used to do this computation is recursive. To limit the amount of recursion, a "history" list is used to record the best answer starting at a particular offset in the list of CEs. If the same offset is visited again during the recursion, the answer in the history list is used.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">ces</td><td>- the CEs </td></tr>
<tr><td class="paramname">offset</td><td>- the offset of the first CE in the list to use. </td></tr>
<tr><td class="paramname">history</td><td>- the history list. Must be at least as long as the number of cEs in the <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>the length of the shortest string.</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000314">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="aebf674446064095bc2527ab1c0e93dd1"></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="classCollData.html">CollData</a>* CollData::open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"><em>collator</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> object. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">collator</td><td>- the collator </td></tr>
<tr><td class="paramname">status</td><td>- will be set if any errors occur.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>the <code><a class="el" href="classCollData.html" title="CollData.">CollData</a></code> object. You must call <code>close</code> when you are done using the object.</dd></dl>
<p>Note: if on return, status is set to an error code, the only safe thing to do with this object is to call <code><a class="el" href="classCollData.html#ace312528a2209fa44a65c914f7c20f84" title="Release a CollData object.">CollData::close</a></code>.</p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000307">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="colldata_8h_source.html">colldata.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>
