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

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

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

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, RendererAspect

Direct Known Subclasses:

CompositeContentAspect

public abstract class AbstractCompositeAspect
extends AbstractAspect

Insert a composite layout's elements into the resulting XML. Elements (items) are processed in order. Concrete descendents of this class need to implement the actual handling of layout elements.

Applicable to:

• CompositeLayout

Version:

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

Author:

Carsten Ziegeler, Volker Schmitt

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

AbstractCompositeAspect()

Method Summary

protected abstract void	processItem(RendererAspectContext context, Item item, ContentHandler handler, PortalService service) Process a single layout element.
protected void	processLayout(Layout layout, PortalService service, ContentHandler handler) Default implementation for processing a Layout.
void	toSAX(RendererAspectContext context, Layout layout, PortalService service, ContentHandler handler) Stream out raw layout

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

getAspectDescriptions, isRequired, prepareConfiguration, 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

AbstractCompositeAspect

public AbstractCompositeAspect()

Method Detail

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

Overrides:

toSAX in class AbstractAspect

Throws:

SAXException

See Also:

AbstractAspect.toSAX(org.apache.cocoon.portal.layout.renderer.aspect.RendererAspectContext, org.apache.cocoon.portal.layout.Layout, org.apache.cocoon.portal.PortalService, org.xml.sax.ContentHandler)

processItem

protected abstract void processItem(RendererAspectContext context,
                                    Item item,
                                    ContentHandler handler,
                                    PortalService service)
                             throws SAXException

Process a single layout element.

Parameters:

item - layout item to be processed

handler - SAX handler taking events

service - portal service providing component access

Throws:

SAXException

processLayout

protected void processLayout(Layout layout,
                             PortalService service,
                             ContentHandler handler)
                      throws SAXException

Default implementation for processing a Layout. Calls the associated renderer for a layout to render it.

Throws:

SAXException