|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
Meta module that obtains values from other module and returns all parameters as XML.
Config
<!-- in cocoon.xconf --> <input-module name="request" ignore="do-" strip="user."/> <!-- e.g. in database.xml --> <mode type="all" name="xmlmeta" ignore="foo." use="foo" strip="f" root="my-root"/>
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>
Should produce Objects that are XMLizable and Document one day. Currently, produces only Strings.
Field Summary | |
protected java.lang.String |
ignore
|
protected java.lang.String |
rootName
|
protected java.lang.String |
strip
|
protected java.lang.String |
use
|
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 |
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 |
Field Detail |
protected java.lang.String rootName
protected java.lang.String ignore
protected java.lang.String use
protected java.lang.String strip
Constructor Detail |
public XMLMetaModule()
Method Detail |
public void configure(org.apache.avalon.framework.configuration.Configuration config) throws org.apache.avalon.framework.configuration.ConfigurationException
AbstractInputModule
settings
. Nested
configuration option are not catered for. This way global
configuration options can be used.
For nested configurations override this function.
configure
in interface org.apache.avalon.framework.configuration.Configurable
configure
in class AbstractInputModule
org.apache.avalon.framework.configuration.ConfigurationException
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
InputModule
getAttributeSet
or getAttributeNames
and getAttribute
to get them one by one.
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
-
org.apache.avalon.framework.configuration.ConfigurationException
public java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel) throws org.apache.avalon.framework.configuration.ConfigurationException
InputModule
modeConf
- column's mode configuration from resource
description. This argument is optional.objectModel
-
org.apache.avalon.framework.configuration.ConfigurationException
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
InputModule
getAttributeNames
together with getAttribute
can be used to get the values one by one.
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
-
org.apache.avalon.framework.configuration.ConfigurationException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |