ICU 75.1 75.1
|
This class provides flexible generation of date format patterns, like "yy-MM-dd". More...
#include <dtptngen.h>
Public Member Functions | |
virtual | ~DateTimePatternGenerator () |
Destructor. | |
DateTimePatternGenerator * | clone () const |
Clone DateTimePatternGenerator object. | |
bool | operator== (const DateTimePatternGenerator &other) const |
Return true if another object is semantically equal to this one. | |
bool | operator!= (const DateTimePatternGenerator &other) const |
Return true if another object is semantically unequal to this one. | |
UnicodeString | getSkeleton (const UnicodeString &pattern, UErrorCode &status) |
Utility to return a unique skeleton from a given pattern. | |
UnicodeString | getBaseSkeleton (const UnicodeString &pattern, UErrorCode &status) |
Utility to return a unique base skeleton from a given pattern. | |
UDateTimePatternConflict | addPattern (const UnicodeString &pattern, UBool override, UnicodeString &conflictingPattern, UErrorCode &status) |
Adds a pattern to the generator. | |
void | setAppendItemFormat (UDateTimePatternField field, const UnicodeString &value) |
An AppendItem format is a pattern used to append a field if there is no good match. | |
const UnicodeString & | getAppendItemFormat (UDateTimePatternField field) const |
Getter corresponding to setAppendItemFormat. | |
void | setAppendItemName (UDateTimePatternField field, const UnicodeString &value) |
Sets the names of field, eg "era" in English for ERA. | |
const UnicodeString & | getAppendItemName (UDateTimePatternField field) const |
Getter corresponding to setAppendItemNames. | |
UnicodeString | getFieldDisplayName (UDateTimePatternField field, UDateTimePGDisplayWidth width) const |
The general interface to get a display name for a particular date/time field, in one of several possible display widths. | |
void | setDateTimeFormat (const UnicodeString &dateTimeFormat) |
The DateTimeFormat is a message format pattern used to compose date and time patterns. | |
const UnicodeString & | getDateTimeFormat () const |
Getter corresponding to setDateTimeFormat. | |
void | setDateTimeFormat (UDateFormatStyle style, const UnicodeString &dateTimeFormat, UErrorCode &status) |
dateTimeFormats are message patterns used to compose combinations of date and time patterns. | |
const UnicodeString & | getDateTimeFormat (UDateFormatStyle style, UErrorCode &status) const |
Getter corresponding to setDateTimeFormat. | |
UnicodeString | getBestPattern (const UnicodeString &skeleton, UErrorCode &status) |
Return the best pattern matching the input skeleton. | |
UnicodeString | getBestPattern (const UnicodeString &skeleton, UDateTimePatternMatchOptions options, UErrorCode &status) |
Return the best pattern matching the input skeleton. | |
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. | |
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. | |
StringEnumeration * | getSkeletons (UErrorCode &status) const |
Return a list of all the skeletons (in canonical form) from this class. | |
const UnicodeString & | getPatternForSkeleton (const UnicodeString &skeleton) const |
Get the pattern corresponding to a given skeleton. | |
StringEnumeration * | getBaseSkeletons (UErrorCode &status) const |
Return a list of all the base skeletons (in canonical form) from this class. | |
StringEnumeration * | getRedundants (UErrorCode &status) |
Return a list of redundant patterns are those which if removed, make no difference in the resulting getBestPattern values. | |
void | setDecimal (const UnicodeString &decimal) |
The decimal value is used in formatting fractions of seconds. | |
const UnicodeString & | getDecimal () const |
Getter corresponding to setDecimal. | |
UDateFormatHourCycle | getDefaultHourCycle (UErrorCode &status) const |
Get the default hour cycle for a locale. | |
virtual UClassID | getDynamicClassID () const override |
ICU "poor man's RTTI", returns a UClassID for the actual class. | |
Public Member Functions inherited from icu::UObject | |
virtual | ~UObject () |
Destructor. | |
Static Public Member Functions | |
static DateTimePatternGenerator * | createInstance (UErrorCode &status) |
Construct a flexible generator according to default locale. | |
static DateTimePatternGenerator * | createInstance (const Locale &uLocale, UErrorCode &status) |
Construct a flexible generator according to data for a given locale. | |
static DateTimePatternGenerator * | createInstanceNoStdPat (const Locale &uLocale, UErrorCode &status) |
For ICU use only. | |
static DateTimePatternGenerator * | createEmptyInstance (UErrorCode &status) |
Create an empty generator, to be constructed with addPattern(...) etc. | |
static UnicodeString | staticGetSkeleton (const UnicodeString &pattern, UErrorCode &status) |
Utility to return a unique skeleton from a given pattern. | |
static UnicodeString | staticGetBaseSkeleton (const UnicodeString &pattern, UErrorCode &status) |
Utility to return a unique base skeleton from a given pattern. | |
static UClassID | getStaticClassID () |
ICU "poor man's RTTI", returns a UClassID for this class. | |
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.
Definition at line 58 of file dtptngen.h.
|
virtual |
Destructor.
UDateTimePatternConflict icu::DateTimePatternGenerator::addPattern | ( | const UnicodeString & | pattern, |
UBool | override, | ||
UnicodeString & | conflictingPattern, | ||
UErrorCode & | status | ||
) |
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 overridden. 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!
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. |
DateTimePatternGenerator * icu::DateTimePatternGenerator::clone | ( | ) | const |
Clone DateTimePatternGenerator object.
Clients are responsible for deleting the DateTimePatternGenerator object cloned.
|
static |
Create an empty generator, to be constructed with addPattern(...) etc.
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
|
static |
Construct a flexible generator according to data for a given locale.
uLocale | |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
|
static |
Construct a flexible generator according to default locale.
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
|
static |
For ICU use only.
Skips loading the standard date/time patterns (which is done via DateFormat).
const UnicodeString & icu::DateTimePatternGenerator::getAppendItemFormat | ( | UDateTimePatternField | field | ) | const |
Getter corresponding to setAppendItemFormat.
Values below 0 or at or above UDATPG_FIELD_COUNT are illegal arguments.
field | such as UDATPG_ERA_FIELD. |
const UnicodeString & icu::DateTimePatternGenerator::getAppendItemName | ( | UDateTimePatternField | field | ) | const |
Getter corresponding to setAppendItemNames.
Values below 0 or at or above UDATPG_FIELD_COUNT are illegal arguments. Note: The more general method for getting date/time field display names is getFieldDisplayName.
field | such as UDATPG_ERA_FIELD. |
UnicodeString icu::DateTimePatternGenerator::getBaseSkeleton | ( | const UnicodeString & | pattern, |
UErrorCode & | status | ||
) |
Utility to return a unique base skeleton from a given pattern.
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). getBaseSkeleton() works exactly like staticGetBaseSkeleton(). Use staticGetBaseSkeleton() instead of getBaseSkeleton().
pattern | Input pattern, such as "dd/MMM" |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
StringEnumeration * icu::DateTimePatternGenerator::getBaseSkeletons | ( | UErrorCode & | status | ) | const |
Return a list of all the base skeletons (in canonical form) from this class.
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
UnicodeString icu::DateTimePatternGenerator::getBestPattern | ( | const UnicodeString & | skeleton, |
UDateTimePatternMatchOptions | options, | ||
UErrorCode & | status | ||
) |
Return the best pattern matching the input skeleton.
It is guaranteed to have all of the fields in the skeleton.
skeleton | The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. |
options | Options for forcing the length of specified fields in the returned pattern to match those in the skeleton (when this would not happen otherwise). For default behavior, use UDATPG_MATCH_NO_OPTIONS. |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
UnicodeString icu::DateTimePatternGenerator::getBestPattern | ( | const UnicodeString & | skeleton, |
UErrorCode & | status | ||
) |
Return the best pattern matching the input skeleton.
It is guaranteed to have all of the fields in the skeleton.
skeleton | The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
const UnicodeString & icu::DateTimePatternGenerator::getDateTimeFormat | ( | ) | const |
Getter corresponding to setDateTimeFormat.
There are four DateTimeFormats in a DateTimePatternGenerator object, corresponding to date styles UDAT_FULL..UDAT_SHORT. This method gets the style for UDAT_MEDIUM (the default). To get them individually, see getDateTimeFormat(UDateFormatStyle style).
const UnicodeString & icu::DateTimePatternGenerator::getDateTimeFormat | ( | UDateFormatStyle | style, |
UErrorCode & | status | ||
) | const |
Getter corresponding to setDateTimeFormat.
style | one of UDAT_FULL..UDAT_SHORT. Error if out of range. |
status | in/out parameter; if no failure status is already set, it will be set according to result of the function (e.g. U_ILLEGAL_ARGUMENT_ERROR for style out of range). |
const UnicodeString & icu::DateTimePatternGenerator::getDecimal | ( | ) | const |
Getter corresponding to setDecimal.
UDateFormatHourCycle icu::DateTimePatternGenerator::getDefaultHourCycle | ( | UErrorCode & | status | ) | const |
Get the default hour cycle for a locale.
Uses the locale that the DateTimePatternGenerator was initially created with.
Cannot be used on an empty DateTimePatternGenerator instance.
status | Output param set to success/failure code on exit, which which must not indicate a failure before the function call. Set to U_UNSUPPORTED_ERROR if used on an empty instance. |
ICU "poor man's RTTI", returns a UClassID for the actual class.
Reimplemented from icu::UObject.
UnicodeString icu::DateTimePatternGenerator::getFieldDisplayName | ( | UDateTimePatternField | field, |
UDateTimePGDisplayWidth | width | ||
) | const |
The general interface to get a display name for a particular date/time field, in one of several possible display widths.
field | The desired UDateTimePatternField, such as UDATPG_ERA_FIELD. |
width | The desired UDateTimePGDisplayWidth, such as UDATPG_ABBREVIATED. |
const UnicodeString & icu::DateTimePatternGenerator::getPatternForSkeleton | ( | const UnicodeString & | skeleton | ) | const |
Get the pattern corresponding to a given skeleton.
skeleton |
StringEnumeration * icu::DateTimePatternGenerator::getRedundants | ( | UErrorCode & | status | ) |
Return a list of redundant patterns are those which if removed, make no difference in the resulting getBestPattern values.
This method returns a list of them, to help check the consistency of the patterns used to build this generator.
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
UnicodeString icu::DateTimePatternGenerator::getSkeleton | ( | const UnicodeString & | pattern, |
UErrorCode & | status | ||
) |
Utility to return a unique skeleton from a given pattern.
For example, both "MMM-dd" and "dd/MMM" produce the skeleton "MMMdd". getSkeleton() works exactly like staticGetSkeleton(). Use staticGetSkeleton() instead of getSkeleton().
pattern | Input pattern, such as "dd/MMM" |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
StringEnumeration * icu::DateTimePatternGenerator::getSkeletons | ( | UErrorCode & | status | ) | const |
Return a list of all the skeletons (in canonical form) from this class.
Call getPatternForSkeleton() to get the corresponding pattern.
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
ICU "poor man's RTTI", returns a UClassID for this class.
bool icu::DateTimePatternGenerator::operator!= | ( | const DateTimePatternGenerator & | other | ) | const |
Return true if another object is semantically unequal to this one.
other | the DateTimePatternGenerator object to be compared with. |
bool icu::DateTimePatternGenerator::operator== | ( | const DateTimePatternGenerator & | other | ) | const |
Return true if another object is semantically equal to this one.
other | the DateTimePatternGenerator object to be compared with. |
UnicodeString icu::DateTimePatternGenerator::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.
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.
pattern | Input pattern |
skeleton | The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. |
options | Options controlling whether the length of specified fields in the pattern are adjusted to match those in the skeleton (when this would not happen otherwise). For default behavior, use UDATPG_MATCH_NO_OPTIONS. |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
UnicodeString icu::DateTimePatternGenerator::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.
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.
pattern | Input pattern |
skeleton | The skeleton is a pattern containing only the variable fields. For example, "MMMdd" and "mmhh" are skeletons. |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
void icu::DateTimePatternGenerator::setAppendItemFormat | ( | UDateTimePatternField | field, |
const UnicodeString & | value | ||
) |
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.
field | such as UDATPG_ERA_FIELD. |
value | pattern, such as "{0}, {1}" |
void icu::DateTimePatternGenerator::setAppendItemName | ( | UDateTimePatternField | field, |
const UnicodeString & | value | ||
) |
Sets the names of field, eg "era" in English for ERA.
These are only used if the corresponding AppendItemFormat is used, and if it contains a {2} variable.
This reflects the way that the CLDR data is organized.
field | such as UDATPG_ERA_FIELD. |
value | name of the field |
void icu::DateTimePatternGenerator::setDateTimeFormat | ( | const UnicodeString & | dateTimeFormat | ) |
The DateTimeFormat is a message format pattern used to compose date and time patterns.
The default pattern in the root locale is "{1} {0}", where {1} will be replaced by the date pattern and {0} will be replaced by the time pattern; however, other locales may specify patterns such as "{1}, {0}" or "{1} 'at' {0}", etc.
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 "{1} {0}". 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".
There are four DateTimeFormats in a DateTimePatternGenerator object, corresponding to date styles UDAT_FULL..UDAT_SHORT. This method sets all of them to the specified pattern. To set them individually, see setDateTimeFormat(UDateFormatStyle style, ...).
dateTimeFormat | message format pattern, here {1} will be replaced by the date pattern and {0} will be replaced by the time pattern. |
void icu::DateTimePatternGenerator::setDateTimeFormat | ( | UDateFormatStyle | style, |
const UnicodeString & | dateTimeFormat, | ||
UErrorCode & | status | ||
) |
dateTimeFormats are message patterns used to compose combinations of date and time patterns.
There are four length styles, corresponding to the inferred style of the date pattern; these are UDateFormatStyle values:
style | one of DateFormat.FULL..DateFormat.SHORT. Error if out of range. |
dateTimeFormat | the new dateTimeFormat to set for the the specified style |
status | in/out parameter; if no failure status is already set, it will be set according to result of the function (e.g. U_ILLEGAL_ARGUMENT_ERROR for style out of range). |
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"
decimal |
|
static |
Utility to return a unique base skeleton from a given pattern.
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).
pattern | Input pattern, such as "dd/MMM" |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |
|
static |
Utility to return a unique skeleton from a given pattern.
For example, both "MMM-dd" and "dd/MMM" produce the skeleton "MMMdd".
pattern | Input pattern, such as "dd/MMM" |
status | Output param set to success/failure code on exit, which must not indicate a failure before the function call. |