Apache » Cocoon »

Cocoon Core 2.2 homepage

Cocoon Core 2.2

InputModuleAction

Summary

Simple helper action to allow passing sitemap variables to InputModules.

Basic information

Component typeAction
Cocoon blockcore
Java classorg.apache.cocoon.acting.InputModuleAction
Name in Sitemap
Cacheable

Documentation

Sitemap evaluation of input modules using the curly bracket syntax e.g.
{defaults:skin} suffers from the fact that it is not
possible to use a sitemap variable as part of the invocation like
{defaults:{1}}. This action takes three parameters, the name
of the input module, the attribute name, and whether to call getAttribute() or
getAttributeValues(). Thus the above becomes

<map:act type="inputmodule">
  <map:parameter name="module" value="defaults"/>
  <map:parameter name="attribute" value="{1}"/>
  <map:parameter name="single-value" value="false"/>

      <!-- do something with the result: "{1}" -->

</map:act>

The action invokes the
{@link org.apache.cocoon.components.modules.input.InputModule#getAttributeValues(String, Configuration, Map) getAttributeValues()}
method and returns all results numbered from "0". If no result exists,
"null" is returned and the nested block is skipped.
The name of the input module to use may be preconfigured when
declaring the action in your sitemap:

<map:action name="inputmodule"
                  src="org.apache.cocoon.acting.InputModuleAction"
                  logger="sitemap.action.inputmodule">
  <module>defaults</module>
  <single-value>false</single-value>
</map:action>