<i18n:text>
This is <strong>translated</strong> string.
</i18n:text>

<i18n:translate>
<i18n:text>This is translated string with {0} param</i18n:text>
<i18n:param>1</i18n:param>
</i18n:translate>

Also see:

I18N_TEXT_ELEMENT
I18N_PARAM_ELEMENT

To specify what to do if no locale matched, simply add a node with locale="*". Note that this element must be the last child of <i18n:choose>.

<i18n:choose>
<i18n:when locale="en">
Good Morning
</en>
<i18n:when locale="fr">
Bonjour
</jp>
<i18n:when locale="jp">
Aligato?
</jp>
<i18n:otherwise>
Sorry, i don't know how to say hello in your language
</jp>
<i18n:translate>

You can include any markup within i18n:when elements, with the exception of other i18n:* elements.

Also see:

I18N_IF_ELEMENT
I18N_LOCALE_ATTRIBUTE
since: 2.1 -

<greeting>
<i18n:when locale="en">Hello</i18n:when>
<i18n:when locale="fr">Bonjour</i18n:when>
</greeting>

Also see:

I18N_LOCALE_ATTRIBUTE
I18N_CHOOSE_ELEMENT
since: 2.1 -

<greeting>
<i18n:if locale="en">Hello</i18n:when>
<i18n:if locale="fr">Bonjour</i18n:when>
</greeting>

Also see:

I18N_LOCALE_ATTRIBUTE
I18N_CHOOSE_ELEMENT
I18N_WHEN_ELEMENT
since: 2.1 -

Also see:

I18N_CHOOSE_ELEMENT
I18N_WHEN_ELEMENT
since: 2.1 -

• type: can be date, date-time, time, number, currency, currency-no-unit or percent. Used to format params before substitution.
• value: the value of the param. If no value is specified then the text inside of the param element will be used.
• locale: used only with number, date, time, date-time types and used to override the current locale to format the given value.
• src-locale: used with number, date, time, date-time types and specify the locale that should be used to parse the given value.
• pattern: used with number, date, time, date-time types and specify the pattern that should be used to format the given value.
• src-pattern: used with number, date, time, date-time types and specify the pattern that should be used to parse the given value.

Also see:

I18N_TRANSLATE_ELEMENT
I18N_DATE_ELEMENT
I18N_TIME_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_NUMBER_ELEMENT

since: 2.1 -

<i18n:date src-pattern="short" src-locale="en_US" locale="de_DE">
12/24/01
</i18n:date>

<i18n:date pattern="dd/MM/yyyy" />

<i18n:date />

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_TIME_ELEMENT
I18N_NUMBER_ELEMENT

<i18n:date-time src-pattern="short" src-locale="en_US" locale="de_DE">
12/24/01 1:00 AM
</i18n:date>

<i18n:date-time pattern="dd/MM/yyyy hh:mm" />

<i18n:date-time />

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_ELEMENT
I18N_TIME_ELEMENT
I18N_NUMBER_ELEMENT

<i18n:time src-pattern="short" src-locale="en_US" locale="de_DE">
1:00 AM
</i18n:time>

<i18n:time pattern="hh:mm:ss" />

<i18n:time />

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_DATE_ELEMENT
I18N_NUMBER_ELEMENT

<i18n:number src-pattern="short" src-locale="en_US" locale="de_DE">
1000.0
</i18n:number>

<i18n:number type="currency" />

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_TIME_ELEMENT
I18N_DATE_ELEMENT

<i18n:text i18n:key="a_key">article_text1</i18n:text>

<para title="first" name="article" i18n:attr="title name"/>

<para title="first" name="{one} {two}" i18n:attr="name"/>

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_DATE_ELEMENT
I18N_TIME_ELEMENT
I18N_NUMBER_ELEMENT

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_DATE_ELEMENT
I18N_TIME_ELEMENT
I18N_NUMBER_ELEMENT

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_DATE_ELEMENT
I18N_TIME_ELEMENT
I18N_NUMBER_ELEMENT
I18N_WHEN_ELEMENT

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_DATE_ELEMENT
I18N_TIME_ELEMENT
I18N_NUMBER_ELEMENT

