This project has retired. For details please refer to its Attic page.

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

java.lang.Object
  org.apache.cocoon.util.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.cocoon.components.modules.input.AbstractMetaModule
              org.apache.cocoon.components.modules.input.MapMetaModule

All Implemented Interfaces:

Configurable, Disposable, org.apache.cocoon.components.modules.input.InputModule, Serviceable, ThreadSafe

public class MapMetaModule

extends org.apache.cocoon.components.modules.input.AbstractMetaModule

implements ThreadSafe

Meta module that obtains an Object from another module, assumes that this Object implements the java.util.Map interface, and gives access to the map contents. Possible use is to propagate data from flow through request attributes to database actions. The same can be achieved by using the JXPathMetaModule.

Configuration: "input-module", "object", "parameter"

Version:

$Id: MapMetaModule.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary

protected String	objectName
protected String	parameter

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

MapMetaModule()

Method Summary

void	configure(Configuration config)
Object	getAttribute(String name, Configuration modeConf, Map objectModel)
Iterator	getAttributeNames(Configuration modeConf, Map objectModel)
Object[]	getAttributeValues(String name, Configuration modeConf, Map objectModel)

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

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

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

objectName

protected String objectName

parameter

protected String parameter

Constructor Detail

MapMetaModule

public MapMetaModule()

Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

See Also:

AbstractInputModule.configure(org.apache.avalon.framework.configuration.Configuration)

getAttribute

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

Specified by:

getAttribute in interface org.apache.cocoon.components.modules.input.InputModule

Throws:

ConfigurationException

See Also:

AbstractInputModule.getAttribute(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getAttributeNames

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

Specified by:

getAttributeNames in interface org.apache.cocoon.components.modules.input.InputModule

Throws:

ConfigurationException

See Also:

AbstractInputModule.getAttributeNames(org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getAttributeValues

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

Specified by:

getAttributeValues in interface org.apache.cocoon.components.modules.input.InputModule

Throws:

ConfigurationException

See Also:

AbstractInputModule.getAttributeValues(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)