org.apache.cocoon.components.modules.input
Class SimpleMappingMetaModule

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.cocoon.components.modules.input.AbstractMetaModule
              org.apache.cocoon.components.modules.input.SimpleMappingMetaModule

All Implemented Interfaces:

Disposable, Component, Composable, Configurable, LogEnabled, ThreadSafe, InputModule

public class SimpleMappingMetaModule
extends AbstractMetaModule
implements ThreadSafe

Meta module that obtains values from an other module and by replacing the requested attribute name with another name. This is done first through a replacement table and may additionally prepend or append a string. Replacement works in both ways, it is applied to the returned attribute names as well.

Example configuration:

 <prefix>cocoon.</prefix>
 <suffix>.attr</suffix>
 <mapping in="foo" out="bar"/>
 <mapping in="yuk" out="yeeha"/>

Will map a parameter "foo" to the real one named "cocoon.bar.attr". If parameters "coocoon.yeeha.attr" and "shopping.cart" exist, the iterator will return "yeeha". "shopping.cart" does not contain the pre-/ suffix and thus is dropped.

Similarily, rm-prefix and rm-suffix will be removed from the attribute name.

Version:

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

Author:

Christian Haul

Nested Class Summary

protected static class

SimpleMappingMetaModule.Mapping

Field Summary

Fields inherited from class org.apache.cocoon.components.modules.input.AbstractMetaModule

defaultInput, initialized, input, INPUT_MODULE_SELECTOR, inputConf, inputSelector, manager

Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

settings

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

ROLE

Constructor Summary

SimpleMappingMetaModule()

Method Summary

void	configure(Configuration config) Configures the database access helper.
Object	getAttribute(String name, Configuration modeConf, Map objectModel) Standard access to an attribute's value.
Iterator	getAttributeNames(Configuration modeConf, Map objectModel) Returns an Iterator of String objects containing the names of the attributes available.
Object[]	getAttributeValues(String name, Configuration modeConf, Map objectModel) Returns an array of String objects containing all of the values the given attribute has, or null if the attribute does not exist.

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractMetaModule

compose, dispose, getNames, getNames, getValue, getValue, getValue, getValue, getValues, getValues, getValues, getValues, lazy_initialize, obtainModule, releaseModule

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMappingMetaModule

public SimpleMappingMetaModule()

Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException

Description copied from class: AbstractInputModule

Configures the database access helper. Takes all elements nested in component declaration and stores them as key-value pairs in settings. Nested configuration option are not catered for. This way global configuration options can be used. For nested configurations override this function.

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractInputModule

Throws:

ConfigurationException

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.

Specified by:

getAttribute in interface InputModule

Overrides:

getAttribute in class AbstractInputModule

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

getAttributeValues

public Object[] getAttributeValues(String name,
                                   Configuration modeConf,
                                   Map objectModel)
                            throws ConfigurationException

Description copied from interface: InputModule

Returns an array of String objects containing all of the values the given attribute has, or null if the attribute does not exist. As an alternative, InputModule.getAttributeNames(Configuration, Map) together with InputModule.getAttribute(String, Configuration, Map) can be used to get the values one by one.

Specified by:

getAttributeValues in interface InputModule

Overrides:

getAttributeValues in class AbstractInputModule

Parameters:

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

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

Throws:

ConfigurationException

getAttributeNames

public Iterator getAttributeNames(Configuration modeConf,
                                  Map objectModel)
                           throws ConfigurationException

Description copied from interface: InputModule

Returns an Iterator of String objects containing the names of the attributes available. If no attributes are available, the method returns an empty Iterator.

Specified by:

getAttributeNames in interface InputModule

Overrides:

getAttributeNames in class AbstractInputModule

Parameters:

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

Throws:

ConfigurationException