com.goldencode.p2j.util

Class TranslationManager

java.lang.Object

com.goldencode.p2j.util.TranslationManager

public class TranslationManager
extends java.lang.Object

Implements internationalization tasks, i.e. language bundle resolution, keeping track of current language and the message translation itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TranslationManager.BundleControl Custom bundle control to override the bundle name logic.

Field Summary

Fields

Modifier and Type	Field and Description
private TranslationManager.BundleControl	bundleControl Custom bundle control
private java.util.List<java.lang.String>	currentLanguages Currently set current languages
private double	expansionRatio String expansion ratio
private static int[]	expansionTable Expansion table: Even indexes contain the minimum number of chars for the expansion value to take effect.
private static ContextLocal<TranslationManager>	instance Context local data
private static CentralLogger	LOG Logger
private java.util.concurrent.atomic.AtomicLong	nextReferentId Next referent id
static java.lang.String	REFERENT_ID_FIELD_NAME Synthetic field names generated in the converted java classes for business logic, frames and legacy classes.
private java.util.Map<java.lang.Long,java.util.ResourceBundle>	referentBundleMap Map of referent ids to resource budles
private java.util.Map<java.lang.Class<?>,java.lang.Long>	referentIdMap Map of referent classes and their corresponding referent ids
private java.util.Map<java.lang.Long,java.lang.Class<?>>	referentMap Map of referent ids and their referent classes
static java.lang.String	TR_MANAGER_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
TranslationManager() Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	applyLanguage(java.lang.Class<?> referentClass) Resolves a resource bundle based on the current languages set with setCurrentLanguages(String) and associates it with the supplied referent class.
void	applyLanguage(long referentId) Resolves a resource bundle based on the current languages set with setCurrentLanguages(String) and associates it with the supplied referent.
static java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>>	getBundles(java.lang.String bundleBaseName, java.util.List<java.lang.String> languages) Returns the iterator over the collection of i18n resources for the given bundle base name and the given list of language identifiers.
static java.lang.String	getDefaultLanguage() Get the JVM default language in the form of language code + _ + country code, for example, en_US.
static int	getExpandedLength(java.lang.String str, double expansionRatio) Calculates the expanded length of the supplied char.
static java.lang.String	getIdentifier(java.lang.String str) Converts the supplied string to a valid Java identifier by skipping the unsupported chars from the result.
static TranslationManager	getInstance() Returns the context local instance.
long	initReferent(java.lang.Class<?> referentClass) Initializes supplied class (aka referent class) for the purpose of i18n.
static java.util.List<java.lang.String>	parseLanguages(java.lang.String languages, boolean computeDefaultLanguage) Converts the given string of comma separated list of language identifiers to the list of language identifiers.
private java.util.ResourceBundle	resolveBundle(java.lang.Class<?> referentClass) Resolves resource bundle for the supplied reference.
void	setCurrentLanguages(java.lang.String languages) Sets the current languages.
java.lang.String	translate(long referentId, long ctxt, java.lang.String msg) Translates the supplied message to the current target language.
java.lang.String	translate(long referentId, java.lang.String msg) Translates the supplied message to the current target language.
I18nString	translateExpand(long referentId, long ctxt, java.lang.String msg) Translates the supplied string for the supplied referent and calculates the expansion length (see getExpandedLength(String, double) for more details).
I18nString	translateExpand(long referentId, java.lang.String msg) Translates the supplied string for the supplied referent and calculates the expansion length (see getExpandedLength(String, double) for more details).

Methods inherited from class java.lang.Object

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

Field Detail

REFERENT_ID_FIELD_NAME

public static final java.lang.String REFERENT_ID_FIELD_NAME

Synthetic field names generated in the converted java classes for business logic, frames and legacy classes.

See Also:

Constant Field Values

TR_MANAGER_FIELD_NAME

public static final java.lang.String TR_MANAGER_FIELD_NAME

See Also:

Constant Field Values

LOG

private static CentralLogger LOG

Logger

instance

private static final ContextLocal<TranslationManager> instance

Context local data

expansionTable

private static int[] expansionTable

Expansion table: Even indexes contain the minimum number of chars for the expansion value to take effect. These entries must be sorted. Odd indexes contain the expansion values. The value is a percentage value the target string will be expanded to.

nextReferentId

private final java.util.concurrent.atomic.AtomicLong nextReferentId

Next referent id

referentBundleMap

private final java.util.Map<java.lang.Long,java.util.ResourceBundle> referentBundleMap

Map of referent ids to resource budles

referentMap

private final java.util.Map<java.lang.Long,java.lang.Class<?>> referentMap

Map of referent ids and their referent classes

referentIdMap

private final java.util.Map<java.lang.Class<?>,java.lang.Long> referentIdMap

Map of referent classes and their corresponding referent ids

currentLanguages

private volatile java.util.List<java.lang.String> currentLanguages

Currently set current languages

bundleControl

private TranslationManager.BundleControl bundleControl

Custom bundle control

expansionRatio

private double expansionRatio

String expansion ratio

Constructor Detail

TranslationManager

public TranslationManager()

Default constructor.

Method Detail

getInstance

public static TranslationManager getInstance()

Returns the context local instance.

Returns:

See above.

