er.extensions.localization
Class ERXLocalizer

java.lang.Object
  er.extensions.localization.ERXLocalizer

All Implemented Interfaces:

NSKeyValueCoding, NSKeyValueCodingAdditions

Direct Known Subclasses:

ERXItalianLocalizer, ERXNonPluralFormLocalizer

public class ERXLocalizer
extends Object
implements NSKeyValueCoding, NSKeyValueCodingAdditions

Provides KVC access to localization. Monitors a set of files in all loaded frameworks and returns a string given a key for a language. These types of keys are acceptable in the monitored files:

   "this is a test" = "some test";
   "unittest.key.path.as.string" = "some test";
   "unittest" = {
      "key" = { 
          "path" = { 
              "as" = {
                  "dict"="some test";
               };
          };
      };
   };
 

Note that if you only call for unittest, you'll get a dictionary not a string. So you can localize more complex objects than strings.
If you set the base class of your session to ERXSession, you can then use this code in your components:

  valueForKeyPath("session.localizer.this is a test")
  valueForKeyPath("session.localizer.unittest.key.path.as.string")
  valueForKeyPath("session.localizer.unittest.key.path.as.dict")
 

For sessionless Apps, you must use another method to get at the requested language and then call the localizer via:

  ERXLocalizer l = ERXLocalizer.localizerForLanguages(languagesThisUserCanHandle) or
  ERXLocalizer l = ERXLocalizer.localizerForLanguage("German")
 

These are the defaults can be set (listed with their current defaults):

  er.extensions.ERXLocalizer.defaultLanguage=English
  er.extensions.ERXLocalizer.fileNamesToWatch=("Localizable.strings","ValidationTemplate.strings")
  er.extensions.ERXLocalizer.availableLanguages=(English,German)
  er.extensions.ERXLocalizer.frameworkSearchPath=(app,ERDirectToWeb,ERExtensions)
 

There are also methods that pluralize using normal english pluralizing rules (y->ies, x -> xes etc). You can provide your own plural strings by using a dict entry:

  localizerExceptions = {
      "Table.0" = "Table"; 
      "Table" = "Tables";
      ...
  };
 

in your Localizable.strings. Table.0 meaning no "Table", Table.1 one table and Table any other number. Note: unlike all other keys, you need to give the translated value ("Tisch" for "Table" in German) as the key, not the untranslated one. This is because this method is mainly called via d2wContext.displayNameForProperty which is already localized.

Nested Class Summary

static class

ERXLocalizer.Observer

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Field Summary

protected Hashtable	_dateFormatters
protected Hashtable	_numberFormatters
protected NSMutableDictionary	cache
protected static Logger	createdKeysLog
static String	KEY_LOCALIZER_EXCEPTIONS
protected String	language
protected Locale	locale
static String	LocalizationDidResetNotification
protected static Logger	log

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Constructor Summary

ERXLocalizer(String aLanguage)

Method Summary

