org.apache.wicket.resource.loader

Class ComponentStringResourceLoader

java.lang.Object

org.apache.wicket.resource.loader.ComponentStringResourceLoader

All Implemented Interfaces:

IStringResourceLoader

Direct Known Subclasses:

ClassStringResourceLoader, InitializerStringResourceLoader, PackageStringResourceLoader, ValidatorStringResourceLoader

public class ComponentStringResourceLoader
extends Object
implements IStringResourceLoader

This is one of Wicket's default string resource loaders.

The component based string resource loader attempts to find the resource from a bundle that corresponds to the supplied component object or one of its parent containers.

The search order for resources is built around the containers that hold the component (if it is not a page). Consider a Page that contains a Panel that contains a Label. If we pass the Label as the component then resource loading will first look for the resource against the page, then against the panel and finally against the label.

The above search order may seem slightly odd at first, but can be explained thus: Team A writes a new component X and packages it as a reusable Wicket component along with all required resources. Team B then creates a new container component Y that holds a instance of an X. However, Team B wishes the text to be different to that which was provided with X so rather than needing to change X, they include override values in the resources for Y. Finally, Team C makes use of component Y in a page they are writing. Initially they are happy with the text for Y so they do not include any override values in the resources for the page. However, after demonstrating to the customer, the customer requests the text for Y to be different. Team C need only provide override values against their page and thus do not need to change Y.

This implementation is fully aware of both locale and style values when trying to obtain the appropriate resources.

In addition to the above search order, each key will be pre-pended with the relative path of the current component related to the component that is being searched. E.g. assume a component hierarchy like page1.form1.input1 and your are requesting a key named 'Required'. Wicket will search the property in the following order:

        page1.properties => form1.input1.Required
        page1.properties => Required
        form1.properties => input1.Required
        form1.properties => Required
        input1.properties => Required
        myApplication.properties => form1.input1.Required
        myApplication.properties => Required
 

Note that the latter two property files are only checked if the ClassStringResourceLoader has been registered with Application as well, which is the default.

In addition to the above search order, each component that is being searched for a resource also includes the resources from any parent classes that it inherits from. For example, PageA extends CommonBasePage which in turn extends WebPage When a resource lookup is requested on PageA, the resource bundle for PageA is first checked. If the resource is not found in this bundle then the resource bundle for CommonBasePage is checked. This allows designers of base pages and components to define default sets of string resources and then developers implementing subclasses to either override or extend these in their own resource bundle.

This implementation can be subclassed to implement modified behavior. The new implementation must be registered with the Application (ResourceSettings) though.

You may enable log debug messages for this class to fully understand the search order.

Author:

Chris Turner, Juergen Donnerstag

Constructor Summary

Constructors

Constructor and Description
ComponentStringResourceLoader() Create and initialize the resource loader.

Method Summary

Modifier and Type	Method and Description
protected IPropertiesFactory	getPropertiesFactory() Get the properties file factory which loads the properties based on locale and style from *.properties and *.xml files
protected String	getResourcePath(Component component) get path for resource lookup
protected boolean	isStopResourceSearch(Class<?> clazz) Check the supplied class to see if it is one that we shouldn't bother further searches up the class hierarchy for properties.
protected boolean	isStopResourceSearch(Component component) Check the supplied component to see if it is one that we shouldn't bother further searches up the component hierarchy for properties.
String	loadStringResource(Class<?> clazz, String key, Locale locale, String style, String variation) Get the string resource for the given combination of component class, resource key, locale and style.
String	loadStringResource(Component component, String key, Locale locale, String style, String variation) Get the string resource for the given combination of component, resource key, locale and style.
protected IResourceNameIterator	newResourceNameIterator(String path, Locale locale, String style, String variation)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentStringResourceLoader

public ComponentStringResourceLoader()

Create and initialize the resource loader.

Method Detail

loadStringResource

public String loadStringResource(Class<?> clazz,
                                 String key,
                                 Locale locale,
                                 String style,
                                 String variation)

Description copied from interface: IStringResourceLoader

Get the string resource for the given combination of component class, resource key, locale and style. The component class provided is used to allow implementation of component specific resource loading (e.g. per page or per reusable component). The key should be a String containing a lookup key into a resource bundle. The locale should contain the locale of the current operation so that the appropriate set of resources can be selected. The style allows the set of resources to select to be varied by skin/brand.

Specified by:

loadStringResource in interface IStringResourceLoader

Parameters:

clazz - The class to get the string resource for

key - The key should be a String containing a lookup key into a resource bundle

locale - The locale should contain the locale of the current operation so that the appropriate set of resources can be selected

style - The style identifying the resource set to select the strings from (see Session)

variation - The components variation (of the style)

Returns:

The string resource value or null if the resource could not be loaded by this loader

newResourceNameIterator

protected IResourceNameIterator newResourceNameIterator(String path,
                                                        Locale locale,
                                                        String style,
                                                        String variation)

Parameters:

path -

locale -

style -

variation -

Returns:

resource name iterator

See Also:

IResourceStreamLocator.newResourceNameIterator(String, Locale, String, String, String, boolean)

getPropertiesFactory

protected IPropertiesFactory getPropertiesFactory()

Get the properties file factory which loads the properties based on locale and style from *.properties and *.xml files

Returns:

properties factory

loadStringResource

public String loadStringResource(Component component,
                                 String key,
                                 Locale locale,
                                 String style,
                                 String variation)

Description copied from interface: IStringResourceLoader

Get the string resource for the given combination of component, resource key, locale and style. The component provided is used to allow implementation of component specific resource loading (e.g. per page or per reusable component). The key should be a String containing a lookup key into a resource bundle. The Locale and the style will be taken from the Component provided.

Specified by:

loadStringResource in interface IStringResourceLoader

Parameters:

component - The component to get the string resource for

key - The key should be a String containing a lookup key into a resource bundle

locale - Will be preset with the appropriate value. You shall ignore the component's locale.

style - Will be preset with the appropriate value. You shall ignore the component's style.

variation - Will be preset with the appropriate value. You shall ignore the component's variation.

Returns:

The string resource value or null if the resource could not be loaded by this loader

See Also:

IStringResourceLoader.loadStringResource(org.apache.wicket.Component, java.lang.String, java.util.Locale, java.lang.String, java.lang.String)

getResourcePath

protected String getResourcePath(Component component)

get path for resource lookup

Parameters:

component -

Returns:

path

isStopResourceSearch

protected boolean isStopResourceSearch(Component component)

Check the supplied component to see if it is one that we shouldn't bother further searches up the component hierarchy for properties.

Parameters:

component - The component to check

Returns:

Whether to stop the search

isStopResourceSearch

protected boolean isStopResourceSearch(Class<?> clazz)

Check the supplied class to see if it is one that we shouldn't bother further searches up the class hierarchy for properties.

Parameters:

clazz - The class to check

Returns:

Whether to stop the search