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

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.cocoon.components.modules.input.AbstractInputModule
          extended byorg.apache.cocoon.components.modules.input.RequestAttributeModule
              extended byorg.apache.cocoon.components.modules.input.RequestScopedAttributeModule
All Implemented Interfaces:
Configurable, Disposable, InputModule, LogEnabled, ThreadSafe

public class RequestScopedAttributeModule
extends RequestAttributeModule

This is an extension of the RequestAttributeModule. It has the same features but requires to define the scope of an attribute: either "global" or "request"; so the name follows this form: SCOPE:KEY.

Since:
2.2
Version:
CVS $Id: RequestScopedAttributeModule.java 30941 2004-07-29 19:56:58Z vgritsenko $

Field Summary
 
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
RequestScopedAttributeModule()
           
 
Method Summary
 Object getAttribute(String name, Configuration modeConf, Map objectModel)
          Standard access to an attribute's value.
 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.RequestAttributeModule
getAttribute, getAttributeNames, getAttributeValues
 
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule
configure, dispose
 
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

RequestScopedAttributeModule

public RequestScopedAttributeModule()
Method Detail

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 RequestAttributeModule
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 RequestAttributeModule
Throws:
ConfigurationException


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.