org.apache.cocoon.components.modules.input
Class RequestAttributeModule
java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.components.modules.input.AbstractInputModule
org.apache.cocoon.components.modules.input.RequestAttributeModule
- All Implemented Interfaces:
- Configurable, Disposable, InputModule, LogEnabled, ThreadSafe
- Direct Known Subclasses:
- RequestScopedAttributeModule
- public class RequestAttributeModule
- extends AbstractInputModule
- implements ThreadSafe
RequestAttributeModule accesses request attributes. If the
attribute name contains an askerisk "*" this is considered a
wildcard and all attributes that would match this wildcard are
considered to be part of an array of that name for
getAttributeValues. Only one "*" is allowed.
- Version:
- CVS $Id: RequestAttributeModule.java 30941 2004-07-29 19:56:58Z vgritsenko $
- Author:
- Christian Haul
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule |
ROLE |
Method Summary |
Object |
getAttribute(String name,
Configuration modeConf,
Map objectModel)
Standard access to an attribute's value. |
protected Object |
getAttribute(String name,
Configuration modeConf,
Map objectModel,
int scope)
|
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. |
protected Object[] |
getAttributeValues(String name,
Configuration modeConf,
Map objectModel,
int scope)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
RequestAttributeModule
public RequestAttributeModule()
getAttribute
protected Object getAttribute(String name,
Configuration modeConf,
Map objectModel,
int scope)
throws ConfigurationException
- Throws:
ConfigurationException
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 AbstractInputModule
- 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
- Overrides:
getAttributeNames
in class AbstractInputModule
- Throws:
ConfigurationException
getAttributeValues
protected Object[] getAttributeValues(String name,
Configuration modeConf,
Map objectModel,
int scope)
throws ConfigurationException
- 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 AbstractInputModule
- Throws:
ConfigurationException
Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.