| org.apache.cocoon.components.modules.input.InputModule
All known Subclasses: org.apache.cocoon.portal.components.modules.input.AbstractModule, org.apache.cocoon.webapps.session.components.ContextInputModule, org.apache.cocoon.components.modules.input.GlobalInputModule, org.apache.cocoon.components.modules.input.AbstractInputModule, org.apache.cocoon.components.modules.input.DefaultsModule,
| InputModule | | public interface InputModule extends Component(Code) | | InputModule specifies an interface for components that provide
access to individual attributes e.g. request parameters, request
attributes, session attributes &c.
author:
Christian Haul
version:
$Id: InputModule.java 433543 2006-08-22 06:22:54Z crossley $ |
| Method Summary | |
| 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. |
| getAttribute | | Object getAttribute(String name, Configuration modeConf, Map objectModel) throws ConfigurationException(Code) | | 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.
Parameters:
name - a String that specifies what the caller thinkswould identify an attribute. This is mainly a fallback if nomodeConf is present.
Parameters:
modeConf - column's mode configuration from resourcedescription. This argument is optional.
Parameters:
objectModel - |
| getAttributeNames | | Iterator getAttributeNames(Configuration modeConf, Map objectModel) throws ConfigurationException(Code) | | Returns an Iterator of String objects containing the names
of the attributes available. If no attributes are available,
the method returns an empty Iterator.
Parameters:
modeConf - column's mode configuration from resourcedescription. This argument is optional.
Parameters:
objectModel - |
| getAttributeValues | | Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel) throws ConfigurationException(Code) | | 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.
Parameters:
name - a String that specifies what the caller thinkswould identify an attributes. This is mainly a fallbackif no modeConf is present.
Parameters:
modeConf - column's mode configuration from resourcedescription. This argument is optional.
Parameters:
objectModel - |
|
|