Also see:

I18N_PARAM_ELEMENT
I18N_DATE_TIME_ELEMENT
I18N_DATE_ELEMENT
I18N_TIME_ELEMENT
I18N_NUMBER_ELEMENT

 public  void characters(char[] ch,
    int start,
    int len) throws SAXException 
{
        if (current_state == STATE_OUTSIDE ||
                ((current_state == STATE_INSIDE_WHEN ||
                current_state == STATE_INSIDE_OTHERWISE) && translate_copy)) {
            super.characters(ch, start, len);
        } else {
            // Perform buffering to prevent chunked character data
            if (strBuffer == null) {
                strBuffer = new StringBuffer();
            }
            strBuffer.append(ch, start, len);
        }
}

 public  void configure(Configuration conf) throws ConfigurationException 
{
        // Read in the config options from the transformer definition
        Configuration cataloguesConf = conf.getChild("catalogues", false);
        if (cataloguesConf == null) {
            throw new ConfigurationException("Required < catalogues > configuration is missing.",
                                             conf);
        }
        // new configuration style
        Configuration[] catalogueConfs = cataloguesConf.getChildren("catalogue");
        catalogues = new HashMap(catalogueConfs.length + 3);
        for (int i = 0; i <  catalogueConfs.length; i++) {
            String id = catalogueConfs[i].getAttribute("id");
            String name = catalogueConfs[i].getAttribute("name");
            String[] locations;
            String location = catalogueConfs[i].getAttribute("location", null);
            Configuration[] locationConf = catalogueConfs[i].getChildren("location");
            if (location != null) {
                if (locationConf.length  > 0) {
                    String msg = "Location attribute cannot be " +
                                 "specified with location elements";
                    getLogger().error(msg);
                    throw new ConfigurationException(msg, catalogueConfs[i]);
                }
                if (getLogger().isDebugEnabled()) {
                    getLogger().debug("name=" + name + ", location=" +
                                      location);
                }
                locations = new String[1];
                locations[0] = location;
            } else {
                if (locationConf.length == 0) {
                    String msg = "A location attribute or location " +
                                 "elements must be specified";
                    getLogger().error(msg);
                    throw new ConfigurationException(msg, catalogueConfs[i]);
                }
                locations = new String[locationConf.length];
                for (int j=0; j <  locationConf.length; ++j) {
                    locations[j] = locationConf[j].getValue();
                    if (getLogger().isDebugEnabled()) {
                        getLogger().debug("name=" + name + ", location=" +
                                          locations[j]);
                    }
                }
            }
            CatalogueInfo catalogueInfo;
            try {
                catalogueInfo = new CatalogueInfo(name, locations);
            } catch (PatternException e) {
                throw new ConfigurationException("Error in name or location attribute on catalogue " +
                                                 "element with id " + id, catalogueConfs[i], e);
            }
            catalogues.put(id, catalogueInfo);
        }
        String defaultCatalogueId = cataloguesConf.getAttribute("default");
        defaultCatalogue = (CatalogueInfo) catalogues.get(defaultCatalogueId);
        if (defaultCatalogue == null) {
            throw new ConfigurationException("Default catalogue id '" + defaultCatalogueId +
                                             "' denotes a nonexisting catalogue", cataloguesConf);
        }
        // Obtain default text to use for untranslated messages
        defaultUntranslated = conf.getChild(I18N_UNTRANSLATED).getValue(null);
        if (getLogger().isDebugEnabled()) {
            getLogger().debug("Default untranslated text is '" + defaultUntranslated + "'");
        }
        // Preload specified catalogues (if any)
        Configuration[] preloadConfs = conf.getChildren(I18N_PRELOAD);
        for (int i = 0; i <  preloadConfs.length; i++) {
            String localeStr = preloadConfs[i].getValue();
            this.locale = I18nUtils.parseLocale(localeStr);
            String id = preloadConfs[i].getAttribute("catalogue", null);
            if (id != null) {
                CatalogueInfo catalogueInfo = (CatalogueInfo) catalogues.get(id);
                if (catalogueInfo == null) {
                    throw new ConfigurationException("Invalid catalogue id '" + id +
                                                     "' in preload element.", preloadConfs[i]);
                }
                try {
                    catalogueInfo.getCatalogue();
                } finally {
                    catalogueInfo.releaseCatalog();
                }
            } else {
                for (Iterator j = catalogues.values().iterator(); j.hasNext(); ) {
                    CatalogueInfo catalogueInfo = (CatalogueInfo) j.next();
                    try {
                        catalogueInfo.getCatalogue();
                    } finally {
                        catalogueInfo.releaseCatalog();
                    }
                }
            }
        }
        this.locale = null;
}

