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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractJXPathModule, AbstractMetaModule

public abstract class AbstractInputModule

extends org.apache.cocoon.util.AbstractLogEnabled

implements org.apache.cocoon.components.modules.input.InputModule, Configurable, Disposable

AbstractInputModule gives you the infrastructure for easily deploying more InputModules. In order to get at the Logger, use getLogger().

Version:

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

Field Summary

protected org.apache.cocoon.util.HashMap

settings Stores (global) configuration parameters as key / value pairs.

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

ROLE

Constructor Summary

AbstractInputModule()

Method Summary

void	configure(Configuration conf) Configures the database access helper.
void	dispose()
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.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

settings

protected org.apache.cocoon.util.HashMap settings

Stores (global) configuration parameters as key / value pairs.

Constructor Detail

AbstractInputModule

public AbstractInputModule()

Method Detail

configure

public void configure(Configuration conf)
               throws ConfigurationException

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

Throws:

ConfigurationException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

See Also:

Disposable.dispose()

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:

InputModule.getAttribute(java.lang.String, 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:

InputModule.getAttributeValues(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:

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