Package org.ametys.core.util

Class I18nUtils

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.core.util.I18nUtils

All Implemented Interfaces:

Disposable, Initializable, Component, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

I18nUtils

public class I18nUtils
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable, Initializable, Disposable

Utils for i18n

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	I18nUtils.Location	Class representing an i18n location

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected Map<String,I18nUtils.Location>	_locations	I18n catalogues
protected SourceResolver	_resolver	Source Resolver
static String	I18N_CACHE	i18n cache id
static String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
I18nUtils()

Method Summary

Modifier and Type	Method	Description
protected void	_configure()	Configure the i18n catalogue
protected void	_createCache()	Create the i18n cache
protected Cache<org.ametys.core.util.I18nUtils.I18nKey,String>	_getI18NCache()	get the i18n cache (link language and I18nizable text to a translated value)
protected String	_translate(I18nizableText text, String language, boolean rawValue)	Get the translation of the key.
void	clearCache()	Clear the i18n cache.
void	contextualize(Context context)
void	dispose()
static I18nUtils	getInstance()	Get the unique instance
List<String>	getParamsFoldersWithI18n()	Get the name of folders into WEB-INF/param which contains i18n catalogues
void	initialize()
void	reloadCatalogues()	Reload the i18n catalogues and clear cache.
void	service(ServiceManager manager)
String	translate(I18nizable text)	Get the translation of the key.
String	translate(I18nizable text, String language)	Get the translation of the key.
String	translate(I18nizable i18nizable, String language, boolean rawValue)	Get the translation of the key.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE

public static final String ROLE

The avalon role

I18N_CACHE

public static final String I18N_CACHE

i18n cache id

_locations

protected Map<String,I18nUtils.Location> _locations

I18n catalogues

_context

protected Context _context

The avalon context

_resolver

protected SourceResolver _resolver

Source Resolver

Constructor Detail

I18nUtils

public I18nUtils()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

_createCache

protected void _createCache()

Create the i18n cache

_configure

protected void _configure()

Configure the i18n catalogue

getParamsFoldersWithI18n

public List<String> getParamsFoldersWithI18n()

Get the name of folders into WEB-INF/param which contains i18n catalogues

Returns:

the name of folders into WEB-INF/param which contains i18n catalogues

reloadCatalogues

public void reloadCatalogues()

Reload the i18n catalogues and clear cache. This method should be called as soon as the list of i18n catalogue was changed, when adding a new catalogue for example.

getInstance

public static I18nUtils getInstance()

Get the unique instance

Returns:

the unique instance

translate

public String translate(I18nizable text)

Get the translation of the key.

Parameters:

text - The i18n key to translate

Returns:

The translation or null if there's no available translation

Throws:

IllegalStateException - if an error occured

translate

public String translate(I18nizable text,
                        String language)
                 throws IllegalStateException

Get the translation of the key.

Parameters:

text - The i18n key to translate

language - The language code to use for translation. Can be null.

Returns:

The translation or null if there's no available translation

Throws:

IllegalStateException - if an error occurred

translate

public String translate(I18nizable i18nizable,
                        String language,
                        boolean rawValue)
                 throws IllegalStateException

Get the translation of the key.

Parameters:

i18nizable - The I18nizable to translate

language - The language code to use for translation. Can be null.

rawValue - Set true to get the value corresponding strictly to the specified Locale, without escalading to parent Locale if not found. Note that there is no cache for strict values.

Returns:

The translation or null if there's no available translation

Throws:

IllegalStateException - if an error occurred

clearCache

public void clearCache()

Clear the i18n cache.

_translate

protected String _translate(I18nizableText text,
                            String language,
                            boolean rawValue)
                     throws IllegalStateException

Get the translation of the key. Only use in very specific cases (send mail for example)

Parameters:

text - The i18n key to translate

language - The language code to use for translation. Can be null.

rawValue - Set true to get the value corresponding strictly to the specified Locale, without escalading to parent Locale if not found

Returns:

The translation or null if there's no available translation

Throws:

IllegalStateException - if an error occured

dispose

public void dispose()

Specified by:

dispose in interface Disposable

_getI18NCache

protected Cache<org.ametys.core.util.I18nUtils.I18nKey,String> _getI18NCache()

get the i18n cache (link language and I18nizable text to a translated value)

Returns:

the i18n cache