Package org.cyclos.impl.contentmanagement

Class CyclosResourceBundle

java.lang.Object

java.util.ResourceBundle

org.cyclos.impl.contentmanagement.CyclosResourceBundle

public class CyclosResourceBundle
extends ResourceBundle

A ResourceBundle which is actually a wrapper for other resource bundles, one per module. It also allows setting customized keys, which have precedence over the built-in keys. The full keys are composed by MODULE.SUBMODULE.key. The MODULE part is used to lookup an internal resource bundle, and the SUBMODULE.key is what is actually expected to be on the translation files.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.ResourceBundle

ResourceBundle.Control

Constructor Summary

Constructors

Constructor	Description
CyclosResourceBundle(CyclosResourceBundle parent, long languageId, BuiltinLanguage template, TranslationHandler translationHandler)

Method Summary

Modifier and Type	Method	Description
void	addResourceBundle(Module mod, ResourceBundle rb)	Registers the internal ResourceBundle for the given module
protected String	doGetString(String key, boolean allowInvalid)
String	get(MessageKey key)	Returns a translation by MessageKey
Map<String,String>	getBySubmodule(Set<Submodule> submodules, boolean onlyCustomized)	Returns all keys / values in the given submodules
Map<String,CustomizedTranslation>	getCustomizedKeys()	Returns all customized keys with their values
CustomizedTranslation	getCustomizedTranslation(String key)
String	getEvenIfInvalid(String key)	Return a custom translation even if it's invalid.
Map<String,String>	getI18n()	Returns new frontend keys, including the customized ones
Enumeration<String>	getKeys()
long	getLanguageId()
String	getOriginal(MessageKey key)	Returns the original value for the given key
String	getOriginalValue(String key)	Returns the original value for the given key
CyclosResourceBundle	getParent()
BuiltinLanguage	getTemplate()
protected Object	handleGetObject(String key)
String	message(String key, MessageFormat messageFormat, Object... arguments)	Resolves a translation message
Page<TranslationKeyVO>	search(TranslationQuery params)

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, handleKeySet, keySet, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

CyclosResourceBundle

public CyclosResourceBundle(CyclosResourceBundle parent,
                            long languageId,
                            BuiltinLanguage template,
                            TranslationHandler translationHandler)

Method Detail

addResourceBundle

public void addResourceBundle(Module mod,
                              ResourceBundle rb)

Registers the internal ResourceBundle for the given module

get

public String get(MessageKey key)

Returns a translation by MessageKey

getBySubmodule

public Map<String,String> getBySubmodule(Set<Submodule> submodules,
                                               boolean onlyCustomized)

Returns all keys / values in the given submodules

getCustomizedKeys

public Map<String,CustomizedTranslation> getCustomizedKeys()

Returns all customized keys with their values

getCustomizedTranslation

public CustomizedTranslation getCustomizedTranslation(String key)

getEvenIfInvalid

public String getEvenIfInvalid(String key)

Return a custom translation even if it's invalid.

getI18n

public Map<String,String> getI18n()

Returns new frontend keys, including the customized ones

getKeys

public Enumeration<String> getKeys()

Specified by:

getKeys in class ResourceBundle

getLanguageId

public long getLanguageId()

getOriginal

public String getOriginal(MessageKey key)

Returns the original value for the given key

getOriginalValue

public String getOriginalValue(String key)

Returns the original value for the given key

getParent

public CyclosResourceBundle getParent()

getTemplate

public BuiltinLanguage getTemplate()

message

public String message(String key,
                      MessageFormat messageFormat,
                      Object... arguments)

Resolves a translation message

search

public Page<TranslationKeyVO> search(TranslationQuery params)

doGetString

protected String doGetString(String key,
                             boolean allowInvalid)

handleGetObject

protected Object handleGetObject(String key)

Specified by:

handleGetObject in class ResourceBundle