org.apache.lenya.cms.cocoon.components.modules.input
Class MetaDataModule

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.lenya.cms.cocoon.components.modules.input.OperationModule
              org.apache.lenya.cms.cocoon.components.modules.input.AbstractPageEnvelopeModule
                  org.apache.lenya.cms.cocoon.components.modules.input.MetaDataModule

All Implemented Interfaces:

org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.cocoon.components.modules.input.InputModule

public class MetaDataModule
extends AbstractPageEnvelopeModule

Input module to access meta data values. Use the name of the element as input module parameter.

Configuration:

  <component-instance logger="sitemap.modules.input.dublincore" name="[...]"
    class="org.apache.lenya.cms.cocoon.components.modules.input.MetaDataModule"
    namespace="[namespace URI of the element set]"/>
 

Usage examples:

• {dublincore:title}
• {myMetData:myElementName}

Field Summary

Fields inherited from class org.apache.lenya.cms.cocoon.components.modules.input.OperationModule

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

MetaDataModule()

Method Summary

void	configure(org.apache.avalon.framework.configuration.Configuration conf)
java.lang.Object	getAttribute(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
java.util.Iterator	getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
java.lang.Object[]	getAttributeValues(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
protected MetaData	getCustomMetaData(java.util.Map objectModel)

Methods inherited from class org.apache.lenya.cms.cocoon.components.modules.input.AbstractPageEnvelopeModule

getAttributeName, getEnvelope

Methods inherited from class org.apache.lenya.cms.cocoon.components.modules.input.OperationModule

contextualize, getDocumentFactory, initialize, service

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

dispose

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

MetaDataModule

public MetaDataModule()

Method Detail

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

Specified by:

getAttribute in interface org.apache.cocoon.components.modules.input.InputModule

Overrides:

getAttribute in class org.apache.cocoon.components.modules.input.AbstractInputModule

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

InputModule.getAttribute(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getAttributeNames

public java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf,
                                            java.util.Map objectModel)
                                     throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

getAttributeNames in interface org.apache.cocoon.components.modules.input.InputModule

Overrides:

getAttributeNames in class org.apache.cocoon.components.modules.input.AbstractInputModule

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

InputModule.getAttributeNames(org.apache.avalon.framework.configuration.Configuration, java.util.Map)

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

Specified by:

getAttributeValues in interface org.apache.cocoon.components.modules.input.InputModule

Overrides:

getAttributeValues in class org.apache.cocoon.components.modules.input.AbstractInputModule

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

InputModule.getAttributeValues(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getCustomMetaData

protected MetaData getCustomMetaData(java.util.Map objectModel)
                              throws org.apache.avalon.framework.configuration.ConfigurationException

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

configure

public void configure(org.apache.avalon.framework.configuration.Configuration conf)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Overrides:

configure in class org.apache.cocoon.components.modules.input.AbstractInputModule

Throws:

org.apache.avalon.framework.configuration.ConfigurationException