| org.apache.cocoon.transformation.AbstractTransformer
 org.apache.cocoon.transformation.I18nTransformer
All known Subclasses: org.apache.cocoon.portal.tools.transformation.PortalToolsI18nTransformer,
| Inner Class :final public class CatalogueInfo | |
| Field Summary | |
| final public static String | CURRENCY_LOCALE_ATTRIBUTE
This attribute is used to specify a different locale for the
currency. | | final public static String | I18N_ATTR_ATTRIBUTE
This attribute is used with any element (even not i18n)
to translate attribute values. | | final public static String | I18N_CATALOGUE_ATTRIBUTE
This attribute can be used on i18n:text to indicate the catalogue
from which the key should be retrieved. | | final public static String | I18N_CHOOSE_ELEMENT
i18n:choose element is used to translate elements in-place.
The first i18n:when element matching the current locale
is selected and the others are discarded.
To specify what to do if no locale matched, simply add a node with
locale="*". | | final public static String | I18N_CURRENCY_ELEMENT
| | final public static String | I18N_CURRENCY_NO_UNIT_ELEMENT
| | final public static String | I18N_DATE_ELEMENT
i18n:date is used to provide a localized date string.
Allowed attributes are: pattern, src-pattern, locale,
src-locale. | | final public static String | I18N_DATE_TIME_ELEMENT
i18n:date-time is used to provide a localized date and
time string. | | final public static String | I18N_DEFAULT_CATALOGUE_ID
This configuration parameter specifies the id of the catalogue to be used as
default catalogue, allowing to redefine the default catalogue on the pipeline
level. | | final public static String | I18N_EXPR_ATTRIBUTE
This attribute is used with any element (even not i18n)
to evaluate attribute values. | | final public static String | I18N_FRACTION_DIGITS_ATTRIBUTE
| | final public static String | I18N_IF_ELEMENT
i18n:if is used to test a locale. | | final public static String | I18N_INT_CURRENCY_ELEMENT
| | final public static String | I18N_INT_CURRENCY_NO_UNIT_ELEMENT
| | final public static String | I18N_KEY_ATTRIBUTE
This attribute is used with i18n:text element to indicate the key of
the according message. | | final public static String | I18N_LOCALE
This configuration parameter specifies the default locale to be used. | | final public static String | I18N_LOCALE_ATTRIBUTE
This attribute is used with date and number formatting elements to
indicate the locale that should be used to format the element value. | | final public static String | I18N_NAMESPACE_URI
The namespace for i18n is "http://apache.org/cocoon/i18n/2.1". | | final public static String | I18N_NUMBER_ELEMENT
i18n:number is used to provide a localized number string.
Allowed attributes are: pattern, src-pattern, locale, src-locale,
type. | | final public static String | I18N_OLD_NAMESPACE_URI
The old namespace for i18n is "http://apache.org/cocoon/i18n/2.0". | | final public static String | I18N_OTHERWISE_ELEMENT
i18n:otherwise is used to match any locale when
no matching locale has been found inside an i18n:choose
block. | | final public static String | I18N_PARAM_ELEMENT
i18n:param is used with i18n:translate to provide
substitution params. | | final public static String | I18N_PARAM_NAME_ATTRIBUTE
This attribute affects a name to the param that could be used
for substitution. | | final public static String | I18N_PATTERN_ATTRIBUTE
This attribute is used with date and number formatting elements to
indicate the pattern that should be used to format the element value. | | final public static String | I18N_PERCENT_ELEMENT
| | final public static String | I18N_PRELOAD
This configuration parameter specifies locale for which catalogues should
be preloaded. | | final public static String | I18N_SRC_LOCALE_ATTRIBUTE
This attribute is used with date and number formatting elements to
indicate the locale that should be used to parse the element value. | | final public static String | I18N_SRC_PATTERN_ATTRIBUTE
This attribute is used with date and number formatting elements to
indicate the pattern that should be used to parse the element value. | | final public static String | I18N_TEXT_ELEMENT
i18n:text element is used to translate any text, with
or without markup. | | final public static String | I18N_TIME_ELEMENT
i18n:time is used to provide a localized time string.
Allowed attributes are: pattern, src-pattern, locale,
src-locale. | | final public static String | I18N_TRANSLATE_ELEMENT
i18n:translate element is used to translate text with
parameter substitution. | | final public static String | I18N_TYPE_ATTRIBUTE
This attribute is used with i18:param to
indicate the parameter type: date, time, date-time or
number, currency, percent, int-currency, currency-no-unit,
int-currency-no-unit. | | final public static String | I18N_UNTRANSLATED
This configuration parameter specifies the message that should be
displayed in case of a not translated text (message not found). | | final public static String | I18N_VALUE_ATTRIBUTE
This attribute is used with date and number formatting elements to
indicate the value that should be parsed and formatted. | | final public static String | I18N_WHEN_ELEMENT
i18n:when is used to test a locale. | | protected BundleFactory | factory
| | protected Locale | locale
| | protected ServiceManager | manager
| | protected Map | objectModel
|
| Method Summary | |
| public void | characters(char[] ch, int start, int len)
| | public void | configure(Configuration conf)
Implementation of Configurable interface. | | public void | dispose()
| | public void | endElement(String uri, String name, String raw)
| | public java.io.Serializable | getKey()
Implemenation of CacheableProcessingComponents. | | public Locale | getLocale()
Returns the current locale setting of this transformer instance. | | protected ParamSaxBuffer | getMessage(String catalogueID, String key)
Helper method to retrieve a message from the dictionary.
Parameters:
catalogueID - if not null, this catalogue will be used instead of the default one. | | public SourceValidity | getValidity()
Implementation of CacheableProcessingComponent. | | public void | recycle()
| | public void | service(ServiceManager manager)
Look up the
BundleFactory to be used. | | public void | setup(SourceResolver resolver, Map objectModel, String source, Parameters parameters)
Setup current instance of transformer. | | public void | startElement(String uri, String name, String raw, Attributes attr)
|
| CURRENCY_LOCALE_ATTRIBUTE | | final public static String CURRENCY_LOCALE_ATTRIBUTE(Code) | | This attribute is used to specify a different locale for the
currency. When specified, this locale will be combined with
the "normal" locale: e.g. the seperator symbols are taken from
the normal locale but the currency symbol and possition will
be taken from the currency locale.
This enables to see a currency formatted for Euro but with US
grouping and decimal char.
|
| I18N_ATTR_ATTRIBUTE | | final public static String I18N_ATTR_ATTRIBUTE(Code) | | This attribute is used with any element (even not i18n)
to translate attribute values. Should contain whitespace separated
attribute names that should be translated:
<para title="first" name="article" i18n:attr="title name"/>
Attribute value considered as key in message catalogue.
|
| I18N_CATALOGUE_ATTRIBUTE | | final public static String I18N_CATALOGUE_ATTRIBUTE(Code) | | This attribute can be used on i18n:text to indicate the catalogue
from which the key should be retrieved. This attribute is optional,
if it is not mentioned the default catalogue is used.
|
| I18N_CHOOSE_ELEMENT | | final public static String I18N_CHOOSE_ELEMENT(Code) | | i18n:choose element is used to translate elements in-place.
The first i18n:when element matching the current locale
is selected and the others are discarded.
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.
See Also: I18nTransformer.I18N_IF_ELEMENT
See Also: I18nTransformer.I18N_LOCALE_ATTRIBUTE
since:
2.1 |
| I18N_CURRENCY_ELEMENT | | final public static String I18N_CURRENCY_ELEMENT(Code) | | Currency element name
|
| I18N_CURRENCY_NO_UNIT_ELEMENT | | final public static String I18N_CURRENCY_NO_UNIT_ELEMENT(Code) | | Currency without unit element name
|
| I18N_DEFAULT_CATALOGUE_ID | | final public static String I18N_DEFAULT_CATALOGUE_ID(Code) | | This configuration parameter specifies the id of the catalogue to be used as
default catalogue, allowing to redefine the default catalogue on the pipeline
level.
|
| I18N_EXPR_ATTRIBUTE | | final public static String I18N_EXPR_ATTRIBUTE(Code) | | This attribute is used with any element (even not i18n)
to evaluate attribute values. Should contain whitespace separated
attribute names that should be evaluated:
<para title="first" name="{one} {two}" i18n:attr="name"/>
Attribute value considered as expression containing text and catalogue
keys in curly braces.
|
| I18N_FRACTION_DIGITS_ATTRIBUTE | | final public static String I18N_FRACTION_DIGITS_ATTRIBUTE(Code) | | fraction-digits attribute is used with
i18:number to
indicate the number of digits behind the fraction
|
| I18N_INT_CURRENCY_ELEMENT | | final public static String I18N_INT_CURRENCY_ELEMENT(Code) | | Integer currency element name
|
| I18N_INT_CURRENCY_NO_UNIT_ELEMENT | | final public static String I18N_INT_CURRENCY_NO_UNIT_ELEMENT(Code) | | Integer currency without unit element name
|
| I18N_KEY_ATTRIBUTE | | final public static String I18N_KEY_ATTRIBUTE(Code) | | This attribute is used with i18n:text element to indicate the key of
the according message. The character data of the element will be used
if no message is found by this key. E.g.:
<i18n:text i18n:key="a_key">article_text1</i18n:text>
|
| I18N_LOCALE | | final public static String I18N_LOCALE(Code) | | This configuration parameter specifies the default locale to be used.
|
| I18N_NAMESPACE_URI | | final public static String I18N_NAMESPACE_URI(Code) | | The namespace for i18n is "http://apache.org/cocoon/i18n/2.1".
|
| I18N_OLD_NAMESPACE_URI | | final public static String I18N_OLD_NAMESPACE_URI(Code) | | The old namespace for i18n is "http://apache.org/cocoon/i18n/2.0".
|
| I18N_PARAM_ELEMENT | | final public static String I18N_PARAM_ELEMENT(Code) | | i18n:param is used with i18n:translate to provide
substitution params. The param can have i18n:text as
its value to provide multilungual value. Parameters can have
additional attributes to be used for formatting:
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.
See Also: I18nTransformer.I18N_TRANSLATE_ELEMENT
See Also: I18nTransformer.I18N_DATE_ELEMENT
See Also: I18nTransformer.I18N_TIME_ELEMENT
See Also: I18nTransformer.I18N_DATE_TIME_ELEMENT
See Also: I18nTransformer.I18N_NUMBER_ELEMENT |
| I18N_PARAM_NAME_ATTRIBUTE | | final public static String I18N_PARAM_NAME_ATTRIBUTE(Code) | | This attribute affects a name to the param that could be used
for substitution.
since:
2.1 |
| I18N_PERCENT_ELEMENT | | final public static String I18N_PERCENT_ELEMENT(Code) | | Percent element name
|
| I18N_PRELOAD | | final public static String I18N_PRELOAD(Code) | | This configuration parameter specifies locale for which catalogues should
be preloaded.
|
| I18N_TEXT_ELEMENT | | final public static String I18N_TEXT_ELEMENT(Code) | | i18n:text element is used to translate any text, with
or without markup. Example:
<i18n:text>
This is <strong>translated</strong> string.
</i18n:text>
|
| I18N_TRANSLATE_ELEMENT | | final public static String I18N_TRANSLATE_ELEMENT(Code) | | i18n:translate element is used to translate text with
parameter substitution. Example:
<i18n:translate>
<i18n:text>This is translated string with {0} param</i18n:text>
<i18n:param>1</i18n:param>
</i18n:translate>
The i18n:text fragment can include markup and parameters
at any place. Also do parameters, which can include i18n:text,
i18n:date, etc. elements (without keys only).
See Also: I18nTransformer.I18N_TEXT_ELEMENT
See Also: I18nTransformer.I18N_PARAM_ELEMENT |
| I18N_TYPE_ATTRIBUTE | | final public static String I18N_TYPE_ATTRIBUTE(Code) | | This attribute is used with i18:param to
indicate the parameter type: date, time, date-time or
number, currency, percent, int-currency, currency-no-unit,
int-currency-no-unit.
Also used with i18:translate to indicate inplace
translations: inplace
|
| I18N_UNTRANSLATED | | final public static String I18N_UNTRANSLATED(Code) | | This configuration parameter specifies the message that should be
displayed in case of a not translated text (message not found).
|
| manager | | protected ServiceManager manager(Code) | | Component (service) manager
|
| configure | | public void configure(Configuration conf) throws ConfigurationException(Code) | | Implementation of Configurable interface.
Configure this transformer.
|
| dispose | | public void dispose()(Code) | | |
| getKey | | public java.io.Serializable getKey()(Code) | | Implemenation of CacheableProcessingComponents.
Generates unique key for the current locale.
|
| getLocale | | public Locale getLocale()(Code) | | Returns the current locale setting of this transformer instance.
current Locale object |
| getMessage | | protected ParamSaxBuffer getMessage(String catalogueID, String key)(Code) | | Helper method to retrieve a message from the dictionary.
Parameters:
catalogueID - if not null, this catalogue will be used instead of the default one. SaxBuffer containing message, or null if not found. |
| getValidity | | public SourceValidity getValidity()(Code) | | Implementation of CacheableProcessingComponent.
Generates validity object for this transformer or null
if this instance is not cacheable.
|
| recycle | | public void recycle()(Code) | | |
| service | | public void service(ServiceManager manager) throws ServiceException(Code) | | Look up the
BundleFactory to be used.
|
|
|