org.apache.turbine.services.localization
Interface LocalizationService

All Superinterfaces:
Initable, Service
All Known Implementing Classes:
TurbineLocalizationService

public interface LocalizationService
extends Service

Provides localization functionality using the interface provided by ResourceBundle.

Version:
$Id: LocalizationService.java,v 1.4 2002/02/27 17:17:23 dlr Exp $
Author:
Jon S. Stevens, Daniel Rall

Field Summary
static java.lang.String ACCEPT_LANGUAGE
          A constant for the HTTP Accept-Language header.
static java.lang.String SERVICE_NAME
          The name of this service.
 
Method Summary
 java.util.ResourceBundle getBundle()
          Convenience method to get a default ResourceBundle.
 java.util.ResourceBundle getBundle(javax.servlet.http.HttpServletRequest req)
          Convenience method to get a ResourceBundle based on HTTP Accept-Language header in HttpServletRequest.
 java.util.ResourceBundle getBundle(java.lang.String bundleName)
          Convenience method to get a ResourceBundle based on name.
 java.util.ResourceBundle getBundle(java.lang.String bundleName, javax.servlet.http.HttpServletRequest req)
          Convenience method to get a ResourceBundle based on name and HTTP Accept-Language header in HttpServletRequest.
 java.util.ResourceBundle getBundle(java.lang.String bundleName, java.util.Locale locale)
          Convenience method to get a ResourceBundle based on name and Locale.
 java.util.ResourceBundle getBundle(java.lang.String bundleName, java.lang.String languageHeader)
          Convenience method to get a ResourceBundle based on name and HTTP Accept-Language header.
 java.lang.String getDefaultBundleName()
          Retrieves the name of the default bundle (as specified in the config file), or the first in the list if there are more than one.
 java.util.Locale getLocale(javax.servlet.http.HttpServletRequest req)
          Attempts to pull the Accept-Language header out of the HttpServletRequest object and then parse it.
 java.util.Locale getLocale(java.lang.String languageHeader)
          This method parses the Accept-Language header and attempts to create a Locale out of it.
 java.lang.String getString(java.lang.String bundleName, java.util.Locale locale, java.lang.String key)
          Tries very hard to return a value, looking first in the specified bundle, then searching list of default bundles (giving precedence to earlier bundles over later bundles).
 void setBundle(java.lang.String defaultBundle)
          This method sets the name of the defaultBundle.
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
The name of this service.

ACCEPT_LANGUAGE

public static final java.lang.String ACCEPT_LANGUAGE
A constant for the HTTP Accept-Language header.
Method Detail

getDefaultBundleName

public java.lang.String getDefaultBundleName()
Retrieves the name of the default bundle (as specified in the config file), or the first in the list if there are more than one.

getBundle

public java.util.ResourceBundle getBundle()
Convenience method to get a default ResourceBundle.
Returns:
A localized ResourceBundle.

getBundle

public java.util.ResourceBundle getBundle(java.lang.String bundleName)
Convenience method to get a ResourceBundle based on name.
Parameters:
bundleName - Name of bundle.
Returns:
A localized ResourceBundle.

getBundle

public java.util.ResourceBundle getBundle(java.lang.String bundleName,
                                          java.lang.String languageHeader)
Convenience method to get a ResourceBundle based on name and HTTP Accept-Language header.
Parameters:
bundleName - Name of bundle.
languageHeader - A String with the language header.
Returns:
A localized ResourceBundle.

getBundle

public java.util.ResourceBundle getBundle(javax.servlet.http.HttpServletRequest req)
Convenience method to get a ResourceBundle based on HTTP Accept-Language header in HttpServletRequest.
Parameters:
req - The HTTP request to parse the Accept-Language of.
Returns:
A localized ResourceBundle.

getBundle

public java.util.ResourceBundle getBundle(java.lang.String bundleName,
                                          javax.servlet.http.HttpServletRequest req)
Convenience method to get a ResourceBundle based on name and HTTP Accept-Language header in HttpServletRequest.
Parameters:
bundleName - Name of bundle.
req - The HTTP request to parse the Accept-Language of.
Returns:
A localized ResourceBundle.

getBundle

public java.util.ResourceBundle getBundle(java.lang.String bundleName,
                                          java.util.Locale locale)
Convenience method to get a ResourceBundle based on name and Locale.
Parameters:
bundleName - Name of bundle.
locale - A Locale.
Returns:
A localized ResourceBundle.

getLocale

public java.util.Locale getLocale(javax.servlet.http.HttpServletRequest req)
Attempts to pull the Accept-Language header out of the HttpServletRequest object and then parse it. If the header is not present, it will return a null Locale.
Parameters:
req - The HTTP request to parse the Accept-Language of.
Returns:
The parsed locale.

getLocale

public java.util.Locale getLocale(java.lang.String languageHeader)
This method parses the Accept-Language header and attempts to create a Locale out of it.
Parameters:
languageHeader - The Accept-Language HTTP header.
Returns:
The parsed locale.

setBundle

public void setBundle(java.lang.String defaultBundle)
This method sets the name of the defaultBundle.
Parameters:
defaultBundle - Name of default bundle.

getString

public java.lang.String getString(java.lang.String bundleName,
                                  java.util.Locale locale,
                                  java.lang.String key)
Tries very hard to return a value, looking first in the specified bundle, then searching list of default bundles (giving precedence to earlier bundles over later bundles).
Parameters:
bundleName - Name of the bundle to look in first.
locale - Locale to get text for.
key - Name of the text to retrieve.
Returns:
Localized text.


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.