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

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

All Implemented Interfaces:

Component, Serviceable, ThreadSafe, InputModule

public class LayoutModule
extends AbstractModule

This input module gives access to information stored in a layout object by using JXPathExpressions. The syntax to use is LAYOUT_ID/PATH or LAYOUT_KEY:LAYOUT_ID/PATH

Version:

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

Author:

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

LayoutModule()

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

LayoutModule

public LayoutModule()

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