<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: DateTimePatternGenerator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</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>
<h1>DateTimePatternGenerator Class Reference</h1><!-- doxytag: class="DateTimePatternGenerator" --><!-- doxytag: inherits="UObject" -->This class provides flexible generation of date format patterns, like "yy-MM-dd".
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="dtptngen_8h-source.html">dtptngen.h</a>></code>
<p>
<p>Inheritance diagram for DateTimePatternGenerator:
<p><center><img src="classDateTimePatternGenerator.png" usemap="#DateTimePatternGenerator_map" border="0" alt=""></center>
<map name="DateTimePatternGenerator_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,161,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,161,24">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#c5048ee4483f58c9d54a2216fc15df23">~DateTimePatternGenerator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#c5048ee4483f58c9d54a2216fc15df23"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#7383ffd9fd27e373dfb6901034323456">clone</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> object. <a href="#7383ffd9fd27e373dfb6901034323456"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#e6d1c499c0cd961a73e1f635fc7da485">operator==</a> (const <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if another object is semantically equal to this one. <a href="#e6d1c499c0cd961a73e1f635fc7da485"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#47c846342b07c09940635b2c83c94bfd">operator!=</a> (const <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if another object is semantically unequal to this one. <a href="#47c846342b07c09940635b2c83c94bfd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#a30c251609c1eea5ad60c95fc497251e">getSkeleton</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Utility to return a unique skeleton from a given pattern. <a href="#a30c251609c1eea5ad60c95fc497251e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#e055e7b170198ad8ce64da3052fe2256">getBaseSkeleton</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Utility to return a unique base skeleton from a given pattern. <a href="#e055e7b170198ad8ce64da3052fe2256"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="udatpg_8h.html#8ecf3c8a68ecb811372c59fa2cfad265">UDateTimePatternConflict</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#492f293963b5f7917e070e9c25d6c5e7">addPattern</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> override, <a class="el" href="classUnicodeString.html">UnicodeString</a> &conflictingPattern, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a pattern to the generator. <a href="#492f293963b5f7917e070e9c25d6c5e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#bdfb3118312514bddbe411418738aabc">setAppendItemFormat</a> (<a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> field, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An AppendItem format is a pattern used to append a field if there is no good match. <a href="#bdfb3118312514bddbe411418738aabc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#82fcc61e35b7af088077fe0f25898d3e">getAppendItemFormat</a> (<a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> field) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Getter corresponding to setAppendItemFormat. <a href="#82fcc61e35b7af088077fe0f25898d3e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#1ffd3b2a0db7f860cf8c98058c722422">setAppendItemName</a> (<a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> field, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the names of field, eg "era" in English for ERA. <a href="#1ffd3b2a0db7f860cf8c98058c722422"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#b4aff199379ac24eac7a8d2cbefc3133">getAppendItemName</a> (<a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> field) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Getter corresponding to setAppendItemNames. <a href="#b4aff199379ac24eac7a8d2cbefc3133"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#20b212311968e817328f03ad4e3efcab">setDateTimeFormat</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &dateTimeFormat)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The date time format is a message format pattern used to compose date and time patterns. <a href="#20b212311968e817328f03ad4e3efcab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#56b0a1007ffc02838d8f1a23ce1e4a26">getDateTimeFormat</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Getter corresponding to setDateTimeFormat. <a href="#56b0a1007ffc02838d8f1a23ce1e4a26"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#13f3478486d5848abfa3ce28707dc944">getBestPattern</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &skeleton, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the best pattern matching the input skeleton. <a href="#13f3478486d5848abfa3ce28707dc944"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#9baa763462b245c845d736f8113b9ce5">replaceFieldTypes</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &skeleton, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton. <a href="#9baa763462b245c845d736f8113b9ce5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#eb82abe1c3884c783813f396bbcbc91c">getSkeletons</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a list of all the skeletons (in canonical form) from this class. <a href="#eb82abe1c3884c783813f396bbcbc91c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#0b20047cb1e3a091226b1477e08f5101">getPatternForSkeleton</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &skeleton) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pattern corresponding to a given skeleton. <a href="#0b20047cb1e3a091226b1477e08f5101"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#1026c7b1302a3924b01c06a1d5b06f32">getBaseSkeletons</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a list of all the base skeletons (in canonical form) from this class. <a href="#1026c7b1302a3924b01c06a1d5b06f32"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#93d007806554bea0813ab5b99682ac2a">getRedundants</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a list of redundant patterns are those which if removed, make no difference in the resulting getBestPattern values. <a href="#93d007806554bea0813ab5b99682ac2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#3c393a45b7303157ba63f28f7f3a9428">setDecimal</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &decimal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The decimal value is used in formatting fractions of seconds. <a href="#3c393a45b7303157ba63f28f7f3a9428"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#37353d73e747d4093d9753187ace8757">getDecimal</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Getter corresponding to setDecimal. <a href="#37353d73e747d4093d9753187ace8757"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#732f7f8acf8f4b8be37f9c7f4a6171f9">getDynamicClassID</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#732f7f8acf8f4b8be37f9c7f4a6171f9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#6b4c66f8471fe9829e4e161011a8c472">createInstance</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a flexible generator according to default locale. <a href="#6b4c66f8471fe9829e4e161011a8c472"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#1f8e268f98675dea264f0a8953fdf96b">createInstance</a> (const <a class="el" href="classLocale.html">Locale</a> &uLocale, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a flexible generator according to data for a given locale. <a href="#1f8e268f98675dea264f0a8953fdf96b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#0b9c60fc1daa8f64f35db20bf021886a">createEmptyInstance</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty generator, to be constructed with addPattern(. <a href="#0b9c60fc1daa8f64f35db20bf021886a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateTimePatternGenerator.html#3b0a7ea9f9c4f104806aea1d67316b61">getStaticClassID</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#3b0a7ea9f9c4f104806aea1d67316b61"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class provides flexible generation of date format patterns, like "yy-MM-dd".
<p>
The user can build up the generator by adding successive patterns. Once that is done, a query can be made using a "skeleton", which is a pattern which just includes the desired fields and lengths. The generator will return the "best fit" pattern corresponding to that skeleton. <p>
The main method people will use is getBestPattern(String skeleton), since normally this class is pre-built with data from a particular locale. However, generators can be built directly from other data as well. <p>
<em>Issue: may be useful to also have a function that returns the list of fields in a pattern, in order, since we have that internally. That would be useful for getting the UI order of field elements.</em> <dl compact><dt><b><a class="el" href="draft.html#_draft000042">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="dtptngen_8h-source.html#l00042">42</a> of file <a class="el" href="dtptngen_8h-source.html">dtptngen.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c5048ee4483f58c9d54a2216fc15df23"></a><!-- doxytag: member="DateTimePatternGenerator::~DateTimePatternGenerator" ref="c5048ee4483f58c9d54a2216fc15df23" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual DateTimePatternGenerator::~DateTimePatternGenerator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<dl compact><dt><b><a class="el" href="draft.html#_draft000046">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6b4c66f8471fe9829e4e161011a8c472"></a><!-- doxytag: member="DateTimePatternGenerator::createInstance" ref="6b4c66f8471fe9829e4e161011a8c472" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a>* DateTimePatternGenerator::createInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a flexible generator according to default locale.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000043">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1f8e268f98675dea264f0a8953fdf96b"></a><!-- doxytag: member="DateTimePatternGenerator::createInstance" ref="1f8e268f98675dea264f0a8953fdf96b" args="(const Locale &uLocale, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a>* DateTimePatternGenerator::createInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>uLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a flexible generator according to data for a given locale.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uLocale</em> </td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000044">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0b9c60fc1daa8f64f35db20bf021886a"></a><!-- doxytag: member="DateTimePatternGenerator::createEmptyInstance" ref="0b9c60fc1daa8f64f35db20bf021886a" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a>* DateTimePatternGenerator::createEmptyInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an empty generator, to be constructed with addPattern(.
<p>
..) etc. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000045">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="7383ffd9fd27e373dfb6901034323456"></a><!-- doxytag: member="DateTimePatternGenerator::clone" ref="7383ffd9fd27e373dfb6901034323456" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a>* DateTimePatternGenerator::clone </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clone <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> object.
<p>
Clients are responsible for deleting the <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> object cloned. <dl compact><dt><b><a class="el" href="draft.html#_draft000047">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e6d1c499c0cd961a73e1f635fc7da485"></a><!-- doxytag: member="DateTimePatternGenerator::operator==" ref="e6d1c499c0cd961a73e1f635fc7da485" args="(const DateTimePatternGenerator &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> DateTimePatternGenerator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if another object is semantically equal to this one.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>the <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> object to be compared with. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if other is semantically equal to this. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000048">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="47c846342b07c09940635b2c83c94bfd"></a><!-- doxytag: member="DateTimePatternGenerator::operator!=" ref="47c846342b07c09940635b2c83c94bfd" args="(const DateTimePatternGenerator &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> DateTimePatternGenerator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if another object is semantically unequal to this one.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>the <a class="el" href="classDateTimePatternGenerator.html">DateTimePatternGenerator</a> object to be compared with. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if other is semantically unequal to this. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000049">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a30c251609c1eea5ad60c95fc497251e"></a><!-- doxytag: member="DateTimePatternGenerator::getSkeleton" ref="a30c251609c1eea5ad60c95fc497251e" args="(const UnicodeString &pattern, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> DateTimePatternGenerator::getSkeleton </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Utility to return a unique skeleton from a given pattern.
<p>
For example, both "MMM-dd" and "dd/MMM" produce the skeleton "MMMdd".<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>Input pattern, such as "dd/MMM" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>skeleton such as "MMMdd" </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000050">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e055e7b170198ad8ce64da3052fe2256"></a><!-- doxytag: member="DateTimePatternGenerator::getBaseSkeleton" ref="e055e7b170198ad8ce64da3052fe2256" args="(const UnicodeString &pattern, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> DateTimePatternGenerator::getBaseSkeleton </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Utility to return a unique base skeleton from a given pattern.
<p>
This is the same as the skeleton, except that differences in length are minimized so as to only preserve the difference between string and numeric form. So for example, both "MMM-dd" and "d/MMM" produce the skeleton "MMMd" (notice the single d).<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>Input pattern, such as "dd/MMM" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>base skeleton, such as "Md" </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000051">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="492f293963b5f7917e070e9c25d6c5e7"></a><!-- doxytag: member="DateTimePatternGenerator::addPattern" ref="492f293963b5f7917e070e9c25d6c5e7" args="(const UnicodeString &pattern, UBool override, UnicodeString &conflictingPattern, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="udatpg_8h.html#8ecf3c8a68ecb811372c59fa2cfad265">UDateTimePatternConflict</a> DateTimePatternGenerator::addPattern </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"> <em>override</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>conflictingPattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a pattern to the generator.
<p>
If the pattern has the same skeleton as an existing pattern, and the override parameter is set, then the previous value is overriden. Otherwise, the previous value is retained. In either case, the conflicting status is set and previous vale is stored in conflicting pattern. <p>
Note that single-field patterns (like "MMM") are automatically added, and don't need to be added explicitly!<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>Input pattern, such as "dd/MMM" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>override</em> </td><td>When existing values are to be overridden use true, otherwise use false. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>conflictingPattern</em> </td><td>Previous pattern with the same skeleton. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>conflicting status. The value could be UDATPG_NO_CONFLICT, UDATPG_BASE_CONFLICT or UDATPG_CONFLICT. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000052">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="bdfb3118312514bddbe411418738aabc"></a><!-- doxytag: member="DateTimePatternGenerator::setAppendItemFormat" ref="bdfb3118312514bddbe411418738aabc" args="(UDateTimePatternField field, const UnicodeString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DateTimePatternGenerator::setAppendItemFormat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An AppendItem format is a pattern used to append a field if there is no good match.
<p>
For example, suppose that the input skeleton is "GyyyyMMMd", and there is no matching pattern internally, but there is a pattern matching "yyyyMMMd", say "d-MM-yyyy". Then that pattern is used, plus the G. The way these two are conjoined is by using the AppendItemFormat for G (era). So if that value is, say "{0}, {1}" then the final resulting pattern is "d-MM-yyyy, G". <p>
There are actually three available variables: {0} is the pattern so far, {1} is the element we are adding, and {2} is the name of the element. <p>
This reflects the way that the CLDR data is organized.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>such as UDATPG_ERA_FIELD. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>pattern, such as "{0}, {1}" </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000053">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="82fcc61e35b7af088077fe0f25898d3e"></a><!-- doxytag: member="DateTimePatternGenerator::getAppendItemFormat" ref="82fcc61e35b7af088077fe0f25898d3e" args="(UDateTimePatternField field) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classUnicodeString.html">UnicodeString</a>& DateTimePatternGenerator::getAppendItemFormat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> </td>
<td class="paramname"> <em>field</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Getter corresponding to setAppendItemFormat.
<p>
Values below 0 or at or above UDATPG_FIELD_COUNT are illegal arguments.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>such as UDATPG_ERA_FIELD. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>append pattern for field </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000054">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1ffd3b2a0db7f860cf8c98058c722422"></a><!-- doxytag: member="DateTimePatternGenerator::setAppendItemName" ref="1ffd3b2a0db7f860cf8c98058c722422" args="(UDateTimePatternField field, const UnicodeString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DateTimePatternGenerator::setAppendItemName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the names of field, eg "era" in English for ERA.
<p>
These are only used if the corresponding AppendItemFormat is used, and if it contains a {2} variable. <p>
This reflects the way that the CLDR data is organized.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>such as UDATPG_ERA_FIELD. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>name of the field </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000055">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="b4aff199379ac24eac7a8d2cbefc3133"></a><!-- doxytag: member="DateTimePatternGenerator::getAppendItemName" ref="b4aff199379ac24eac7a8d2cbefc3133" args="(UDateTimePatternField field) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classUnicodeString.html">UnicodeString</a>& DateTimePatternGenerator::getAppendItemName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="udatpg_8h.html#f4ac5e0a850e2f49084fc0bcfc07ed03">UDateTimePatternField</a> </td>
<td class="paramname"> <em>field</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Getter corresponding to setAppendItemNames.
<p>
Values below 0 or at or above UDATPG_FIELD_COUNT are illegal arguments.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>such as UDATPG_ERA_FIELD. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>name for field </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000056">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="20b212311968e817328f03ad4e3efcab"></a><!-- doxytag: member="DateTimePatternGenerator::setDateTimeFormat" ref="20b212311968e817328f03ad4e3efcab" args="(const UnicodeString &dateTimeFormat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DateTimePatternGenerator::setDateTimeFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dateTimeFormat</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The date time format is a message format pattern used to compose date and time patterns.
<p>
The default value is "{0} {1}", where {0} will be replaced by the date pattern and {1} will be replaced by the time pattern. <p>
This is used when the input skeleton contains both date and time fields, but there is not a close match among the added patterns. For example, suppose that this object was created by adding "dd-MMM" and "hh:mm", and its datetimeFormat is the default "{0} {1}". Then if the input skeleton is "MMMdhmm", there is not an exact match, so the input skeleton is broken up into two components "MMMd" and "hmm". There are close matches for those two skeletons, so the result is put together with this pattern, resulting in "d-MMM h:mm".<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dateTimeFormat</em> </td><td>message format pattern, here {0} will be replaced by the date pattern and {1} will be replaced by the time pattern. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000057">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="56b0a1007ffc02838d8f1a23ce1e4a26"></a><!-- doxytag: member="DateTimePatternGenerator::getDateTimeFormat" ref="56b0a1007ffc02838d8f1a23ce1e4a26" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classUnicodeString.html">UnicodeString</a>& DateTimePatternGenerator::getDateTimeFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Getter corresponding to setDateTimeFormat.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>DateTimeFormat. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000058">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="13f3478486d5848abfa3ce28707dc944"></a><!-- doxytag: member="DateTimePatternGenerator::getBestPattern" ref="13f3478486d5848abfa3ce28707dc944" args="(const UnicodeString &skeleton, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> DateTimePatternGenerator::getBestPattern </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the best pattern matching the input skeleton.
<p>
It is guaranteed to have all of the fields in the skeleton.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>skeleton</em> </td><td>The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>bestPattern The best pattern found from the given skeleton. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000059">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="9baa763462b245c845d736f8113b9ce5"></a><!-- doxytag: member="DateTimePatternGenerator::replaceFieldTypes" ref="9baa763462b245c845d736f8113b9ce5" args="(const UnicodeString &pattern, const UnicodeString &skeleton, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> DateTimePatternGenerator::replaceFieldTypes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton.
<p>
That is, if you supply a pattern like "d-M H:m", and a skeleton of "MMMMddhhmm", then the input pattern is adjusted to be "dd-MMMM hh:mm". This is used internally to get the best match for the input skeleton, but can also be used externally.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>Input pattern </td></tr>
<tr><td valign="top"></td><td valign="top"><em>skeleton</em> </td><td>The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pattern adjusted to match the skeleton fields widths and subtypes. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000060">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="eb82abe1c3884c783813f396bbcbc91c"></a><!-- doxytag: member="DateTimePatternGenerator::getSkeletons" ref="eb82abe1c3884c783813f396bbcbc91c" args="(UErrorCode &status) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStringEnumeration.html">StringEnumeration</a>* DateTimePatternGenerator::getSkeletons </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a list of all the skeletons (in canonical form) from this class.
<p>
Call <a class="el" href="classDateTimePatternGenerator.html#0b20047cb1e3a091226b1477e08f5101">getPatternForSkeleton()</a> to get the corresponding pattern.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classStringEnumeration.html">StringEnumeration</a> with the skeletons. The caller must delete the object. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000061">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0b20047cb1e3a091226b1477e08f5101"></a><!-- doxytag: member="DateTimePatternGenerator::getPatternForSkeleton" ref="0b20047cb1e3a091226b1477e08f5101" args="(const UnicodeString &skeleton) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classUnicodeString.html">UnicodeString</a>& DateTimePatternGenerator::getPatternForSkeleton </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>skeleton</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the pattern corresponding to a given skeleton.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>skeleton</em> </td><td></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pattern corresponding to a given skeleton. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000062">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1026c7b1302a3924b01c06a1d5b06f32"></a><!-- doxytag: member="DateTimePatternGenerator::getBaseSkeletons" ref="1026c7b1302a3924b01c06a1d5b06f32" args="(UErrorCode &status) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStringEnumeration.html">StringEnumeration</a>* DateTimePatternGenerator::getBaseSkeletons </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a list of all the base skeletons (in canonical form) from this class.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> with the base skeletons. The caller must delete the object. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000063">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="93d007806554bea0813ab5b99682ac2a"></a><!-- doxytag: member="DateTimePatternGenerator::getRedundants" ref="93d007806554bea0813ab5b99682ac2a" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStringEnumeration.html">StringEnumeration</a>* DateTimePatternGenerator::getRedundants </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a list of redundant patterns are those which if removed, make no difference in the resulting getBestPattern values.
<p>
This method returns a list of them, to help check the consistency of the patterns used to build this generator.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param set to success/failure code on exit, which must not indicate a failure before the function call. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> with the redundant pattern. The caller must delete the object. </dd></dl>
<dl compact><dt><b><a class="el" href="internal.html#_internal000148">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3c393a45b7303157ba63f28f7f3a9428"></a><!-- doxytag: member="DateTimePatternGenerator::setDecimal" ref="3c393a45b7303157ba63f28f7f3a9428" args="(const UnicodeString &decimal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DateTimePatternGenerator::setDecimal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>decimal</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The decimal value is used in formatting fractions of seconds.
<p>
If the skeleton contains fractional seconds, then this is used with the fractional seconds. For example, suppose that the input pattern is "hhmmssSSSS", and the best matching pattern internally is "H:mm:ss", and the decimal string is ",". Then the resulting pattern is modified to be "H:mm:ss,SSSS"<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>decimal</em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000064">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="37353d73e747d4093d9753187ace8757"></a><!-- doxytag: member="DateTimePatternGenerator::getDecimal" ref="37353d73e747d4093d9753187ace8757" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classUnicodeString.html">UnicodeString</a>& DateTimePatternGenerator::getDecimal </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Getter corresponding to setDecimal.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classUnicodeString.html">UnicodeString</a> corresponding to the decimal point </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000065">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="732f7f8acf8f4b8be37f9c7f4a6171f9"></a><!-- doxytag: member="DateTimePatternGenerator::getDynamicClassID" ref="732f7f8acf8f4b8be37f9c7f4a6171f9" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> DateTimePatternGenerator::getDynamicClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for the actual class.
<p>
<dl compact><dt><b><a class="el" href="draft.html#_draft000066">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
<p>
Implements <a class="el" href="classUObject.html#ce1dd31fb2c6f2c07dfebe8fd240ec37">UObject</a>.
</div>
</div><p>
<a class="anchor" name="3b0a7ea9f9c4f104806aea1d67316b61"></a><!-- doxytag: member="DateTimePatternGenerator::getStaticClassID" ref="3b0a7ea9f9c4f104806aea1d67316b61" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> DateTimePatternGenerator::getStaticClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for this class.
<p>
<dl compact><dt><b><a class="el" href="draft.html#_draft000067">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.8 </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dtptngen_8h-source.html">dtptngen.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:39 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
280da2a01a3d16776505ea3f476de84f
>
files
>
63
