org.apache.cocoon.components.modules.input
Class XMLMetaModule
java.lang.Object
org.apache.cocoon.util.AbstractLogEnabled
org.apache.cocoon.components.modules.input.AbstractInputModule
org.apache.cocoon.components.modules.input.AbstractMetaModule
org.apache.cocoon.components.modules.input.XMLMetaModule
- All Implemented Interfaces:
- Configurable, Disposable, org.apache.cocoon.components.modules.input.InputModule, Serviceable, ThreadSafe
- public class XMLMetaModule
- extends org.apache.cocoon.components.modules.input.AbstractMetaModule
- implements ThreadSafe
Meta module that obtains values from other module and returns all
parameters as XML.
Config
<!-- in cocoon.xconf -->
<ignore>do-</ignore>
<strip>user.</strip>
<input-module name="request-param"/>
<!-- e.g. in database.xml -->
<mode type="all" name="xmlmeta"/>
<ignore>foo.</ignore>
<strip>f</strip>
<use>foo</use>
<root>my-root</root>
<input-module name="request-param"/>
</mode>
If present, "ignore" gives a prefix of parameters to ignore,
ignore has precedence over the "use" attribute, "strip" a prefix
that will be removed from the final parameter names in the produced
XML, "use" is a prefix for parameters to include in the XML, and
"root" is the name of the root element in the created XML.
Input
foo.one = ['abc']
foo.two = ['def']
foo1 = ['bar']
foo2 = ['one','two','three']
bar = ['rubber duck']
Output
<my-root>
<item name="oo1">bar</item>
<item name="oo2">
<value>one</value>
<value>two</value>
<value>three</value>
</item>
</my-root>
Produces Objects of type DocumentWrapper
- Version:
- $Id: XMLMetaModule.html 1304280 2012-03-23 11:18:01Z ilgrosso $
Fields inherited from class org.apache.cocoon.components.modules.input.AbstractMetaModule |
defaultInput, initialized, input, INPUT_MODULE_SELECTOR, inputConf, inputSelector, manager |
Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule |
settings |
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule |
ROLE |
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractMetaModule |
getNames, getNames, getValue, getValue, getValue, getValue, getValues, getValues, getValues, getValues, lazy_initialize, obtainModule, releaseModule |
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled |
getLogger, setLogger |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
rootName
protected String rootName
ignore
protected String ignore
use
protected String use
strip
protected String strip
config
protected Object config
xpathProcessor
protected XPathProcessor xpathProcessor
CACHE_OBJECT_NAME
protected static final String CACHE_OBJECT_NAME
- See Also:
- Constant Field Values
XMLMetaModule
public XMLMetaModule()
configure
public void configure(Configuration config)
throws ConfigurationException
- Specified by:
configure
in interface Configurable
- Throws:
ConfigurationException
- See Also:
AbstractInputModule.configure(org.apache.avalon.framework.configuration.Configuration)
getAttribute
public Object getAttribute(String name,
Configuration modeConf,
Map objectModel)
throws ConfigurationException
- Specified by:
getAttribute
in interface org.apache.cocoon.components.modules.input.InputModule
- Throws:
ConfigurationException
- See Also:
AbstractInputModule.getAttribute(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)
getAttributeNames
public Iterator getAttributeNames(Configuration modeConf,
Map objectModel)
throws ConfigurationException
- Specified by:
getAttributeNames
in interface org.apache.cocoon.components.modules.input.InputModule
- Throws:
ConfigurationException
- See Also:
AbstractInputModule.getAttributeNames(org.apache.avalon.framework.configuration.Configuration, java.util.Map)
getAttributeValues
public Object[] getAttributeValues(String name,
Configuration modeConf,
Map objectModel)
throws ConfigurationException
- Specified by:
getAttributeValues
in interface org.apache.cocoon.components.modules.input.InputModule
- Throws:
ConfigurationException
- See Also:
AbstractInputModule.getAttributeValues(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)
service
public void service(ServiceManager manager)
throws ServiceException
- Specified by:
service
in interface Serviceable
- Throws:
ServiceException
- See Also:
Serviceable.service(org.apache.avalon.framework.service.ServiceManager)
dispose
public void dispose()
- Specified by:
dispose
in interface Disposable
- See Also:
Disposable.dispose()
Copyright © 1999-2008 The Apache Software Foundation. All Rights Reserved.