org.apache.cocoon.portal.components.modules.input
Class CopletModule

java.lang.Object
  org.apache.cocoon.portal.components.modules.input.AbstractModule
      org.apache.cocoon.portal.components.modules.input.CopletModule

All Implemented Interfaces:

Component, Serviceable, ThreadSafe, InputModule

public class CopletModule
extends AbstractModule

Makes accessible coplet instance data by using JXPath expressions.

Example:

<map:action type="foo">
        <map:parameter name="maxpageable" value="{coplet:copletData/maxpageable}"/>
 </map:action>

The module will insert the boolean value specifying whether the coplet is maxpageable or not as value of attribute "value" in <map:parameter>. There are two possibilities how the module obtains the information required for getting the coplet instance data:

1) If it is used within a coplet pipeline and this pipeline is called using the "cocoon:" protocol, all required information are passed automatically.
2) Otherwise the portal name and the coplet id must be passed in the object model which can be done by using the ObjectModelAction:

<map:action type="objectModel">
        <map:parameter name="portalName" value="exampleportal"/>
        <map:parameter name="copletId" value="examplecoplet"/>
        <map:action type="foo">
                <map:parameter name="maxpageable" value="{coplet:copletData/maxpageable}"/>
        </map:action>
 </map:action>

Using the path '#' you get the current copletId: {coplet:#}

Version:

CVS $Id: CopletModule.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Björn Lütkemeier, Carsten Ziegeler

Field Summary

Fields inherited from class org.apache.cocoon.portal.components.modules.input.AbstractModule

manager

Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule

ROLE

Constructor Summary

CopletModule()

Method Summary

Object

getAttribute(String name, Configuration modeConf, Map objectModel) Standard access to an attribute's value.

Methods inherited from class org.apache.cocoon.portal.components.modules.input.AbstractModule

getAttributeNames, getAttributeValues, service

Methods inherited from class java.lang.Object

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

Constructor Detail

CopletModule

public CopletModule()

Method Detail

getAttribute

public Object getAttribute(String name,
                           Configuration modeConf,
                           Map objectModel)
                    throws ConfigurationException

Description copied from interface: InputModule

Standard access to an attribute's value. If more than one value exists, the first is returned. If the value does not exist, null is returned. To get all values, use InputModule.getAttributeValues(String, Configuration, Map) or InputModule.getAttributeNames(Configuration, Map) and InputModule.getAttribute(String, Configuration, Map) to get them one by one.

Parameters:

name - a String that specifies what the caller thinks would identify an attribute. This is mainly a fallback if no modeConf is present.

modeConf - column's mode configuration from resource description. This argument is optional.

Throws:

ConfigurationException