Implementation of Configurable interface. Configure this transformer.

 public  void dispose() 
{
        if (manager != null) {
            manager.release(factory);
        }
        factory = null;
        manager = null;
        catalogues = null;
}

 public  void endElement(String uri,
    String name,
    String raw) throws SAXException 
{
        // Handle previously buffered characters
        if (current_state != STATE_OUTSIDE && strBuffer != null) {
            i18nCharacters(strBuffer.toString());
            strBuffer = null;
        }
        if (I18nUtils.matchesI18nNamespace(uri)) {
            endI18NElement(name);
        } else if (current_state == STATE_INSIDE_PARAM) {
            param_recorder.endElement(uri, name, raw);
        } else if (current_state == STATE_INSIDE_TEXT) {
            text_recorder.endElement(uri, name, raw);
        } else if (current_state == STATE_INSIDE_CHOOSE ||
                (current_state == STATE_INSIDE_WHEN ||
                current_state == STATE_INSIDE_OTHERWISE)
                && !translate_copy) {
            // Output nothing
        } else {
            super.endElement(uri, name, raw);
        }
}

 public Serializable getKey() 
{
        // TODO: Key should be composed out of used catalogues locations, and locale.
        //       Right now it is hardcoded only to default catalogue location.
        StringBuffer key = new StringBuffer();
        if (catalogue != null) {
            key.append(catalogue.getLocation()[0]);
        }
        key.append("?");
        if (locale != null) {
            key.append(locale.getLanguage());
            key.append("_");
            key.append(locale.getCountry());
            key.append("_");
            key.append(locale.getVariant());
        }
        return key.toString();
}

Implemenation of CacheableProcessingComponents. Generates unique key for the current locale.

 public Locale getLocale() 
{
        return this.locale;
}

Returns the current locale setting of this transformer instance.

 protected ParamSaxBuffer getMessage(String catalogueID,
    String key) 
{
        if (getLogger().isDebugEnabled()) {
            getLogger().debug("Getting key " + key + " from catalogue " + catalogueID);
        }
        CatalogueInfo catalogue = this.catalogue;
        if (catalogueID != null) {
            catalogue = (CatalogueInfo)catalogues.get(catalogueID);
            if (catalogue == null) {
                if (getLogger().isWarnEnabled()) {
                    getLogger().warn("Catalogue not found: " + catalogueID +
                                     ", will not translate key " + key);
                }
                return null;
            }
        }
        Bundle bundle = catalogue.getCatalogue();
        if (bundle == null) {
            // Can't translate
            getLogger().debug("Untranslated key: '" + key + "'");
            return null;
        }
        try {
            return (ParamSaxBuffer) bundle.getObject(key);
        } catch (MissingResourceException e)  {
            getLogger().debug("Untranslated key: '" + key + "'");
        }
        return null;
}

Helper method to retrieve a message from the dictionary.

 public SourceValidity getValidity() 
{
        // FIXME (KP): Cache validity should be generated by
        // Bundle implementations.
        return org.apache.excalibur.source.impl.validity.NOPValidity.SHARED_INSTANCE;
}

