hirondelle.web4j.request
Interface LocaleSource

All Known Implementing Classes:

LocaleSourceImpl

public interface LocaleSource

Return the Locale associated with a given request.

See BuildImpl for important information on how this item is configured. BuildImpl.forLocaleSource() returns the configured implementation of this interface. See LocaleSourceImpl for a default implementation. This interface is similar to TimeZoneSource, and is used in much the same way.

In general, a Locale is used for two distinct operations :

• render objects such as Integer, Date, and so on
• translate text from one language to another

Since almost all applications at least render data, then almost all applications will also use a Locale - even single-language applications.

In a single-language application, the returned Locale is used by WEB4J for rendering these items :

• user response messages containing numbers and dates
• presenting ResultSets as reports (dates, numbers)
• prepopulating forms (dates, numbers)
• displaying dates with ShowDate

If the application is multilingual, then the returned Locale is also used for translating text. See Translator and related classes for more information.

A very large number of policies can be defined by implementations of this interface. Possible sources of Locale information include :

• a single setting in web.xml, place into application scope upon startup
• an object stored in session scope
• a request parameter
• a request header
• a cookie

All WEB4J applications have at least one Locale - the DefaultLocale setting configured in web.xml. (This allows the application's Locale to be set explicitly, independent of the server's default Locale setting, or of browser header settings.) For applications which use only a single language, that Locale defines how WEB4J will format the items mentioned above. For multilingual applications, this web.xml setting is reinterpreted as the default Locale, which is overridden by implementations of this interface.

Method Summary

Locale

get(HttpServletRequest aRequest) Return a Locale corresponding to a given underlying request.

Method Detail

get

Locale get(HttpServletRequest aRequest)

Return a Locale corresponding to a given underlying request.