org.apache.lenya.cms.cocoon.components.modules.input
Class PageEnvelopeModule
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
org.apache.lenya.cms.cocoon.components.modules.input.PageEnvelopeModule
- 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.avalon.framework.service.Serviceable, org.apache.cocoon.components.modules.input.InputModule
public class PageEnvelopeModule
- extends AbstractPageEnvelopeModule
- implements org.apache.avalon.framework.service.Serviceable
Input module wrapping the page envelope. This module provides publication
related information such as document-id, area, publication-id.
- See Also:
PageEnvelope
Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule |
settings |
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule |
ROLE |
Method Summary |
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 java.lang.String |
getDocumentType(java.util.Map objectModel,
PageEnvelope envelope)
Returns the document type. |
protected PageEnvelope |
getEnvelope(java.util.Map objectModel)
Get the the page envelope for the given objectModel. |
void |
service(org.apache.avalon.framework.service.ServiceManager manager)
|
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule |
configure, 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 |
URI_PARAMETER_DOCTYPE
protected static final java.lang.String URI_PARAMETER_DOCTYPE
- See Also:
- Constant Field Values
DATE_FORMAT
public static final java.lang.String DATE_FORMAT
- See Also:
- Constant Field Values
PageEnvelopeModule
public PageEnvelopeModule()
getEnvelope
protected PageEnvelope getEnvelope(java.util.Map objectModel)
throws org.apache.avalon.framework.configuration.ConfigurationException
- Get the the page envelope for the given objectModel.
- Overrides:
getEnvelope
in class AbstractPageEnvelopeModule
- 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.
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)
getDocumentType
protected java.lang.String getDocumentType(java.util.Map objectModel,
PageEnvelope envelope)
throws org.apache.avalon.framework.service.ServiceException,
URIParameterizerException
- Returns the document type.
- Parameters:
objectModel
- The object model.envelope
- The page envelope.
- Returns:
- A string.
- Throws:
org.apache.avalon.framework.service.ServiceException
- when something went wrong.
URIParameterizerException
- when something went wrong.
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)
service
public void service(org.apache.avalon.framework.service.ServiceManager manager)
throws org.apache.avalon.framework.service.ServiceException
- Specified by:
service
in interface org.apache.avalon.framework.service.Serviceable
- Throws:
org.apache.avalon.framework.service.ServiceException
- See Also:
Serviceable.service(org.apache.avalon.framework.service.ServiceManager)
Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.