Java tutorial
/* * Copyright 2012 Eng Kam Hon (kamhon@gmail.com) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package net.kamhon.ieagle.struts2; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Locale; import java.util.ResourceBundle; import net.kamhon.ieagle.application.Application; import net.kamhon.ieagle.function.language.service.LanguageFrameworkService; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.LocaleProvider; import com.opensymphony.xwork2.ResourceBundleTextProvider; import com.opensymphony.xwork2.TextProviderFactory; import com.opensymphony.xwork2.util.LocalizedTextUtil; import com.opensymphony.xwork2.util.ValueStack; /** * This is copied and modify from <code>TextProviderSupport</code>.<br/> * Default TextProvider implementation. * * @see com.opensymphony.xwork2.TextProviderSupport * @see TextProviderFactory */ public class JTextProviderSupport implements ResourceBundleTextProvider { private static final Log log = LogFactory.getLog(JTextProviderSupport.class); private Class<?> clazz; private LocaleProvider localeProvider; private ResourceBundle bundle; private LanguageFrameworkService languageFrameworkService; /** * Default constructor */ public JTextProviderSupport() { log.debug("JTextProviderSupport "); languageFrameworkService = (LanguageFrameworkService) Application .lookupBean(LanguageFrameworkService.BEAN_NAME); } /** * Constructor. * * @param clazz * a clazz to use for reading the resource bundle. * @param provider * a locale provider. */ public JTextProviderSupport(Class<?> clazz, LocaleProvider provider) { this.clazz = clazz; this.localeProvider = provider; languageFrameworkService = (LanguageFrameworkService) Application .lookupBean(LanguageFrameworkService.BEAN_NAME); } /** * Constructor. * * @param bundle * the resource bundle. * @param provider * a locale provider. */ public JTextProviderSupport(ResourceBundle bundle, LocaleProvider provider) { this.bundle = bundle; this.localeProvider = provider; languageFrameworkService = (LanguageFrameworkService) Application .lookupBean(LanguageFrameworkService.BEAN_NAME); } /** * @param bundle * the resource bundle. */ public void setBundle(ResourceBundle bundle) { this.bundle = bundle; } /** * @param clazz * a clazz to use for reading the resource bundle. */ @SuppressWarnings("rawtypes") public void setClazz(Class clazz) { this.clazz = clazz; } /** * @param localeProvider * a locale provider. */ public void setLocaleProvider(LocaleProvider localeProvider) { this.localeProvider = localeProvider; } /** * Checks if a key is available in the resource bundles associated with this action. The resource bundles are * searched, starting with the one associated with this particular action, and testing all its superclasses' * bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that * allow global texts to be defined for an application base class. */ public boolean hasKey(String key) { String message; message = languageFrameworkService.getText(key, getLocale(), null); if (message != null) { return true; } else if (clazz != null) { message = LocalizedTextUtil.findText(clazz, key, getLocale(), null, new Object[0]); } else { message = LocalizedTextUtil.findText(bundle, key, getLocale(), null, new Object[0]); } return message != null; } /** * Get a text from the resource bundles associated with this action. The resource bundles are searched, starting * with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once * a bundle is found that contains the given text. This gives a cascading style that allow global texts to be * defined for an application base class. * * @param key * name of text to be found * @return value of named text */ public String getText(String key) { return getText(key, key, Collections.emptyList()); } /** * Get a text from the resource bundles associated with this action. The resource bundles are searched, starting * with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once * a bundle is found that contains the given text. This gives a cascading style that allow global texts to be * defined for an application base class. If no text is found for this text name, the default value is returned. * * @param key * name of text to be found * @param defaultValue * the default value which will be returned if no text is found * @return value of named text */ public String getText(String key, String defaultValue) { return getText(key, defaultValue, Collections.emptyList()); } /** * Get a text from the resource bundles associated with this action. The resource bundles are searched, starting * with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once * a bundle is found that contains the given text. This gives a cascading style that allow global texts to be * defined for an application base class. If no text is found for this text name, the default value is returned. * * @param key * name of text to be found * @param defaultValue * the default value which will be returned if no text is found * @return value of named text */ public String getText(String key, String defaultValue, String arg) { List<Object> args = new ArrayList<Object>(); args.add(arg); return getText(key, defaultValue, args); } /** * Get a text from the resource bundles associated with this action. The resource bundles are searched, starting * with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once * a bundle is found that contains the given text. This gives a cascading style that allow global texts to be * defined for an application base class. If no text is found for this text name, the default value is returned. * * @param key * name of text to be found * @param args * a List of args to be used in a MessageFormat message * @return value of named text */ public String getText(String key, List<?> args) { return getText(key, key, args); } /** * Get a text from the resource bundles associated with this action. The resource bundles are searched, starting * with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once * a bundle is found that contains the given text. This gives a cascading style that allow global texts to be * defined for an application base class. If no text is found for this text name, the default value is returned. * * @param key * name of text to be found * @param args * an array of args to be used in a MessageFormat message * @return value of named text */ public String getText(String key, String[] args) { return getText(key, key, args); } /** * Get a text from the resource bundles associated with this action. The resource bundles are searched, starting * with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once * a bundle is found that contains the given text. This gives a cascading style that allow global texts to be * defined for an application base class. If no text is found for this text name, the default value is returned. * * @param key * name of text to be found * @param defaultValue * the default value which will be returned if no text is found * @param args * a List of args to be used in a MessageFormat message * @return value of named text */ public String getText(String key, String defaultValue, List<?> args) { Object[] argsArray = ((args != null && !args.equals(Collections.emptyList())) ? args.toArray() : null); String text = languageFrameworkService.getText(key, getLocale(), argsArray); if (text != null && !key.equals(text)) { return text; } else if (clazz != null) { return LocalizedTextUtil.findText(clazz, key, getLocale(), defaultValue, argsArray); } else { return LocalizedTextUtil.findText(bundle, key, getLocale(), defaultValue, argsArray); } } /** * Get a text from the resource bundles associated with this action. The resource bundles are searched, starting * with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once * a bundle is found that contains the given text. This gives a cascading style that allow global texts to be * defined for an application base class. If no text is found for this text name, the default value is returned. * * @param key * name of text to be found * @param defaultValue * the default value which will be returned if no text is found * @param args * an array of args to be used in a MessageFormat message * @return value of named text */ public String getText(String key, String defaultValue, String[] args) { String text = languageFrameworkService.getText(key, getLocale(), args); if (text != null && !key.equals(text)) { return text; } else if (clazz != null) { return LocalizedTextUtil.findText(clazz, key, getLocale(), defaultValue, args); } else { return LocalizedTextUtil.findText(bundle, key, getLocale(), defaultValue, args); } } /** * Gets a message based on a key using the supplied args, as defined in {@link java.text.MessageFormat}, or, if the * message is not found, a supplied default value is returned. Instead of using the value stack in the ActionContext * this version of the getText() method uses the provided value stack. * * @param key * the resource bundle key that is to be searched for * @param defaultValue * the default value which will be returned if no message is found * @param args * a list args to be used in a {@link java.text.MessageFormat} message * @param stack * the value stack to use for finding the text * @return the message as found in the resource bundle, or defaultValue if none is found */ public String getText(String key, String defaultValue, List<?> args, ValueStack stack) { Object[] argsArray = ((args != null) ? args.toArray() : null); Locale locale; if (stack == null) { locale = getLocale(); } else { locale = (Locale) stack.getContext().get(ActionContext.LOCALE); } if (locale == null) { locale = getLocale(); } String text = languageFrameworkService.getText(key, locale, argsArray); if (text != null && !key.equals(text)) { return text; } else if (clazz != null) { return LocalizedTextUtil.findText(clazz, key, locale, defaultValue, argsArray, stack); } else { return LocalizedTextUtil.findText(bundle, key, locale, defaultValue, argsArray, stack); } } /** * Gets a message based on a key using the supplied args, as defined in {@link java.text.MessageFormat}, or, if the * message is not found, a supplied default value is returned. Instead of using the value stack in the ActionContext * this version of the getText() method uses the provided value stack. * * @param key * the resource bundle key that is to be searched for * @param defaultValue * the default value which will be returned if no message is found * @param args * an array args to be used in a {@link java.text.MessageFormat} message * @param stack * the value stack to use for finding the text * @return the message as found in the resource bundle, or defaultValue if none is found */ public String getText(String key, String defaultValue, String[] args, ValueStack stack) { Locale locale; if (stack == null) { locale = getLocale(); } else { locale = (Locale) stack.getContext().get(ActionContext.LOCALE); } if (locale == null) { locale = getLocale(); } String text = languageFrameworkService.getText(key, locale, null); if (text != null && !key.equals(text)) { return text; } else if (clazz != null) { return LocalizedTextUtil.findText(clazz, key, locale, defaultValue, args, stack); } else { return LocalizedTextUtil.findText(bundle, key, locale, defaultValue, args, stack); } } /** * Get the named bundle. * <p/> * You can override the getLocale() methodName to change the behaviour of how to choose locale for the bundles that * are returned. Typically you would use the TextProvider interface to get the users configured locale, or use your * own methodName to allow the user to select the locale and store it in the session (by using the SessionAware * interface). * * @param aBundleName * bundle name * @return a resource bundle */ public ResourceBundle getTexts(String aBundleName) { return LocalizedTextUtil.findResourceBundle(aBundleName, getLocale()); } /** * Get the resource bundle associated with this action. This will be based on the actual subclass that is used. * * @return resouce bundle */ public ResourceBundle getTexts() { if (clazz != null) { return getTexts(clazz.getName()); } return bundle; } /** * Get's the locale from the localeProvider. * * @return the locale from the localeProvider. */ private Locale getLocale() { return localeProvider.getLocale(); } }