protected void	addEntriesToCache(NSDictionary dict)
protected void	addToCreatedKeys(Object value, String key)
protected String	applyRules(String str, Map rules) Apply the set of rules in the given Map to the input String and return a modified string that matches the case of the input string.
static NSArray	availableLanguages()
NSDictionary	cache()
NSDictionary	createdKeys()
protected static ERXLocalizer	createLocalizerForLanguage(String language, boolean pluralForm) Creates a localizer for a given language and with an indication if the language supports plural forms.
static ERXLocalizer	currentLocalizer() Returns the current localizer for the current thread.
static String	defaultLanguage() Returns the default language (English) or the contents of the er.extensions.ERXLocalizer.defaultLanguage property.
static ERXLocalizer	defaultLocalizer() Gets the localizer for the default language.
protected Map	defaultPlurifyRules() Returns the default plurify rules for this language.
protected Map	defaultSingularifyRules() Returns the default singularify rules for this language.
void	dumpCreatedKeys()
static boolean	fallbackToDefaultLanguage()
static NSArray	fileNamesToWatch()
static NSArray<String>	frameworkSearchPath()
static void	initialize()
static boolean	isLocalizationEnabled()
String	language()
String	languageCode()
void	load()
Locale	locale()
Format	localizedDateFormatForKey(String formatString) Returns a localized date formatter for the given key.
String	localizedDisplayNameForKey(String prefix, String key) Returns a localized string for the given prefix and keyPath, inserting it "prefix.keyPath" = "Key Path"; Also tries to find "Key Path"
Format	localizedNumberFormatForKey(String formatString) Returns a localized number formatter for the given key.
String	localizedStringForKey(String key)
String	localizedStringForKeyWithDefault(String key)
String	localizedTemplateStringForKeyWithObject(String key, Object o1)
String	localizedTemplateStringForKeyWithObjectOtherObject(String key, Object o1, Object o2)
Object	localizedValueForKey(String key)
Object	localizedValueForKeyWithDefault(String key)
static ERXLocalizer	localizerForLanguage(String language)
static ERXLocalizer	localizerForLanguages(NSArray languages) Gets the best localizer for a set of languages.
static ERXLocalizer	localizerForRequest(WORequest request)
String	plurifiedString(String name, int count) Returns a plurified string
String	plurifiedStringWithTemplateForKey(String key, String name, int count, Object helper)
protected String	plurify(String str, int howMany)
protected Map	plurifyRules() Returns the plurify rules for the current language.
protected NSDictionary	readPropertyListFromFileInFramework(String fileName, String framework, NSArray languages)
static void	resetCache() Resets the localizer cache.
static void	setAvailableLanguages(NSArray value)
protected void	setCacheValueForKey(Object value, String key)
static void	setCurrentLocalizer(ERXLocalizer currentLocalizer) Sets a localizer for the current thread.
static void	setDefaultLanguage(String value) Sets the default language.
static void	setFileNamesToWatch(NSArray value)
static void	setFrameworkSearchPath(NSArray value)
static void	setIsLocalizationEnabled(boolean value)
void	setLocale(Locale value)
void	setLocalizedDateFormatForKey(NSTimestampFormatter formatter, String pattern)
void	setLocalizedNumberFormatForKey(Format formatter, String pattern)
static void	setLocalizerForLanguage(ERXLocalizer l, String language)
String	singularifiedString(String value) Returns a singularified string
protected String	singularify(String str)
protected Map	singularifyRules() Returns the singularify rules for the current language.
void	takeValueForKey(Object value, String key)
void	takeValueForKeyPath(Object value, String key)
String	toString()
static boolean	useLocalizedFormatters()
Object	valueForKey(String key) Cover method that calls localizedStringForKey.
Object	valueForKeyPath(String key)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_LOCALIZER_EXCEPTIONS

public static final String KEY_LOCALIZER_EXCEPTIONS

See Also:

Constant Field Values

log

protected static final Logger log

createdKeysLog

protected static final Logger createdKeysLog

LocalizationDidResetNotification

public static final String LocalizationDidResetNotification

See Also:

Constant Field Values

cache

protected NSMutableDictionary cache

_dateFormatters

protected Hashtable _dateFormatters

_numberFormatters

protected Hashtable _numberFormatters

language

protected String language

locale

protected Locale locale

Constructor Detail

ERXLocalizer

public ERXLocalizer(String aLanguage)

Method Detail

initialize

public static void initialize()

isLocalizationEnabled

public static boolean isLocalizationEnabled()

setIsLocalizationEnabled

public static void setIsLocalizationEnabled(boolean value)

currentLocalizer

public static ERXLocalizer currentLocalizer()

Returns the current localizer for the current thread. Note that the localizer for a given session is pushed onto the thread when a session awakes and is nulled out when a session sleeps.

Returns:

the current localizer that has been pushed into thread storage.

setCurrentLocalizer

