org.hippoecm.hst.core.request
Interface ComponentConfiguration

All Known Implementing Classes:

ComponentConfigurationImpl, MockComponentConfiguration

public interface ComponentConfiguration

A ComponentConfiguration provides some configuration information to a component.

Version:

$Id: ComponentConfiguration.java 30625 2011-10-12 13:28:07Z uhommes $

Method Summary

String	getCanonicalIdentifier() Returns the identifier of the backing stored component configuration.
String	getCanonicalPath() Returns the canonical path of the backing stored configuration location.
HstComponentConfiguration.Type	getComponentType()
String	getLocalParameter(String name, ResolvedSiteMapItem hstResolvedSiteMapItem) Returns the property without inheritance and if an expession exists it is resolved with the help of the ResolvedSiteMapItem
Map<String,String>	getLocalParameters(ResolvedSiteMapItem hstResolvedSiteMapItem) Returns all resolved parameters without inheritance into a map
String	getParameter(String name, ResolvedSiteMapItem hstResolvedSiteMapItem) Returns the property and if an expession exists it is resolved with the help of the ResolvedSiteMapItem
List<String>	getParameterNames()
Map<String,String>	getParameters(ResolvedSiteMapItem hstResolvedSiteMapItem) Returns all resolved parameters into a map
Map<String,String>	getRawLocalParameters() Also see getLocalParameters(ResolvedSiteMapItem).
Map<String,String>	getRawParameters() Also see getParameters(ResolvedSiteMapItem).
String	getRenderPath()
String	getServeResourcePath()
String	getXType()

Method Detail

getParameter

String getParameter(String name,
                    ResolvedSiteMapItem hstResolvedSiteMapItem)

Returns the property and if an expession exists it is resolved with the help of the ResolvedSiteMapItem

getParameterNames

List<String> getParameterNames()

Returns:

the ordered list of available parameter names, empty list if there are no parameters

getParameters

Map<String,String> getParameters(ResolvedSiteMapItem hstResolvedSiteMapItem)

Returns all resolved parameters into a map

Parameters:

hstResolvedSiteMapItem -

getLocalParameter

String getLocalParameter(String name,
                         ResolvedSiteMapItem hstResolvedSiteMapItem)

Returns the property without inheritance and if an expession exists it is resolved with the help of the ResolvedSiteMapItem

getLocalParameters

Map<String,String> getLocalParameters(ResolvedSiteMapItem hstResolvedSiteMapItem)

Returns all resolved parameters without inheritance into a map

Parameters:

hstResolvedSiteMapItem -

getRawParameters

Map<String,String> getRawParameters()

Also see getParameters(ResolvedSiteMapItem). Normally, you use getParameters(ResolvedSiteMapItem), unless you want to access parameter values without having their property placeholders (like ${1}) substituded by the current request context. In other words, the parameter values exactly the way they are in the HstComponentConfiguration

Returns:

An unmodifiableMap of all parameters the way they are configured in the hst component configuration without having any property placeholder filled in by the current context

getRawLocalParameters

Map<String,String> getRawLocalParameters()

Also see getLocalParameters(ResolvedSiteMapItem). Normally, you use getLocalParameters(ResolvedSiteMapItem), unless you want to access parameter values without having their property placeholders (like ${1}) substituded by the current request context. In other words, the parameter values exactly the way they are in the HstComponentConfiguration. Note that this method does not return inherited parameters, but only its local (directly) configured ones

Returns:

An unmodifiableMap of all parameters the way they are configured in the hst component configuration without having any property placeholder filled in by the current context and without parameter inheritance

getRenderPath

String getRenderPath()

Returns:

the location of the view renderer

getServeResourcePath

String getServeResourcePath()

Returns:

return the servletpath of the servlet that must serve the resources for this HstComponent

getCanonicalPath

String getCanonicalPath()

Returns the canonical path of the backing stored configuration location. Note that multiple (many) ComponentConfiguration's can share the same canonical path: When a component is added by a reference, this method will return the same canonical path as the direct (not referenced) component.

Returns:

the canonical path of the backing stored configuration location.

getCanonicalIdentifier

String getCanonicalIdentifier()

Returns the identifier of the backing stored component configuration. Note that multiple ComponentConfiguration's can share the same canonical identifier due to inheritance. Also, multiple subsites can share the same backing configuration, and thus share the same canonical identifiers

Returns:

the identifier of the backing stored component configuration

getXType

String getXType()

Returns:

the xtype of this ComponentConfiguration and null if the component does not have one

getComponentType

HstComponentConfiguration.Type getComponentType()

Returns:

the HstComponentConfiguration.Type of this ComponentConfiguration