Main Page   Class Hierarchy   Compound List   File List   Header Files   Sources   Compound Members   File Members  

ResourceBundle Class Reference

A class representing a collection of resource information pertaining to a given locale. More...

#include <resbund.h>

List of all members.


Public Members

 ResourceBundle ( const UnicodeString& path, const Locale& locale, UErrorCode& err)
Constructor. More...

 ResourceBundle ( const UnicodeString& path, UErrorCode& err)
 ResourceBundle ( const wchar_t* path, const Locale& locale, UErrorCode& err)
 ResourceBundle (const ResourceBundle &original)
 ResourceBundle (UResourceBundle *res)
ResourceBundle& operator= (const ResourceBundle& other)
 ~ResourceBundle ()
int32_t getSize (void) const
Returns the size of a resource. More...

UnicodeString getString (UErrorCode& status) const
returns a string from a string resource type. More...

const uint8_tgetBinary (int32_t& len, UErrorCode& status) const
UBool hasNext (void) const
Checks whether the resource has another element to iterate over. More...

void resetIterator (void)
Resets the internal context of a resource so that iteration starts from the first element. More...

const char* getKey (void)
Returns the key associated with this resource. More...

const char* getName (void)
UResType getType (void)
Returns the type of a resource. More...

ResourceBundle getNext (UErrorCode& status)
Returns the next resource in a given resource or NULL if there are no more resources. More...

UnicodeString getNextString (UErrorCode& status)
Returns the next string in a resource or NULL if there are no more resources to iterate over. More...

UnicodeString getNextString (const char ** key, UErrorCode& status)
Returns the next string in a resource or NULL if there are no more resources to iterate over. More...

ResourceBundle get (int32_t index, UErrorCode& status) const
Returns the resource in a resource at the specified index. More...

UnicodeString getStringEx (int32_t index, UErrorCode& status) const
Returns the string in a given resource at the specified index. More...

ResourceBundle get (const char* key, UErrorCode& status) const
Returns a resource in a resource that has a given key. More...

UnicodeString getStringEx (const char* key, UErrorCode& status) const
Returns a string in a resource that has a given key. More...

const UnicodeStringgetString ( const char *resourceTag, UErrorCode& err) const
Returns the contents of a string resource. More...

const UnicodeStringgetStringArray ( const char *resourceTag, int32_t& numArrayItems, UErrorCode& err) const
Returns the contents of a string-array resource. More...

const UnicodeStringgetArrayItem ( const char *resourceTag, int32_t index, UErrorCode& err) const
Returns a single item from a string-array resource. More...

const UnicodeString** get2dArray (const char *resourceTag, int32_t& rowCount, int32_t& columnCount, UErrorCode& err) const
Return the contents of a 2-dimensional array resource. More...

const UnicodeStringget2dArrayItem ( const char *resourceTag, int32_t rowIndex, int32_t columnIndex, UErrorCode& err) const
Return a single string from a 2-dimensional array resource. More...

const UnicodeStringgetTaggedArrayItem ( const char *resourceTag, const UnicodeString& itemTag, UErrorCode& err) const
Returns a single item from a tagged-array resource This will return the contents of a single item in a resource of type tagged-array. More...

void getTaggedArray ( const char *resourceTag, UnicodeString*& itemTags, UnicodeString*& items, int32_t& numItems, UErrorCode& err) const
Returns a tagged-array resource. More...

const char* getVersionNumber (void) const
Return the version number associated with this ResourceBundle. More...

const LocalegetLocale (void) const
Return the Locale associated with this ResourceBundle. More...


Friends

class  RuleBasedCollator


Detailed Description

A class representing a collection of resource information pertaining to a given locale.

A resource bundle provides a way of accessing locale- specfic information in a data file. You create a resource bundle that manages the resources for a given locale and then ask it for individual resources.

The resource bundle file is a text (ASCII or Unicode) file with the format:

 .   locale {
 .      tag1 {...}
 .      tag2 {...}
 .   }
 
The tags are used to retrieve the data later. You may not have multiple instances of the same tag.

Four data types are supported. These are solitary strings, comma-delimited lists of strings, 2-dimensional arrays of strings, and tagged lists of strings.

Note that all data is textual. Adjacent strings are merged by the low-level tokenizer, so that the following effects occur: foo bar, baz // 2 elements, "foo bar", and "baz" "foo" "bar", baz // 2 elements, "foobar", and "baz" Note that a single intervening space is added between merged strings, unless they are both double quoted. This extends to more than two strings in a row.

