| org.apache.cocoon.components.modules.input.GlobalInputModule
| GlobalInputModule | | final public class GlobalInputModule extends AbstractLogEnabled implements InputModule,Serviceable,ThreadSafe(Code) | | This simple module allows to define global parameters in a sitemap. The
values are inherited from one sitemap to its sub sitemaps and can be
extended there.
author:
Carsten Ziegeler
version:
$Id: GlobalInputModule.java 433543 2006-08-22 06:22:54Z crossley $ |
| Method Summary | |
| public Object | getAttribute(String name, Configuration modeConf, Map objectModel)
Standard access to an attribute's value. | | public Iterator | getAttributeNames(Configuration modeConf, Map objectModel)
Returns an Iterator of String objects containing the names
of the attributes available. | | public 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. | | public void | service(ServiceManager manager)
|
| getAttribute | | public 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
GlobalInputModule.getAttributeValues(String,Configuration,Map) or
GlobalInputModule.getAttributeNames(Configuration,Map) and
GlobalInputModule.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 | | public 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 | | public 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,
GlobalInputModule.getAttributeNames(Configuration,Map) together with
GlobalInputModule.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 - |
| service | | public void service(ServiceManager manager)(Code) | | Serviceable
|
|
|