public static void setCurrentLocalizer(ERXLocalizer currentLocalizer)

Sets a localizer for the current thread. This is accomplished by using the object ERXThreadStorage

Parameters:

currentLocalizer - to set in thread storage for the current thread.

defaultLocalizer

public static ERXLocalizer defaultLocalizer()

Gets the localizer for the default language.

Returns:

localizer for the default language.

localizerForRequest

public static ERXLocalizer localizerForRequest(WORequest request)

resetCache

public static void resetCache()

Resets the localizer cache. If WOCaching is enabled then after being reinitialize all of the localizers will be reloaded.

addToCreatedKeys

protected void addToCreatedKeys(Object value,
                                String key)

localizerForLanguages

public static ERXLocalizer localizerForLanguages(NSArray languages)

Gets the best localizer for a set of languages.

Parameters:

languages -

localizerForLanguage

public static ERXLocalizer localizerForLanguage(String language)

defaultLanguage

public static String defaultLanguage()

Returns the default language (English) or the contents of the er.extensions.ERXLocalizer.defaultLanguage property.

setDefaultLanguage

public static void setDefaultLanguage(String value)

Sets the default language.

Parameters:

value -

fileNamesToWatch

public static NSArray fileNamesToWatch()

setFileNamesToWatch

public static void setFileNamesToWatch(NSArray value)

availableLanguages

public static NSArray availableLanguages()

setAvailableLanguages

public static void setAvailableLanguages(NSArray value)

frameworkSearchPath

public static NSArray<String> frameworkSearchPath()

setFrameworkSearchPath

public static void setFrameworkSearchPath(NSArray value)

createLocalizerForLanguage

protected static ERXLocalizer createLocalizerForLanguage(String language,
                                                         boolean pluralForm)

Creates a localizer for a given language and with an indication if the language supports plural forms. To provide your own subclass of an ERXLocalizer you can set the system property er.extensions.ERXLocalizer.pluralFormClassName or er.extensions.ERXLocalizer.nonPluralFormClassName.

Parameters:

language - name to construct the localizer for

pluralForm - denotes if the language supports the plural form

Returns:

a localizer for the given language

setLocalizerForLanguage

public static void setLocalizerForLanguage(ERXLocalizer l,
                                           String language)

cache

public NSDictionary cache()

load

public void load()

plurifyRules

protected Map plurifyRules()

Returns the plurify rules for the current language. This first checks for a property of the form: er.extensions.ERXLocalizer.en.plurifyRules=(.*)person$=$1people:(.*)man$=$1men which is er.extensions.ERXLocalizer.en.plurifyRules=pattern1=replacement1:pattern2=replacement2:etc In the absence of a rule set for a particular language, the default rules are English and ported from the pluralizer in Rails.

Returns:

the plurify rules for the current language

defaultPlurifyRules

protected Map defaultPlurifyRules()

Returns the default plurify rules for this language. The default implementation is English and ported from the plurify code in Ruby on Rails. The returned Map should have regex Pattern objects as keys mapping to the replacement String to apply to that pattern.

Returns:

the default plurify rules

singularifyRules

protected Map singularifyRules()

Returns the singularify rules for the current language. This first checks for a property of the form: er.extensions.ERXLocalizer.en.singularifyRules=(.*)person$=$1people:(.*)man$=$1men which is er.extensions.ERXLocalizer.en.singularifyRules=pattern1=replacement1:pattern2=replacement2:etc In the absence of a rule set for a particular language, the default rules are English and ported from the singularizer in Rails.

Returns:

the singularify rules for the current language

defaultSingularifyRules

protected Map defaultSingularifyRules()

Returns the default singularify rules for this language. The default implementation is English and ported from the singularize code in Ruby on Rails. The returned Map should have regex Pattern objects as keys mapping to the replacement String to apply to that pattern.

Returns:

the default singularify rules

addEntriesToCache

protected void addEntriesToCache(NSDictionary dict)