Whitespace is ignored, as in a C source file.

Solitary strings have the format:

 .   Tag { Data }
 
This is indistinguishable from a comma-delimited list with only one element, and in fact may be retrieved as such (as an array, or as element 0 or an array).

Comma-delimited lists have the format:

 .   Tag { Data, Data, Data }
 
Parsing is lenient; a final string, after the last element, is allowed.

Tagged lists have the format:

 .   Tag { Subtag { Data } Subtag {Data} }
 
Data is retrieved by specifying the subtag.

Two-dimensional arrays have the format:

 .   TwoD {
 .       { r1c1, r1c2, ..., r1cm },
 .       { r2c1, r2c2, ..., r2cm },
 .       ...
 .       { rnc1, rnc2, ..., rncm }
 .   }
 
where n is the number of rows, and m is the number of columns. Parsing is lenient (as in other data types). A final comma is always allowed after the last element; either the last string in a row, or the last row itself. Furthermore, since there is no ambiguity, the commas between the rows are entirely optional. (However, if a comma is present, there can only be one comma, no more.) It is possible to have zero columns, as follows:
 .   Odd { {} {} {} } // 3 x 0 array
 
But it is impossible to have zero rows. The smallest array is thus a 1 x 0 array, which looks like this:
 .   Smallest { {} } // 1 x 0 array
 
The array must be strictly rectangular; that is, each row must have the same number of elements.

This is an example for using a possible custom resource:

 .    Locale currentLocale;
 .    UErrorCode success = U_ZERO_ERROR;
 .    ResourceBundle myResources("MyResources", currentLocale, success );
 .
 .    UnicodeString button1Title, button2Title;
 .    myResources.getString("OkKey", button1Title, success );
 .    myResources.getString("CancelKey", button2Title, success );
 
Draft:

Definition at line 151 of file resbund.h.


Member Function Documentation

ResourceBundle::ResourceBundle (const UnicodeString & path, const Locale & locale, UErrorCode & err)

Constructor.

Parameters:
path   This is a full pathname in the platform-specific format for the directory containing the resource data files we want to load resources from. We use locale IDs to generate filenames, and the filenames have this string prepended to them before being passed to the C++ I/O functions. Therefore, this string must always end with a directory delimiter (whatever that is for the target OS) for this class to work correctly.
locale   This is the locale this resource bundle is for. To get resources for the French locale, for example, you would create a ResourceBundle passing Locale::FRENCH for the "locale" parameter, and all subsequent calls to that resource bundle will return resources that pertain to the French locale. If the caller doesn't pass a locale parameter, the default locale for the system (as returned by Locale::getDefault()) will be used. The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of U_SUCCESS(err). If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found.
Draft:

ResourceBundle::ResourceBundle (const UnicodeString & path, UErrorCode & err)

ResourceBundle::ResourceBundle (const wchar_t * path, const Locale & locale, UErrorCode & err)

ResourceBundle::ResourceBundle (const ResourceBundle & original)

ResourceBundle::ResourceBundle (UResourceBundle * res)

ResourceBundle& ResourceBundle::operator= (const ResourceBundle & other)

ResourceBundle::~ResourceBundle ()

int32_t ResourceBundle::getSize (void) const

Returns the size of a resource.

Size for scalar types is always 1, and for vector/table types is the number of child resources.

Returns:
number of resources in a given resource.
Draft:

UnicodeString ResourceBundle::getString (UErrorCode & status) const

returns a string from a string resource type.

Parameters:
status:   fills in the outgoing error code could be U_MISSING_RESOURCE_ERROR if the key is not found could be a non-failing error e.g.: U_USING_FALLBACK_ERROR,U_USING_DEFAULT_ERROR
Returns:
a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
Draft:

const uint8_t* ResourceBundle::getBinary (int32_t & len, UErrorCode & status) const

UBool ResourceBundle::hasNext (void) const

Checks whether the resource has another element to iterate over.

Returns:
TRUE if there are more elements, FALSE if there is no more elements
Draft:

void ResourceBundle::resetIterator (void)

Resets the internal context of a resource so that iteration starts from the first element.

Draft:

const char * ResourceBundle::getKey (void)

Returns the key associated with this resource.

Not all the resources have a key - only those that are members of a table.

Returns:
a key associated to this resource, or NULL if it doesn't have a key
Draft:

const char* ResourceBundle::getName (void)

UResType ResourceBundle::getType (void)