getIdentifier

public static java.lang.String getIdentifier(java.lang.String str)

Converts the supplied string to a valid Java identifier by skipping the unsupported chars from the result.

Parameters:

str - The input string.

Returns:

Valid Java identifier.

getExpandedLength

public static int getExpandedLength(java.lang.String str,
                                    double expansionRatio)

Calculates the expanded length of the supplied char. The expansion is calculated from the supplied expansionRatio and the expansion table expansionTable. The length is calculates as follows: str.length + round(((expansionTableEntry * expansionRatio) / 100.0) * len).

Parameters:

str - The string to be expanded.

expansionRatio - The expansion ratio, must be 0 or greater.

Returns:

The calculated expanded length. If the supplied str is null or empty, or expansionRatio is less than 0, the returned value is 0.

parseLanguages

public static java.util.List<java.lang.String> parseLanguages(java.lang.String languages,
                                                              boolean computeDefaultLanguage)

Converts the given string of comma separated list of language identifiers to the list of language identifiers.

Parameters:

languages - The given string of comma separated list of language identifiers

computeDefaultLanguage - True value indicates that the default language is computed if languages value is given as "?".

Returns:

The list of language identifiers

getDefaultLanguage

public static java.lang.String getDefaultLanguage()

Get the JVM default language in the form of language code + _ + country code, for example, en_US.

Returns:

The language identifier

getBundles

public static java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> getBundles(java.lang.String bundleBaseName,
                                                                                                    java.util.List<java.lang.String> languages)

Returns the iterator over the collection of i18n resources for the given bundle base name and the given list of language identifiers.

Parameters:

bundleBaseName - The given bundle base name

languages - The given list of language identifier

Returns:

The target iterator over the collection of i18n resources

initReferent

public long initReferent(java.lang.Class<?> referentClass)

Initializes supplied class (aka referent class) for the purpose of i18n. The method returns a unique identifier associated with the supplied referent class. Any further i18n requests must contain this unique id. By convention a referent class has associated set of resource bundles, one for each target language. The resource bundles reside in the same Java package as the referent class, whereas the resource bundle class name is in the form [referent class simple name]_[target language]. The current target language is determined by the assigned value to CURRENT-LANGUAGE@ session variable.

Parameters:

referentClass - The referent class.

Returns:

Unique id of to the initialized referent class. Any further i18n requests must contain this id.

translate

public java.lang.String translate(long referentId,
                                  java.lang.String msg)

Translates the supplied message to the current target language. If no current language is set or no bundle of the target language can be resolved or the resolved bundle doesn't contain translation for the supplied message, the method just returns the supplied message.

Parameters:

referentId - Referent class id returned by initReferent(Class).

msg - A message to translate.

Returns:

Translated message or msg if the message can't be translated.

translate

public java.lang.String translate(long referentId,
                                  long ctxt,
                                  java.lang.String msg)

Translates the supplied message to the current target language. If no current language is set or no bundle of the target language can be resolved or the resolved bundle doesn't contain translation for the supplied message, the method just returns the supplied message.

Parameters:

referentId - Referent class id returned by initReferent(Class).

ctxt - A context identifier. It is used to disambiguate messages of the same value but appearing in different locations in the source.

msg - A message to translate.

Returns:

Translated message or msg if the message can't be translated.

translateExpand

public I18nString translateExpand(long referentId,
                                  java.lang.String msg)

Translates the supplied string for the supplied referent and calculates the expansion length (see getExpandedLength(String, double) for more details).

Parameters:

referentId - Id of the referent.

msg - The string to be translated.

Returns:

The translates string with the calculated expansion length.

translateExpand

public I18nString translateExpand(long referentId,
                                  long ctxt,
                                  java.lang.String msg)

Translates the supplied string for the supplied referent and calculates the expansion length (see getExpandedLength(String, double) for more details).

Parameters:

referentId - Id of the referent.

ctxt - Context id.

msg - The string to be translated.

Returns:

The translates string with the calculated expansion length.

setCurrentLanguages

public void setCurrentLanguages(java.lang.String languages)

Sets the current languages. The supplied value may be null a comma separated string. When null the effective current language will be cleared and messages will not be translated. When multiple languages are given, they are used during language bundle resolution such that the current languages are iterated until a corresponding resource bundle is found.

Parameters:

languages - List of languages to assign as current languages. The value is a comma separated string.

applyLanguage

public void applyLanguage(long referentId)

Resolves a resource bundle based on the current languages set with setCurrentLanguages(String) and associates it with the supplied referent. Any further translation requests for the referent will be performed against the resolved resource bundle.

Parameters:

referentId - The referent id.

applyLanguage

public boolean applyLanguage(java.lang.Class<?> referentClass)

Resolves a resource bundle based on the current languages set with setCurrentLanguages(String) and associates it with the supplied referent class. Any further translation requests for the referent class will be performed against the resolved resource bundle.

Parameters:

referentClass - The referent class.

Returns:

true if the language was successfully applied to the referent, false otherwise.

resolveBundle

private java.util.ResourceBundle resolveBundle(java.lang.Class<?> referentClass)

Resolves resource bundle for the supplied reference.

Parameters:

referentClass - The referent class.

Returns:

The resolved resource bundle.