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

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

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.CollectionMetaModule

All Implemented Interfaces:

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

public class CollectionMetaModule

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

implements ThreadSafe

Constructs an array of values suitable for a JDBC collection type from parameters obtained from another input module. Application is not limited to JDBC collections but can be used wherever similar named attributes shall be collected to an array of a given type. Currently, long, int, and string are known, more to come.

Global and local configuration

input-module

Name of the input module used to obtain the value and its configuration

member

Collection member

Attribute
name	Parameter name, "*" may distinguish multiple collections
type	JDBC type name of members

Version:

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

Field Summary

protected Configuration

memberConf

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

CollectionMetaModule()

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

memberConf

protected Configuration memberConf

Constructor Detail

CollectionMetaModule

public CollectionMetaModule()

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)