This class provides flexible generation of date format patterns, like "yy-MM-dd".
More...
|
virtual | ~DateTimePatternGenerator () |
| Destructor. More...
|
|
DateTimePatternGenerator * | clone () const |
| Clone DateTimePatternGenerator object. More...
|
|
UBool | operator== (const DateTimePatternGenerator &other) const |
| Return true if another object is semantically equal to this one. More...
|
|
UBool | operator!= (const DateTimePatternGenerator &other) const |
| Return true if another object is semantically unequal to this one. More...
|
|
UnicodeString | getSkeleton (const UnicodeString &pattern, UErrorCode &status) |
| Utility to return a unique skeleton from a given pattern. More...
|
|
UnicodeString | getBaseSkeleton (const UnicodeString &pattern, UErrorCode &status) |
| Utility to return a unique base skeleton from a given pattern. More...
|
|
UDateTimePatternConflict | addPattern (const UnicodeString &pattern, UBool override, UnicodeString &conflictingPattern, UErrorCode &status) |
| Adds a pattern to the generator. More...
|
|
void | setAppendItemFormat (UDateTimePatternField field, const UnicodeString &value) |
| An AppendItem format is a pattern used to append a field if there is no good match. More...
|
|
const UnicodeString & | getAppendItemFormat (UDateTimePatternField field) const |
| Getter corresponding to setAppendItemFormat. More...
|
|
void | setAppendItemName (UDateTimePatternField field, const UnicodeString &value) |
| Sets the names of field, eg "era" in English for ERA. More...
|
|
const UnicodeString & | getAppendItemName (UDateTimePatternField field) const |
| Getter corresponding to setAppendItemNames. More...
|
|
void | setDateTimeFormat (const UnicodeString &dateTimeFormat) |
| The date time format is a message format pattern used to compose date and time patterns. More...
|
|
const UnicodeString & | getDateTimeFormat () const |
| Getter corresponding to setDateTimeFormat. More...
|
|
UnicodeString | getBestPattern (const UnicodeString &skeleton, UErrorCode &status) |
| Return the best pattern matching the input skeleton. More...
|
|
UnicodeString | getBestPattern (const UnicodeString &skeleton, UDateTimePatternMatchOptions options, UErrorCode &status) |
| Return the best pattern matching the input skeleton. More...
|
|
UnicodeString | replaceFieldTypes (const UnicodeString &pattern, const UnicodeString &skeleton, UErrorCode &status) |
| Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton. More...
|
|
UnicodeString | replaceFieldTypes (const UnicodeString &pattern, const UnicodeString &skeleton, UDateTimePatternMatchOptions options, UErrorCode &status) |
| Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton. More...
|
|
StringEnumeration * | getSkeletons (UErrorCode &status) const |
| Return a list of all the skeletons (in canonical form) from this class. More...
|
|
const UnicodeString & | getPatternForSkeleton (const UnicodeString &skeleton) const |
| Get the pattern corresponding to a given skeleton. More...
|
|
StringEnumeration * | getBaseSkeletons (UErrorCode &status) const |
| Return a list of all the base skeletons (in canonical form) from this class. More...
|
|
StringEnumeration * | getRedundants (UErrorCode &status) |
| Return a list of redundant patterns are those which if removed, make no difference in the resulting getBestPattern values. More...
|
|
void | setDecimal (const UnicodeString &decimal) |
| The decimal value is used in formatting fractions of seconds. More...
|
|
const UnicodeString & | getDecimal () const |
| Getter corresponding to setDecimal. More...
|
|
virtual UClassID | getDynamicClassID () const |
| ICU "poor man's RTTI", returns a UClassID for the actual class. More...
|
|
virtual | ~UObject () |
| Destructor. More...
|
|
This class provides flexible generation of date format patterns, like "yy-MM-dd".
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.
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.
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.
- Stable:
- ICU 3.8
Definition at line 49 of file dtptngen.h.
Adds a pattern to the generator.
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.
Note that single-field patterns (like "MMM") are automatically added, and don't need to be added explicitly!
- Parameters
-
pattern | Input pattern, such as "dd/MMM" |
override | When existing values are to be overridden use true, otherwise use false. |
conflictingPattern | Previous pattern with the same skeleton. |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
- Returns
- conflicting status. The value could be UDATPG_NO_CONFLICT, UDATPG_BASE_CONFLICT or UDATPG_CONFLICT.
- Stable:
- ICU 3.8
Sample code
UnicodeString conflictingPattern,dateReturned, pattern;
cal->set (1999,9,13,23,58,59);
UDate date = cal->getTime(status);
SimpleDateFormat *sdf = new SimpleDateFormat(dtfg->getBestPattern("MMMMddHmm",status),locale,status);
dtfg->addPattern("dd'. von' MMMM", true, conflictingPattern,status);
sdf->applyPattern(dtfg->getBestPattern("MMMMddHmm",status));
dateReturned = sdf->format(date, dateReturned, status);
pattern =sdf->toPattern(pattern);
u_printf(
"%s\n",
"New Pattern for FRENCH: ");
u_printf(
"%S\n", pattern.getTerminatedBuffer());
u_printf(
"%s\n",
"Date Time in new Pattern: ");
u_printf(
"%S\n", dateReturned.getTerminatedBuffer());
delete dtfg;
delete sdf;
delete cal;
An AppendItem format is a pattern used to append a field if there is no good match.
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".
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.
This reflects the way that the CLDR data is organized.
- Parameters
-
field | such as UDATPG_ERA_FIELD. |
value | pattern, such as "{0}, {1}" |
- Stable:
- ICU 3.8
void icu::DateTimePatternGenerator::setDateTimeFormat |
( |
const UnicodeString & |
dateTimeFormat | ) |
|
The date time format is a message format pattern used to compose date and time patterns.
The default value is "{0} {1}", where {0} will be replaced by the date pattern and {1} will be replaced by the time pattern.
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".
- Parameters
-
dateTimeFormat | message format pattern, here {0} will be replaced by the date pattern and {1} will be replaced by the time pattern. |
- Stable:
- ICU 3.8
void icu::DateTimePatternGenerator::setDecimal |
( |
const UnicodeString & |
decimal | ) |
|
The decimal value is used in formatting fractions of seconds.
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"
- Parameters
-
- Stable:
- ICU 3.8