Returns the type of a resource.

Available types are defined in enum UResType

Returns:
type of the given resource.
Draft:

ResourceBundle ResourceBundle::getNext (UErrorCode & status)

Returns the next resource in a given resource or NULL if there are no more resources.

Parameters:
status   fills in the outgoing error code
Returns:
ResourceBundle object.
Draft:

UnicodeString ResourceBundle::getNextString (UErrorCode & status)

Returns the next string in a resource or NULL if there are no more resources to iterate over.

Parameters:
status   fills in the outgoing error code
Returns:
an UnicodeString object.
Draft:

UnicodeString ResourceBundle::getNextString (const char ** key, UErrorCode & status)

Returns the next string in a resource or NULL if there are no more resources to iterate over.

Parameters:
key   fill in for key associated with this string
status   fills in the outgoing error code
Returns:
an UnicodeString object.
Draft:

ResourceBundle ResourceBundle::get (int32_t index, UErrorCode & status) const

Returns the resource in a resource at the specified index.

Parameters:
index   an index to the wanted resource.
status   fills in the outgoing error code
Returns:
ResourceBundle object. If there is an error, resource is invalid.
Draft:

UnicodeString ResourceBundle::getStringEx (int32_t index, UErrorCode & status) const

Returns the string in a given resource at the specified index.

Parameters:
index   an index to the wanted string.
status   fills in the outgoing error code
Returns:
an UnicodeString object. If there is an error, string is bogus
Draft:

ResourceBundle ResourceBundle::get (const char * key, UErrorCode & status) const

Returns a resource in a resource that has a given key.

This procedure works only with table resources.

Parameters:
key   a key associated with the wanted resource
status   fills in the outgoing error code.
Returns:
ResourceBundle object. If there is an error, resource is invalid.
Draft:

UnicodeString ResourceBundle::getStringEx (const char * key, UErrorCode & status) const

Returns a string in a resource that has a given key.

This procedure works only with table resources.

Parameters:
key   a key associated with the wanted string
status   fills in the outgoing error code
Returns:
an UnicodeString object. If there is an error, string is bogus
Draft:

const UnicodeString * ResourceBundle::getString (const char * resourceTag, UErrorCode & err) const

Returns the contents of a string resource.

Resource data is undifferentiated Unicode text. The resource file may contain quoted strings or escape sequences; these will be parsed prior to the data's return.

Parameters:
resourceTag   The resource tag of the string resource the caller wants
err   Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found.
Returns:
A pointer to the string from the resource bundle, or NULL if there was an error.(its lifetime is that of the resource bundle.)
Deprecated:
to be removed in first release in 2001

const UnicodeString * ResourceBundle::getStringArray (const char * resourceTag, int32_t & numArrayItems, UErrorCode & err) const

Returns the contents of a string-array resource.

This will return the contents of a string-array (comma-delimited-list) resource as a C++ array of UnicodeString objects. The number of elements in the array is returned in numArrayItems. Calling getStringArray on a resource of type string will return an array with one element; calling it on a resource of type tagged-array results in a U_MISSING_RESOURCE_ERROR error.

Parameters:
resourceTag   The resource tag of the string-array resource the caller wants
numArrayItems   Receives the number of items in the array the function returns.
err   Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found.
Returns:
The resource requested, as a pointer to an array of UnicodeStrings. The caller does not own the storage and must not delete it. (its lifetime is that of the resource bundle.)
Deprecated:
to be removed in first release in 2001

const UnicodeString * ResourceBundle::getArrayItem (const char * resourceTag, int32_t index, UErrorCode & err) const

Returns a single item from a string-array resource.

This will return the contents of a single item in a resource of string-array (comma-delimited-list) type. If the resource is not an array, a U_MISSING_RESOURCE_ERROR will be returned in err.

Parameters:
resourceTag   The resource tag of the resource the caller wants to extract an item from.
index   The index (zero-based) of the particular array item the user wants to extract from the resource.
err   Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found, or if the index was out of range.
Returns:
A pointer to the text of the array item, or NULL is there was an error. (its lifetime is that of the resource bundle.)
Deprecated:
to be removed in first release in 2001

const UnicodeString ** ResourceBundle::get2dArray (const char * resourceTag, int32_t & rowCount, int32_t & columnCount, UErrorCode & err) const

Return the contents of a 2-dimensional array resource.

