Examples of hirondelle.web4j.ui.translate.Translation

• hirondelle.web4j.ui.translate.Translation
  Model Object for a translation.

  This class is provided as a convenience. Implementations of {@link Translator} are not required to use this class.

  As one of its {@link hirondelle.web4j.StartupTasks}, a typical implementation of {@link Translator} may fetch a {@code List} from some source (usually a database, perhaps some properties files), and keep a cache in memory.

  For looking up translations, the following nested {@link Map} structure is useful :

   Map[BaseText, Map[Locale, Translation]] 

  Here, BaseText and Translation are ordinary unescaped Strings, not {@link SafeText}. This is because the various translation tags in this package always first perform translation using ordinary unescaped Strings, and then perform any necessary escaping on the result of the translation.

  (See {@link Translator} for definition of 'base text'.)

  The {@link #asNestedMap(Collection)} method will modify a {@code List} into just such a structure. As well, {@link #lookUp(String,Locale,Map)} provides a simple default method for performing the typical lookup with such a structure, given base text and target locale.

  Usually String, but sometimes SafeText

  The following style will remain consistent, and will not escape special characters twice :

  • unescaped : translations stored in the database.
  • escaped : Translation objects (since they use {@link SafeText}). This allows end users to edit such objects just like any other data, with no danger of scripts executing in their browser.
  • unescaped : in-memory data, extracted from N Translation objects using {@link SafeText#getRawString()}. This in-memory data implements a Translator. Its data is not rendered directly in a JSP, so it can remain as String.
  • escaped : the various translation tags always perform the needed escaping on the raw String.

  The translation text usually remains as a String, yet {@link SafeText} is available when working with the data directly in a web page, in a form or listing.

Related Classes of hirondelle.web4j.ui.translate.Translation