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

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

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

Direct Known Subclasses:

DocumentURLModule, FallbackModule, MetaDataModule, PageEnvelopeModule, PublicationTemplateFallbackModule

public abstract class AbstractPageEnvelopeModule
extends OperationModule

Abstract superclass for classes which need access to the page envelope. The web application URL can be provided in the attribute name, separated by a colon (":").

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

AbstractPageEnvelopeModule()

Method Summary

protected java.lang.String	getAttributeName(java.lang.String name)
protected PageEnvelope	getEnvelope(java.util.Map objectModel, java.lang.String name) Get the the page envelope for the given objectModel.

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

configure, dispose, getAttribute, getAttributeNames, getAttributeValues

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

AbstractPageEnvelopeModule

public AbstractPageEnvelopeModule()

Method Detail

getEnvelope

protected PageEnvelope getEnvelope(java.util.Map objectModel,
                                   java.lang.String name)
                            throws org.apache.avalon.framework.configuration.ConfigurationException

Get the the page envelope for the given objectModel.

Parameters:

objectModel - the objectModel for which the page enevelope is requested.

name - The attribute name.

Returns:

a PageEnvelope

Throws:

org.apache.avalon.framework.configuration.ConfigurationException - if the page envelope could not be instantiated.

getAttributeName

protected java.lang.String getAttributeName(java.lang.String name)

Parameters:

name - The original attribute name.

Returns:

The attribute name without URL attachment.