org.apache.cocoon.components.modules.input
Interface InputModule

All Superinterfaces:

Component

All Known Implementing Classes:

AbstractInputModule, AbstractJXPathModule, AbstractMetaModule, AbstractModule, BaseLinkModule, ChainMetaModule, CollectionMetaModule, ContextInputModule, ContextPathModule, CookieModule, CopletModule, DateInputModule, DateMetaInputModule, DefaultsMetaModule, DefaultsModule, DigestMetaModule, FlowAttributeModule, FlowContinuationModule, GlobalInputModule, HeaderAttributeModule, JXPathMetaModule, LayoutModule, LocateResource, MapMetaModule, NamingInputModule, NullInputModule, PortletURLModule, ProjectPathModule, PropertiesFileModule, RandomNumberModule, RawRequestParameterModule, RealPathModule, RequestAttributeModule, RequestModule, RequestParameterModule, RequestURIModule, SelectMetaInputModule, SessionAttributeModule, SessionModule, SimpleMappingMetaModule, SkinModule, StringConstantModule, SystemPropertyModule, URLDecodeModule, URLEncodeModule, XMLFileModule, XMLMetaModule, XPathXMLFileModule

public interface InputModule
extends Component

InputModule specifies an interface for components that provide access to individual attributes e.g. request parameters, request attributes, session attributes &c.

Version:

$Id: InputModule.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Christian Haul

Field Summary

static String

ROLE

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.

Field Detail

ROLE

static final String ROLE

Method Detail

getAttribute

Object getAttribute(String name,
                    Configuration modeConf,
                    Map objectModel)
                    throws ConfigurationException

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 getAttributeValues(String, Configuration, Map) or getAttributeNames(Configuration, Map) and getAttribute(String, Configuration, Map) to get them one by one.

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.

objectModel -

Throws:

ConfigurationException

getAttributeNames

Iterator getAttributeNames(Configuration modeConf,
                           Map objectModel)
                           throws ConfigurationException

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 resource description. This argument is optional.

objectModel -

Throws:

ConfigurationException

getAttributeValues

Object[] getAttributeValues(String name,
                            Configuration modeConf,
                            Map objectModel)
                            throws ConfigurationException

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, getAttributeNames(Configuration, Map) together with getAttribute(String, Configuration, Map) can be used to get the values one by one.

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.

objectModel -

Throws:

ConfigurationException