BBTranslator

Class BBTranslationBundle

java.lang.Object

BBTranslator.BBTranslationBundle

public class BBTranslationBundle
extends Object

The BBTranslationBundle class is a BBj CustomObject used to get and add translations with backend Java properties files for localization support.

Field Summary

Fields

Modifier and Type	Field and Description
static BBjNumber	DIR_ERROR
static BBjNumber	NAME_ERROR
static BBjNumber	NumConsolePrints
static BBjNumber	REMOVE_LOCALE_ERROR
static BBjNumber	SAVE_ERROR

Method Summary

Modifier and Type	Method and Description
void	addLocale(Locale p_locale!)
void	addTranslation(BBjString p_key$, HashMap p_values!)
void	addTranslation(BBjString p_key$, HashMap p_values!, BBjNumber p_skip_existing)
void	addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$)
void	addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$, BBjNumber p_skip_existing)
void	clearCache()
static void	createParentDirs(BBjString p_fileName!)
static BBTranslationBundle	getBundle(BBjString p_name!)
static BBTranslationBundle	getBundle(BBjString p_name!, BBjString p_directory!)
static BBTranslationBundle	getBundle(BBjString p_name!, BBjString p_directory!, Locale p_localeOfOrigin!)
static BBTranslationBundle	getBundleFromJar(BBjString p_name!, BBjString p_jarFileName!, Locale p_localeOfOrigin!)
static BBTranslationBundle	getBundleFromZip(BBjString p_name!, BBjString p_zipFileName!, Locale p_localeOfOrigin!)
static BBjString	getBundleLockUser(BBjString p_name!, BBjString p_directory!)
static Locale	getClientLocale()
static BBjString	getClientLocaleString()
BBTranslations	getDefaultTranslations()
BBjString	getDirectory()
Locale	getLocaleOfOrigin()
BBjVector	getLocales()
BBjString	getName()
BBjString	getTranslation(Locale p_locale!, BBjString p_key$)
BBjString	getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!)
BBjString	getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound)
BBjString	getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd)
BBjString	getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd, BBjNumber p_skipParentLocale)
BBTranslations	getTranslations(Locale p_locale!)
static BBjNumber	obtainBundleLock(BBjString p_name!, BBjString p_directory!)
static void	print(BBjNumber p_printChan, BBjString p_text$)
static void	print(BBjNumber p_printChan, BBjString p_text!, BBjNumber p_wrapText, BBjNumber p_pauseConsole)
static BBjNumber	releaseBundleLock(BBjString p_name!, BBjString p_directory!)
void	removeLocale(Locale p_locale!)
void	removeTranslation(Locale p_locale!, BBjString p_key$)
void	save()
void	save(BBjString p_directory!)
void	save(BBjString p_directory!, BBjString p_bundleName!)
void	save(BBjString p_directory!, BBjString p_bundleName!, BBjNumber p_forceSave)
void	saveTranslationsToJar(BBjString p_jarFileName$)
void	saveTranslationsToZip(BBjString p_zipFileName$)
void	setTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$)
static void	validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!)
static void	validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!)
static void	validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!, BBjNumber p_removeInvalidTranslations)
static void	writePropertiesFile(BBjString p_propertiesFileName$, SortedProperties p_properties!)

Methods inherited from class java.lang.Object

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

Field Detail

NumConsolePrints

public static BBjNumber NumConsolePrints

NAME_ERROR

public static BBjNumber NAME_ERROR

REMOVE_LOCALE_ERROR

public static BBjNumber REMOVE_LOCALE_ERROR

DIR_ERROR

public static BBjNumber DIR_ERROR

SAVE_ERROR

public static BBjNumber SAVE_ERROR

Method Detail

getBundle

public static BBTranslationBundle getBundle(BBjString p_name!)

getBundle

public static BBTranslationBundle getBundle(BBjString p_name!,
BBjString p_directory!)

getBundle

public static BBTranslationBundle getBundle(BBjString p_name!,
BBjString p_directory!,
Locale p_localeOfOrigin!)

createParentDirs

public static void createParentDirs(BBjString p_fileName!)

