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

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
All Implemented Interfaces:
Component, LogEnabled, Serviceable, ThreadSafe, RendererAspect
Direct Known Subclasses:
AbstractActionAspect, AbstractCIncludeAspect, AbstractCompositeAspect, AddToBasketAspect, DefaultCopletAspect, FullScreenCopletAspect, HistoryAspect, ParameterAspect, PortletWindowAspect, RemovableAspect, SizingAspect, WindowAspect, XSLTAspect

public abstract class AbstractAspect
extends AbstractLogEnabled
implements Serviceable, ThreadSafe, RendererAspect

Base class for renderer aspects.

Version:
CVS $Id: AbstractAspect.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Carsten Ziegeler, Volker Schmitt

Field Summary
protected  ServiceManager manager
           
 
Fields inherited from interface org.apache.cocoon.portal.layout.renderer.aspect.RendererAspect
ROLE
 
Constructor Summary
AbstractAspect()
           
 
Method Summary
 Iterator getAspectDescriptions(Object preparedConf)
          Return the aspects required for this renderer
 boolean isRequired()
           
 Object prepareConfiguration(Parameters configuration)
          Compile the configuration.
 void service(ServiceManager manager)
           
 void toSAX(RendererAspectContext context, Layout layout, PortalService service, ContentHandler handler)
          Stream out raw layout
 
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
 

Field Detail

manager

protected ServiceManager manager
Constructor Detail

AbstractAspect

public AbstractAspect()
Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException
Specified by:
service in interface Serviceable
Throws:
ServiceException

toSAX

public void toSAX(RendererAspectContext context,
                  Layout layout,
                  PortalService service,
                  ContentHandler handler)
           throws SAXException
Description copied from interface: RendererAspect
Stream out raw layout

Specified by:
toSAX in interface RendererAspect
Throws:
SAXException

getAspectDescriptions

public Iterator getAspectDescriptions(Object preparedConf)
Return the aspects required for this renderer

Specified by:
getAspectDescriptions in interface RendererAspect
Returns:
An iterator for the aspect descriptions or null.

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
Throws:
ParameterException

isRequired

public boolean isRequired()
Specified by:
isRequired in interface RendererAspect


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.