edu.cornell.mannlib.vitro.webapp.i18n

Class VitroResourceBundle

java.lang.Object

java.util.ResourceBundle

edu.cornell.mannlib.vitro.webapp.i18n.VitroResourceBundle

public class VitroResourceBundle
extends ResourceBundle

Works like a PropertyResourceBundle with two exceptions: It looks for the file in both the i18n directory of the theme and in the i18n directory of the application. Properties found in the theme override those found in the application. It allows a property to take its contents from a file. File paths are relative to the i18n directory. Again, a file in the theme will override one in the application. If a property has a value (after overriding) of "@@file <filepath>", the bundle looks for the file relative to the i18n directory of the theme, then relative to the i18n directory of the application. If the file is not found in either location, a warning is written to the log and the property will contain an error message for displayed. Note that the filename is not manipulated for Locale, so the author of the properties files must do it explicitly. For example: In all.properties: account_email_html = @@file accountEmail.html In all_es.properties: account_email_html = @@file accountEmail_es.html

Nested Class Summary

Nested classes/interfaces inherited from class java.util.ResourceBundle

ResourceBundle.Control

Field Summary

Fields inherited from class java.util.ResourceBundle

parent

Method Summary

Modifier and Type	Method and Description
static void	addAppPrefix(String prefix)
static VitroResourceBundle	getBundle(String bundleName, javax.servlet.ServletContext ctx, String appI18nPath, String themeI18nPath, ResourceBundle.Control control) Returns the bundle for the for foo_ba_RR, providing that foo_ba_RR.properties exists in the I18n area of either the theme or the application.
Enumeration<String>	getKeys()
protected Object	handleGetObject(String key)

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, handleKeySet, keySet, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addAppPrefix

public static void addAppPrefix(String prefix)

getBundle

public static VitroResourceBundle getBundle(String bundleName,
                                            javax.servlet.ServletContext ctx,
                                            String appI18nPath,
                                            String themeI18nPath,
                                            ResourceBundle.Control control)

Returns the bundle for the for foo_ba_RR, providing that foo_ba_RR.properties exists in the I18n area of either the theme or the application. If the desired file doesn't exist in either location, return null. Usually, this does not indicate a problem but only that we were looking for too specific a bundle. For example, if the base name of the bundle is "all" and the locale is "en_US", we will likely return null on the search for all_en_US.properties, and all_en.properties, but will return a full bundle for all.properties. Of course, if all.properties doesn't exist either, then we have a problem, but that will be reported elsewhere.

Returns:

the populated bundle or null.

getKeys

public Enumeration<String> getKeys()

Specified by:

getKeys in class ResourceBundle

handleGetObject

protected Object handleGetObject(String key)

Specified by:

handleGetObject in class ResourceBundle