The return value will be a UnicodeString** array. (This is really an array of pointers; each pointer is a ROW of the data.) The number of rows and columns is returned. If the resource is of the wrong type, or not present, U_MISSING_RESOURCE_ERROR is placed in err.

Parameters:
resourceTag   The resource tag of the string-array resource the caller wants
rowCount   Receives the number of rows in the array the function returns.
columnCount   Receives the number of columns in the array the function returns.
err   Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found.
Returns:
The resource requested, as a UnicodeStrings**. The caller does not own the storage and must not delete it. (its lifetime is that of the resource bundle.)
Deprecated:
to be removed in first release in 2001

const UnicodeString * ResourceBundle::get2dArrayItem (const char * resourceTag, int32_t rowIndex, int32_t columnIndex, UErrorCode & err) const

Return a single string from a 2-dimensional array resource.

If the resource does not exists, or if it is not a 2-d array, or if the row or column indices are out of bounds, err is set to U_MISSING_RESOURCE_ERROR.

Parameters:
resourceTag   The resource tag of the resource the caller wants to extract an item from.
rowIndex   The row index (zero-based) of the array item the user wants to extract from the resource.
columnIndex   The column index (zero-based) of the array item the user wants to extract from the resource.
err   Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found, if the resource data was in the wrong format, or if either index is out of bounds.
Returns:
A pointer to the text of the array item, or NULL is there was an error. (its lifetime is that of the resource bundle.)
Deprecated:
to be removed in first release in 2001

const UnicodeString * ResourceBundle::getTaggedArrayItem (const char * resourceTag, const UnicodeString & itemTag, UErrorCode & err) const

Returns a single item from a tagged-array resource This will return the contents of a single item in a resource of type tagged-array.

If this function is called for a resource that is not of type tagged-array, it will set err to MISSING_RESOUCE_ERROR.

Parameters:
resourceTag   The resource tag of the resource the caller wants to extract an item from.
itemTag   The item tag for the item the caller wants to extract.
err   Set to U_MISSING_RESOURCE_ERROR if a resource with the specified resource tag couldn't be found, or if an item with the specified item tag coldn't be found in the resource.
Returns:
A pointer to the text of the array item, or NULL is there was an error. (its lifetime is that of the resource bundle.)
Deprecated:
to be removed in first release in 2001

void ResourceBundle::getTaggedArray (const char * resourceTag, UnicodeString *& itemTags, UnicodeString *& items, int32_t & numItems, UErrorCode & err) const

Returns a tagged-array resource.

The contents of the resource is returned as two separate arrays of UnicodeStrings, the addresses of which are placed in "itemTags" and "items". After calling this function, the items in the resource will be in the list pointed to by "items", and for each items[i], itemTags[i] will be the tag that corresponds to it. The total number of entries in both arrays is returned in numItems.

Parameters:
resourceTag   The resource tag of the resource the caller wants to extract an item from.
itemTags   Set to point to an array of UnicodeStrings representing the tags in the specified resource. The caller DOES own this array, and must delete it.
items   Set to point to an array of UnicodeStrings containing the individual resource items themselves. itemTags[i] will contain the tag corresponding to items[i]. The caller DOES own this array, and must delete it.
numItems   Receives the number of items in the arrays pointed to by items and itemTags.
err   Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found.
Deprecated:
to be removed in first release in 2001

const char * ResourceBundle::getVersionNumber (void) const

Return the version number associated with this ResourceBundle.

This version number is a string of the form MAJOR.MINOR, where MAJOR is the version number of the current analytic code package, and MINOR is the version number contained in the resource file as the value of the tag "Version". A change in the MINOR version indicated an updated data file. A change in the MAJOR version indicates a new version of the code which is not binary-compatible with the previous version. If no "Version" tag is present in a resource file, the MINOR version "0" is assigned.

For example, if the Collation sort key algorithm changes, the MAJOR version increments. If the collation data in a resource file changes, the MINOR version for that file increments.

Returns:
A string of the form N.n, where N is the major version number, representing the code version, and n is the minor version number, representing the resource data file. The caller does not own this string.
Draft:

const Locale & ResourceBundle::getLocale (void) const

Return the Locale associated with this ResourceBundle.

Returns:
a Locale object
Draft:

Friends And Related Function Documentation

friend class RuleBasedCollator [friend]

Definition at line 589 of file resbund.h.


The documentation for this class was generated from the following file:
Generated at Mon Jun 5 12:53:20 2000 for ICU1.5 by doxygen 1.0.0 written by Dimitri van Heesch, © 1997-1999