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

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
          extended byorg.apache.cocoon.portal.layout.renderer.aspect.impl.ParameterAspect
All Implemented Interfaces:
LogEnabled, RendererAspect, Serviceable, ThreadSafe

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:

Parameters

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

Version:
$Id: ParameterAspect.java 322471 2005-10-16 13:24:19Z cziegeler $

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
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
See Also:
RendererAspect.toSAX(org.apache.cocoon.portal.layout.renderer.aspect.RendererAspectContext, org.apache.cocoon.portal.layout.Layout, org.apache.cocoon.portal.PortalService, org.xml.sax.ContentHandler)

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 available during streaming via the context object. This method can also be used for validating the configuration.

Specified by:
prepareConfiguration in interface RendererAspect
Overrides:
prepareConfiguration in class AbstractAspect
Throws:
ParameterException
See Also:
RendererAspect.prepareConfiguration(org.apache.avalon.framework.parameters.Parameters)


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.