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

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.GlobalInputModule

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, InputModule

Deprecated. This module will be replaced by a better version in 2.2.

public final class GlobalInputModule
extends AbstractLogEnabled
implements InputModule, Serviceable, ThreadSafe

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.

Version:

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

Author:

Carsten Ziegeler

Field Summary

Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule

ROLE

Constructor Summary

GlobalInputModule()
Deprecated.

Method Summary

Object	getAttribute(String name, Configuration modeConf, Map objectModel) Deprecated. Standard access to an attribute's value.
Iterator	getAttributeNames(Configuration modeConf, Map objectModel) Deprecated. Returns an Iterator of String objects containing the names of the attributes available.
Object[]	getAttributeValues(String name, Configuration modeConf, Map objectModel) Deprecated. Returns an array of String objects containing all of the values the given attribute has, or null if the attribute does not exist.
void	service(ServiceManager manager) Deprecated. Serviceable

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

GlobalInputModule

public GlobalInputModule()

Deprecated.

Method Detail

service

public void service(ServiceManager manager)

Deprecated.

Serviceable

Specified by:

service in interface Serviceable

getAttribute

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

Deprecated.

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.

Specified by:

getAttribute in interface InputModule

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

public Iterator getAttributeNames(Configuration modeConf,
                                  Map objectModel)
                           throws ConfigurationException

Deprecated.

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

Parameters:

modeConf - column's mode configuration from resource description. This argument is optional.

objectModel -

Throws:

ConfigurationException

getAttributeValues

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

Deprecated.

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.

Specified by:

getAttributeValues in interface InputModule

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