getBundleFromJar

public static BBTranslationBundle getBundleFromJar(BBjString p_name!,
BBjString p_jarFileName!,
Locale p_localeOfOrigin!)

getBundleFromZip

public static BBTranslationBundle getBundleFromZip(BBjString p_name!,
BBjString p_zipFileName!,
Locale p_localeOfOrigin!)

obtainBundleLock

public static BBjNumber obtainBundleLock(BBjString p_name!,
BBjString p_directory!)

getBundleLockUser

public static BBjString getBundleLockUser(BBjString p_name!,
BBjString p_directory!)

releaseBundleLock

public static BBjNumber releaseBundleLock(BBjString p_name!,
BBjString p_directory!)

getTranslations

public BBTranslations getTranslations(Locale p_locale!)

addLocale

public void addLocale(Locale p_locale!)

removeLocale

public void removeLocale(Locale p_locale!)

addTranslation

public void addTranslation(BBjString p_key$,
HashMap p_values!)

addTranslation

public void addTranslation(BBjString p_key$,
HashMap p_values!,
BBjNumber p_skip_existing)

addTranslation

public void addTranslation(Locale p_locale!,
BBjString p_key$,
BBjString p_value$)

addTranslation

public void addTranslation(Locale p_locale!,
BBjString p_key$,
BBjString p_value$,
BBjNumber p_skip_existing)

setTranslation

public void setTranslation(Locale p_locale!,
BBjString p_key$,
BBjString p_value$)

removeTranslation

public void removeTranslation(Locale p_locale!,
BBjString p_key$)

getTranslation

public BBjString getTranslation(Locale p_locale!,
BBjString p_key$)

getTranslation

public BBjString getTranslation(Locale p_locale!,
BBjString p_key$,
BBjString p_defaultValue!)

getTranslation

public BBjString getTranslation(Locale p_locale!,
BBjString p_key$,
BBjString p_defaultValue!,
BBjNumber p_addIfNotFound)

getTranslation

public BBjString getTranslation(Locale p_locale!,
BBjString p_key$,
BBjString p_defaultValue!,
BBjNumber p_addIfNotFound,
BBjNumber p_forceAdd)

getTranslation

public BBjString getTranslation(Locale p_locale!,
BBjString p_key$,
BBjString p_defaultValue!,
BBjNumber p_addIfNotFound,
BBjNumber p_forceAdd,
BBjNumber p_skipParentLocale)

getName

public BBjString getName()

getDirectory

public BBjString getDirectory()

getLocaleOfOrigin

public Locale getLocaleOfOrigin()

getLocales

public BBjVector getLocales()

getDefaultTranslations

public BBTranslations getDefaultTranslations()

save

public void save()

save

public void save(BBjString p_directory!)

save

public void save(BBjString p_directory!,
BBjString p_bundleName!)

save

public void save(BBjString p_directory!,
BBjString p_bundleName!,
BBjNumber p_forceSave)

saveTranslationsToJar

public void saveTranslationsToJar(BBjString p_jarFileName$)

saveTranslationsToZip

public void saveTranslationsToZip(BBjString p_zipFileName$)

clearCache

public void clearCache()

getClientLocale

public static Locale getClientLocale()

getClientLocaleString

public static BBjString getClientLocaleString()

writePropertiesFile

public static void writePropertiesFile(BBjString p_propertiesFileName$,
SortedProperties p_properties!)

validateBundle

public static void validateBundle(BBjString p_bundleName$,
BBjString p_bundleDir!)

validateBundle

public static void validateBundle(BBjString p_bundleName$,
BBjString p_bundleDir!,
BBjString p_validationReportFileName!)

validateBundle

public static void validateBundle(BBjString p_bundleName$,
BBjString p_bundleDir!,
BBjString p_validationReportFileName!,
BBjNumber p_removeInvalidTranslations)

print

public static void print(BBjNumber p_printChan,
BBjString p_text$)

print

public static void print(BBjNumber p_printChan,
BBjString p_text!,
BBjNumber p_wrapText,
BBjNumber p_pauseConsole)