readPropertyListFromFileInFramework

protected NSDictionary readPropertyListFromFileInFramework(String fileName,
                                                           String framework,
                                                           NSArray languages)

valueForKey

public Object valueForKey(String key)

Cover method that calls localizedStringForKey.

Specified by:

valueForKey in interface NSKeyValueCoding

Parameters:

key - to resolve a localized varient of

Returns:

localized string for the given key

setCacheValueForKey

protected void setCacheValueForKey(Object value,
                                   String key)

valueForKeyPath

public Object valueForKeyPath(String key)

Specified by:

valueForKeyPath in interface NSKeyValueCodingAdditions

takeValueForKey

public void takeValueForKey(Object value,
                            String key)

Specified by:

takeValueForKey in interface NSKeyValueCoding

takeValueForKeyPath

public void takeValueForKeyPath(Object value,
                                String key)

Specified by:

takeValueForKeyPath in interface NSKeyValueCodingAdditions

language

public String language()

createdKeys

public NSDictionary createdKeys()

dumpCreatedKeys

public void dumpCreatedKeys()

localizedValueForKeyWithDefault

public Object localizedValueForKeyWithDefault(String key)

localizedValueForKey

public Object localizedValueForKey(String key)

localizedStringForKeyWithDefault

public String localizedStringForKeyWithDefault(String key)

localizedStringForKey

public String localizedStringForKey(String key)

localizedDisplayNameForKey

public String localizedDisplayNameForKey(String prefix,
                                         String key)

Returns a localized string for the given prefix and keyPath, inserting it "prefix.keyPath" = "Key Path"; Also tries to find "Key Path"

Parameters:

prefix -

key -

localizedTemplateStringForKeyWithObject

public String localizedTemplateStringForKeyWithObject(String key,
                                                      Object o1)

localizedTemplateStringForKeyWithObjectOtherObject

public String localizedTemplateStringForKeyWithObjectOtherObject(String key,
                                                                 Object o1,
                                                                 Object o2)

plurify

protected String plurify(String str,
                         int howMany)

singularify

protected String singularify(String str)

applyRules

protected String applyRules(String str,
                            Map rules)

Apply the set of rules in the given Map to the input String and return a modified string that matches the case of the input string. For instance, if the input string is "Person" and the rules are _plurifyRules, then this would return "People".

Parameters:

str - the input string

rules - the rules to apply

Returns:

a case-matched string converted according to the rules

plurifiedStringWithTemplateForKey

public String plurifiedStringWithTemplateForKey(String key,
                                                String name,
                                                int count,
                                                Object helper)

plurifiedString

public String plurifiedString(String name,
                              int count)

Returns a plurified string

Parameters:

name -

count -

singularifiedString

public String singularifiedString(String value)

Returns a singularified string

Parameters:

value - the value to singularify

Returns:

a singularified string

toString

public String toString()

Overrides:

toString in class Object

localizedDateFormatForKey

public Format localizedDateFormatForKey(String formatString)

Returns a localized date formatter for the given key.

Parameters:

formatString -

localizedNumberFormatForKey

public Format localizedNumberFormatForKey(String formatString)

Returns a localized number formatter for the given key. Also, can localize units to, just define in your Localizable.strings a suitable key, with the appropriate pattern.

Parameters:

formatString -

Returns:

the formatter object

setLocalizedNumberFormatForKey

public void setLocalizedNumberFormatForKey(Format formatter,
                                           String pattern)

Parameters:

formatter -

pattern -

locale

public Locale locale()

setLocale

public void setLocale(Locale value)

setLocalizedDateFormatForKey

public void setLocalizedDateFormatForKey(NSTimestampFormatter formatter,
                                         String pattern)

Parameters:

formatter -

pattern -

useLocalizedFormatters

public static boolean useLocalizedFormatters()

languageCode

public String languageCode()

fallbackToDefaultLanguage

public static boolean fallbackToDefaultLanguage()