View Javadoc
1 package org.apache.turbine.services.localization; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.util.Locale; 58 import java.util.MissingResourceException; 59 import java.util.ResourceBundle; 60 import org.apache.turbine.services.pull.ApplicationTool; 61 import org.apache.turbine.util.Log; 62 import org.apache.turbine.util.RunData; 63 64 /*** 65 * A pull tool which provides lookups for localized text by delegating 66 * to the configured <code>LocalizationService</code>. 67 * 68 * @author <a href="mailto:dlr@collab.net">Daniel Rall</a> 69 * @author <a href="mailto:jon@collab.net">Jon Stevens</a> 70 */ 71 public class LocalizationTool implements ApplicationTool 72 { 73 /*** 74 * The language and country information parsed from the request's 75 * <code>Accept-Language</code> header. Reset on each request. 76 */ 77 protected Locale locale; 78 79 /*** 80 * The bundle for this request. 81 */ 82 private ResourceBundle bundle; 83 84 /*** 85 * The name of the bundle for this tool to use. 86 */ 87 private String bundleName; 88 89 /*** 90 * Creates a new instance. Used by <code>PullService</code>. 91 */ 92 public LocalizationTool() 93 { 94 refresh(); 95 } 96 97 /*** 98 * <p>Performs text lookups for localization.</p> 99 * 100 * <p>Assuming there is a instance of this class with a HTTP 101 * request set in your template's context named <code>l10n</code>, 102 * the VTL <code>$l10n.HELLO</code> would render to 103 * <code>hello</code> for English requests and <code>hola</code> 104 * in Spanish (depending on the value of the HTTP request's 105 * <code>Accept-Language</code> header).</p> 106 * 107 * @param key The identifier for the localized text to retrieve. 108 * @return The localized text. 109 */ 110 public String get(String key) 111 { 112 try 113 { 114 return Localization.getString(getBundleName(null), getLocale(), key); 115 } 116 catch (MissingResourceException noKey) 117 { 118 Log.error(noKey); 119 return null; 120 } 121 } 122 123 /*** 124 * Gets the current locale. 125 * 126 * @return The locale currently in use. 127 */ 128 public Locale getLocale() 129 { 130 return locale; 131 } 132 133 /*** 134 * The return value of this method is used to set the name of the 135 * bundle used by this tool. Useful as a hook for using a 136 * different bundle than specifed in your 137 * <code>LocalizationService</code> configuration. 138 * 139 * @param data The inputs passed from {@link #init(Object)}. 140 * (ignored by this implementation). 141 */ 142 protected String getBundleName(Object data) 143 { 144 return Localization.getDefaultBundleName(); 145 } 146 147 148 // ApplicationTool implmentation 149 150 /*** 151 * Sets the request to get the <code>Accept-Language</code> header 152 * from (reset on each request). 153 */ 154 public final void init(Object data) 155 { 156 if (data instanceof RunData) 157 { 158 // Pull necessary information out of RunData while we have 159 // a reference to it. 160 locale = Localization.getLocale( ((RunData) data).getRequest() ); 161 bundleName = getBundleName(data); 162 } 163 } 164 165 /*** 166 * No-op. 167 */ 168 public void refresh() 169 { 170 locale = null; 171 bundle = null; 172 bundleName = null; 173 } 174 }

This page was automatically generated by Maven