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

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.components.modules.input.AbstractInputModule
All Implemented Interfaces:
Disposable, Component, Configurable, LogEnabled, InputModule
Direct Known Subclasses:
AbstractJXPathModule, AbstractMetaModule, BaseLinkModule, ContextPathModule, CookieModule, DateInputModule, HeaderAttributeModule, LocateResource, NamingInputModule, NullInputModule, PortletURLModule, ProjectPathModule, RandomNumberModule, RawRequestParameterModule, RealPathModule, RequestAttributeModule, RequestParameterModule, RequestURIModule, SessionAttributeModule, StringConstantModule, URLDecodeModule, URLEncodeModule, XPathXMLFileModule

public abstract class AbstractInputModule
extends AbstractLogEnabled
implements InputModule, Configurable, Disposable

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

Version:
CVS $Id: AbstractInputModule.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Christian Haul

Field Summary
protected  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()
          dispose
 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.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
 

Field Detail

settings

protected 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()
dispose

Specified by:
dispose in interface Disposable

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
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
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
Parameters:
modeConf - column's mode configuration from resource description. This argument is optional.
Throws:
ConfigurationException


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.