org.springframework.extensions.surf

Class I18nDependencyHandler

java.lang.Object

org.springframework.extensions.surf.I18nDependencyHandler

All Implemented Interfaces:

CacheReporter

public class I18nDependencyHandler
extends Object
implements CacheReporter

Constructor Summary

Constructors

Constructor and Description
I18nDependencyHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	cacheBundle(String path, Locale locale, Map<String,Object> s) Add a new generated JSON string for a specific locale for a specific path
void	clearCaches() Clears the cache.
String	generateI18nJavaScript(Map<String,DojoDependencies> dependencyMap) This method generates a JavaScript string from the Map of supplied DojoDependencies.
Map<String,Map<String,Object>>	generateScopeToBundleMap(Map<String,DojoDependencies> dependencyMap) This method works through the supplied map of DojoDependencies and generated a map of each requested scope to a map of properties generated from all ResourceBundle instances that have been assigned to that scope.
protected ResourceBundle	getBundle(String path)
Map<String,Object>	getCachedBundle(String path, Locale locale) Checks the cache for previously generated JSON strings.
DependencyHandler	getDependencyHandler()
Map<String,Object>	getLocaleMergedBundle(String path) This method generates a Map of NLS properties comprised of all the available ResourceBundle instances retrieved from the supplied path.
WebFrameworkConfigElement	getWebFrameworkConfigElement()
protected void	mergeBundle(Map<String,Object> mergedBundles, ResourceBundle bundleToMerge)
List<CacheReport>	report()
void	setDependencyHandler(DependencyHandler dependencyHandler)
void	setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)

Methods inherited from class java.lang.Object

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

Constructor Detail

I18nDependencyHandler

public I18nDependencyHandler()

Method Detail

generateI18nJavaScript

public String generateI18nJavaScript(Map<String,DojoDependencies> dependencyMap)

This method generates a JavaScript string from the Map of supplied DojoDependencies. The String generated will be able to add all the message properties referenced from the dependencies into global message objects that can then be accessed by widgets.

Parameters:

dependencyMap - Map

Returns:

String

generateScopeToBundleMap

public Map<String,Map<String,Object>> generateScopeToBundleMap(Map<String,DojoDependencies> dependencyMap)

This method works through the supplied map of DojoDependencies and generated a map of each requested scope to a map of properties generated from all ResourceBundle instances that have been assigned to that scope.

Parameters:

dependencyMap - Map

Returns:

Map

getLocaleMergedBundle

public Map<String,Object> getLocaleMergedBundle(String path)

This method generates a Map of NLS properties comprised of all the available ResourceBundle instances retrieved from the supplied path. The path supplied is assumed to be that of the default Locale and the current Locale is then used to derive paths specific to language, country and variant. A ResourceBundle is generated from each path and the contents of each ResourceBundle is merged into the Map that is returned.

Parameters:

path - String

Returns:

Map

getBundle

protected ResourceBundle getBundle(String path)

Parameters:

path - String

Returns:

ResourceBundle

mergeBundle

protected void mergeBundle(Map<String,Object> mergedBundles,
               ResourceBundle bundleToMerge)

Parameters:

mergedBundles - Map

bundleToMerge - ResourceBundle

getCachedBundle

public Map<String,Object> getCachedBundle(String path,
                                 Locale locale)

Checks the cache for previously generated JSON strings.

Parameters:

path - The path to check the cache for

locale - The locale required.

Returns:

Map

cacheBundle

public void cacheBundle(String path,
               Locale locale,
               Map<String,Object> s)

Add a new generated JSON string for a specific locale for a specific path

Parameters:

path - String

locale - Locale

s - Map

clearCaches

public void clearCaches()

Clears the cache.

Specified by:

clearCaches in interface CacheReporter

report

public List<CacheReport> report()

Specified by:

report in interface CacheReporter

getDependencyHandler

public DependencyHandler getDependencyHandler()

setDependencyHandler

public void setDependencyHandler(DependencyHandler dependencyHandler)

getWebFrameworkConfigElement

public WebFrameworkConfigElement getWebFrameworkConfigElement()

setWebFrameworkConfigElement

public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)