org.apache.cocoon.components.modules.input
Class SimpleMappingMetaModule
java.lang.Object
|
+--org.apache.avalon.framework.logger.AbstractLogEnabled
|
+--org.apache.cocoon.components.modules.input.AbstractInputModule
|
+--org.apache.cocoon.components.modules.input.AbstractMetaModule
|
+--org.apache.cocoon.components.modules.input.SimpleMappingMetaModule
- All Implemented Interfaces:
- org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, InputModule, org.apache.avalon.framework.logger.LogEnabled
- public class SimpleMappingMetaModule
- extends AbstractMetaModule
Meta module that obtains values from an other module and by
replacing the requested attribute name with another name. This is
done first through a replacement table and may additionally prepend
or append a string. Replacement works in both ways, it is applied
to the returned attribute names as well.
Example configuration:
<prefix>cocoon.</prefix>
<suffix>.attr</suffix>
<mapping in="foo" out="bar"/>
<mapping in="yuk" out="yeeha"/>
Will map a parameter "foo" to the real one named
"cocoon.bar.attr". If parameters "coocoon.yeeha.attr" and
"shopping.cart" exist, the iterator will return
"yeeha". "shopping.cart" does not contain the pre-/ suffix and
thus is dropped.
- Version:
- CVS $Id: SimpleMappingMetaModule.java,v 1.1.2.1 2002/11/30 10:21:39 haul Exp $
- Author:
- Christian Haul
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule |
ROLE |
Method Summary |
void |
configure(org.apache.avalon.framework.configuration.Configuration config)
Configures the database access helper.
|
java.lang.Object |
getAttribute(java.lang.String name,
org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
Standard access to an attribute's value. |
java.util.Iterator |
getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
Returns an Iterator of String objects containing the names
of the attributes available. |
java.lang.Object[] |
getAttributeValues(java.lang.String name,
org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.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. |
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractMetaModule |
compose, dispose, getNames, getNames, getValue, getValue, getValues, getValues, initialize, obtainModule, releaseModule |
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 |
SimpleMappingMetaModule
public SimpleMappingMetaModule()
configure
public void configure(org.apache.avalon.framework.configuration.Configuration config)
throws org.apache.avalon.framework.configuration.ConfigurationException
- Description copied from class:
AbstractInputModule
- Configures the database access helper.
Takes all elements nested in component declaration and stores
them as key-value pairs in
settings
. Nested
configuration option are not catered for. This way global
configuration options can be used.
For nested configurations override this function.
- Overrides:
configure
in class AbstractInputModule
getAttribute
public java.lang.Object getAttribute(java.lang.String name,
org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
throws org.apache.avalon.framework.configuration.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
getAttributeSet
or getAttributeNames
and getAttribute
to get them one by one.- Following copied from interface:
org.apache.cocoon.components.modules.input.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
-
getAttributeValues
public java.lang.Object[] getAttributeValues(java.lang.String name,
org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
throws org.apache.avalon.framework.configuration.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,
getAttributeNames
together with getAttribute
can be used to get the values one by one.- Following copied from interface:
org.apache.cocoon.components.modules.input.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
-
getAttributeNames
public java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
throws org.apache.avalon.framework.configuration.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.
- Following copied from interface:
org.apache.cocoon.components.modules.input.InputModule
- Parameters:
modeConf
- column's mode configuration from resource
description. This argument is optional.objectModel
-
Copyright � 1999-2002 Apache Software Foundation. All Rights Reserved.