org.apache.cocoon.portal.generation
Class PortalGenerator

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.generation.AbstractGenerator
              org.apache.cocoon.generation.ServiceableGenerator
                  org.apache.cocoon.portal.generation.PortalGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

public class PortalGenerator
extends ServiceableGenerator

This generator renders the complete portal. More precisly, this generator is the starting point for the portal rendering. The generator delegates the rendering process to to PortalManager component. This generator needs one runtime configuration: the name of the portal to render as a sitemap parameter named "portal-name".

Version:

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

Author:

Carsten Ziegeler, Volker Schmitt

Field Summary

protected PortalService

portalService The portal service.

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

PortalGenerator()

Method Summary

void	dispose() Release all resources.
void	generate() Generate the XML and stream it into the pipeline
void	service(ServiceManager manager) Set the current ServiceManager instance used by this Serviceable.
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters par) Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

portalService

protected PortalService portalService

The portal service.

Constructor Detail

PortalGenerator

public PortalGenerator()

Method Detail

dispose

public void dispose()

Description copied from class: ServiceableGenerator

Release all resources.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class ServiceableGenerator

See Also:

Disposable.dispose()

service

public void service(ServiceManager manager)
             throws ServiceException

Description copied from class: ServiceableGenerator

Set the current ServiceManager instance used by this Serviceable.

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

See Also:

Serviceable.service(org.apache.avalon.framework.service.ServiceManager)

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Description copied from interface: Generator

Generate the XML and stream it into the pipeline

Throws:

IOException

SAXException

ProcessingException

setup

public void setup(SourceResolver resolver,
                  Map objectModel,
                  String src,
                  Parameters par)
           throws ProcessingException,
                  SAXException,
                  IOException

Description copied from class: AbstractGenerator

Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractGenerator

Throws:

ProcessingException

SAXException

IOException