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

All Implemented Interfaces:

org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled, org.apache.cocoon.components.modules.input.InputModule

Direct Known Subclasses:

DocumentURLModule, DublinCoreModule, FallbackModule, PageEnvelopeModule

public abstract class AbstractPageEnvelopeModule
extends org.apache.cocoon.components.modules.input.AbstractInputModule

Abstract superclass for classes which need access to the page envelope.

Field Summary

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 PageEnvelope

getEnvelope(java.util.Map objectModel) Get the the page envelope for the given objectModel.

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

Returns:

a PageEnvelope

Throws:

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