Implementation of CacheableProcessingComponent. Generates validity object for this transformer or null if this instance is not cacheable.

 public  void recycle() 
{
        this.untranslatedRecorder = null;
        this.catalogue = null;
        this.objectModel = null;
        // Release catalogues which were selected for current locale
        Iterator i = catalogues.values().iterator();
        while (i.hasNext()) {
            CatalogueInfo catalogueInfo = (CatalogueInfo) i.next();
            catalogueInfo.releaseCatalog();
        }
        super.recycle();
}

 public  void service(ServiceManager manager) throws ServiceException 
{
        this.manager = manager;
        try {
            this.factory = (BundleFactory) manager.lookup(BundleFactory.ROLE);
        } catch (ServiceException e) {
            getLogger().debug("Failed to lookup < " + BundleFactory.ROLE + " >", e);
            throw e;
        }
}

Look up the BundleFactory to be used.

 public  void setup(SourceResolver resolver,
    Map objectModel,
    String source,
    Parameters parameters) throws IOException, SAXException, ProcessingException 
{
        this.objectModel = objectModel;
        untranslated = parameters.getParameter(I18N_UNTRANSLATED, defaultUntranslated);
        if (untranslated != null) {
            untranslatedRecorder = new ParamSaxBuffer();
            untranslatedRecorder.characters(untranslated.toCharArray(), 0, untranslated.length());
        }
        // Get current locale
        String lc = parameters.getParameter(I18N_LOCALE, null);
        Locale locale = I18nUtils.parseLocale(lc);
        if (getLogger().isDebugEnabled()) {
            getLogger().debug("Using locale '" + locale + "'");
        }
        // Initialize instance state variables
        this.locale             = locale;
        this.current_state      = STATE_OUTSIDE;
        this.prev_state         = STATE_OUTSIDE;
        this.currentKey        = null;
        this.currentCatalogueId = null;
        this.translate_copy     = false;
        this.tr_text_recorder   = null;
        this.text_recorder      = new ParamSaxBuffer();
        this.param_count        = 0;
        this.param_name         = null;
        this.param_value        = null;
        this.param_recorder     = null;
        this.indexedParams      = new HashMap(3);
        this.formattingParams   = null;
        this.strBuffer          = null;
        // give the catalogue variable its value -- first look if it's locally overridden
        // and otherwise use the component-wide defaults.
        String catalogueId = parameters.getParameter(I18N_DEFAULT_CATALOGUE_ID, null);
        if (catalogueId != null) {
            CatalogueInfo catalogueInfo = (CatalogueInfo) catalogues.get(catalogueId);
            if (catalogueInfo == null) {
                throw new ProcessingException("I18nTransformer: '" +
                                              catalogueId +
                                              "' is not an existing catalogue id.");
            }
            catalogue = catalogueInfo;
        } else {
            catalogue = defaultCatalogue;
        }
        if (getLogger().isDebugEnabled()) {
            getLogger().debug("Default catalogue is " + catalogue.getName());
        }
}

Setup current instance of transformer.

 public  void startElement(String uri,
    String name,
    String raw,
    Attributes attr) throws SAXException 
{
        // Handle previously buffered characters
        if (current_state != STATE_OUTSIDE && strBuffer != null) {
            i18nCharacters(strBuffer.toString());
            strBuffer = null;
        }
        // Process start element event
        if (I18nUtils.matchesI18nNamespace(uri)) {
            if (getLogger().isDebugEnabled()) {
                getLogger().debug("Starting i18n element: " + name);
            }
            startI18NElement(name, attr);
        } else {
            // We have a non i18n element event
            if (current_state == STATE_OUTSIDE) {
                super.startElement(uri, name, raw,
                                   translateAttributes(name, attr));
            } else if (current_state == STATE_INSIDE_PARAM) {
                param_recorder.startElement(uri, name, raw, attr);
            } else if (current_state == STATE_INSIDE_TEXT) {
                text_recorder.startElement(uri, name, raw, attr);
            } else if ((current_state == STATE_INSIDE_WHEN ||
                    current_state == STATE_INSIDE_OTHERWISE)
                    && translate_copy) {
                super.startElement(uri, name, raw, attr);
            }
        }
}