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

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.XMLMetaModule

All Implemented Interfaces:

Disposable, Component, Composable, Configurable, LogEnabled, ThreadSafe, InputModule

public class XMLMetaModule
extends 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 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Christian Haul

Field Summary

protected static String	CACHE_OBJECT_NAME
protected Object	config
protected String	ignore
protected String	rootName
protected String	strip
protected String	use
protected XPathProcessor	xpathProcessor

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

Constructor Summary

XMLMetaModule()

Method Summary

void	compose(ComponentManager manager) Set the current ComponentManager instance used by this Composable.
void	configure(Configuration config) Configures the database access helper.
void	dispose() Dispose exactly one cached InputModule.
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.

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.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

Field Detail

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

Constructor Detail

XMLMetaModule

public XMLMetaModule()

Method Detail

configure

public void configure(Configuration config)
               throws 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.

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractInputModule

Throws:

ConfigurationException

getAttribute

public Object getAttribute(String name,
                           Configuration modeConf,
                           Map objectModel)
                    throws 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 InputModule.getAttributeValues(String, Configuration, Map) or InputModule.getAttributeNames(Configuration, Map) and InputModule.getAttribute(String, Configuration, Map) to get them one by one.

Specified by:

getAttribute in interface InputModule

Overrides:

getAttribute in class AbstractInputModule

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.

Throws:

ConfigurationException

getAttributeNames

public Iterator getAttributeNames(Configuration modeConf,
                                  Map objectModel)
                           throws 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.

Specified by:

getAttributeNames in interface InputModule

Overrides:

getAttributeNames in class AbstractInputModule

Parameters:

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

Throws:

ConfigurationException

getAttributeValues

public Object[] getAttributeValues(String name,
                                   Configuration modeConf,
                                   Map objectModel)
                            throws 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, InputModule.getAttributeNames(Configuration, Map) together with InputModule.getAttribute(String, Configuration, Map) can be used to get the values one by one.

Specified by:

getAttributeValues in interface InputModule

Overrides:

getAttributeValues in class AbstractInputModule

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.

Throws:

ConfigurationException

compose

public void compose(ComponentManager manager)
             throws ComponentException

Description copied from class: AbstractMetaModule

Set the current ComponentManager instance used by this Composable.

Specified by:

compose in interface Composable

Overrides:

compose in class AbstractMetaModule

Throws:

ComponentException

dispose

public void dispose()

Description copied from class: AbstractMetaModule

Dispose exactly one cached InputModule. To work on more than one, override this method and initialize().

Specified by:

dispose in interface Disposable

Overrides:

dispose in class AbstractMetaModule