This project has retired. For details please refer to its Attic page.

org.apache.cocoon.portal.layout.renderer.aspect.impl
Class ParameterAspect

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
          org.apache.cocoon.portal.layout.renderer.aspect.impl.ParameterAspect

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, RendererAspect

public final class ParameterAspect
extends AbstractAspect

Add layout parameter to resulting XML stream so that they can be picked up later from a stylesheet for example. When passing parameters to the XSLTAspect consider it's ability to set XSL parameters directly.

Example XML:

   <parameter name1="value1" name2="value2" ... >
     <!-- output from following renderers -->
   </parameter>
 

Applicable to:

• Layout

Parameters

tag-name	Name of tag holding key-value pairs as attributes.		String	"parameter"

Version:

CVS $Id: ParameterAspect.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Volker Schmitt

Nested Class Summary

protected static class

ParameterAspect.PreparedConfiguration

Field Summary

Fields inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect

manager

Fields inherited from interface org.apache.cocoon.portal.layout.renderer.aspect.RendererAspect

ROLE

Constructor Summary

ParameterAspect()

Method Summary

Object	prepareConfiguration(Parameters configuration) Compile the configuration.
void	toSAX(RendererAspectContext context, Layout layout, PortalService service, ContentHandler contenthandler) Stream out raw layout

Methods inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect

getAspectDescriptions, isRequired, service

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

ParameterAspect

public ParameterAspect()

Method Detail

toSAX

public void toSAX(RendererAspectContext context,
                  Layout layout,
                  PortalService service,
                  ContentHandler contenthandler)
           throws SAXException

Description copied from interface: RendererAspect

Stream out raw layout

Specified by:

toSAX in interface RendererAspect

Overrides:

toSAX in class AbstractAspect

Throws:

SAXException

prepareConfiguration

public Object prepareConfiguration(Parameters configuration)
                            throws ParameterException

Description copied from interface: RendererAspect

Compile the configuration. A renderer aspect can "compile" the configuration in order to increase performance. If the renderer does not want to compile it should simply return the configuration. The "compiled" configuration is passed to the RendererAspect.getAspectDescriptions(Object) method and is available during streaming via the context object. This method can also be used for validation the configuration.

Specified by:

prepareConfiguration in interface RendererAspect

Overrides:

prepareConfiguration in class AbstractAspect

Throws:

ParameterException