org.apache.tapestry.services.impl
Class ComponentPropertySourceImpl

java.lang.Object
  org.apache.tapestry.services.impl.ComponentPropertySourceImpl

All Implemented Interfaces:

EventListener, ResetEventListener, ComponentPropertySource

public class ComponentPropertySourceImpl
extends Object
implements ComponentPropertySource, ResetEventListener

Implementation of tapestry.props.ComponentPropertySource.

TODO: Figure out a testing strategy for this beast!

Since:

4.0

Author:

Howard M. Lewis Ship

Constructor Summary

ComponentPropertySourceImpl()

Method Summary

String	getComponentProperty(IComponent component, String propertyName) Returns the property value for a particular named meta-data property of the component.
String	getLocalizedComponentProperty(IComponent component, Locale locale, String propertyName) Like ComponentPropertySource.getComponentProperty(IComponent, String), but the property name will be localized to the component's current locale (determined from its page).
String	getLocalizedNamespaceProperty(INamespace namespace, Locale locale, String propertyName) As with ComponentPropertySource.getLocalizedComponentProperty(IComponent, Locale, String), but with a INamespace.
String	getNamespaceProperty(INamespace namespace, String propertyName) Returns the property value for a particular named meta-data property of the namespace.
void	resetEventDidOccur()
void	setChainBuilder(org.apache.hivemind.lib.chain.ChainBuilder chainBuilder)
void	setGlobalProperties(IPropertySource globalProperties)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentPropertySourceImpl

public ComponentPropertySourceImpl()

Method Detail

resetEventDidOccur

public void resetEventDidOccur()

Specified by:

resetEventDidOccur in interface ResetEventListener

getComponentProperty

public String getComponentProperty(IComponent component,
                                   String propertyName)

Description copied from interface: ComponentPropertySource

Returns the property value for a particular named meta-data property of the component. The search order is:

• The component's specification
• The specification of the application (or the library containing the component).
• The chain of global property sources.

Specified by:

getComponentProperty in interface ComponentPropertySource

Parameters:

component - The IComponent to get the property of.

propertyName - Key of the property.

Returns:

the value of the given key, or null if not found.

getLocalizedComponentProperty

public String getLocalizedComponentProperty(IComponent component,
                                            Locale locale,
                                            String propertyName)

Description copied from interface: ComponentPropertySource

Like ComponentPropertySource.getComponentProperty(IComponent, String), but the property name will be localized to the component's current locale (determined from its page). Localizing the property name means that a suffix may be appended to it. If the fully localized name is not found, then the locale is generalized (i.e., from "en_UK" to "en" to nothing) until a match is found.

Specified by:

getLocalizedComponentProperty in interface ComponentPropertySource

Parameters:

component - The IComponent to get the property of.

locale - The Locale to get properties for.

propertyName - Key of the property.

Returns:

the value of the given property name, or null if not found.

getNamespaceProperty

public String getNamespaceProperty(INamespace namespace,
                                   String propertyName)

Description copied from interface: ComponentPropertySource

Returns the property value for a particular named meta-data property of the namespace. The search order is:

• The library or application specification for the namespace.
• The chain of global property sources.

Specified by:

getNamespaceProperty in interface ComponentPropertySource

Parameters:

namespace - The namespace to get the property from.

propertyName - The key of the property to get.

Returns:

the value of the given key, or null if not found.

getLocalizedNamespaceProperty

public String getLocalizedNamespaceProperty(INamespace namespace,
                                            Locale locale,
                                            String propertyName)

Description copied from interface: ComponentPropertySource

As with ComponentPropertySource.getLocalizedComponentProperty(IComponent, Locale, String), but with a INamespace.

Specified by:

getLocalizedNamespaceProperty in interface ComponentPropertySource

Parameters:

namespace - The namespace to get the property from.

locale - Locale to filter the properties for.

propertyName - The key of the property to get.

Returns:

The matching property, or null if not found.

setChainBuilder

public void setChainBuilder(org.apache.hivemind.lib.chain.ChainBuilder chainBuilder)

setGlobalProperties

public void setGlobalProperties(IPropertySource globalProperties)