cziegeler 2003/12/09 07:56:15
Modified: src/blocks/portal/java/org/apache/cocoon/portal/generation
PortalGenerator.java
Log:
Add some comments
Revision Changes Path
1.4 +18 -7
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/generation/PortalGenerator.java
Index: PortalGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/generation/PortalGenerator.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PortalGenerator.java 4 Sep 2003 09:38:32 -0000 1.3
+++ PortalGenerator.java 9 Dec 2003 15:56:15 -0000 1.4
@@ -64,7 +64,13 @@
import org.xml.sax.SAXException;
/**
- *
+ * 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 [EMAIL PROTECTED] PortalManager} component.
+ * This generator needs one runtime configuration: the name of
+ * the portal to render as a sitemap parameter named "portal-name".
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Volker Schmitt</a>
*
@@ -73,12 +79,15 @@
public class PortalGenerator
extends ServiceableGenerator {
- /**
+ /* (non-Javadoc)
* @see org.apache.cocoon.generation.Generator#generate()
*/
public void generate()
- throws IOException, SAXException, ProcessingException {
+ throws IOException, SAXException, ProcessingException {
+ // start the portal rendering
+ // 1. event processing
+ // 2. rendering
PortalManager pm = null;
try {
pm = (PortalManager)this.manager.lookup(PortalManager.ROLE);
@@ -95,12 +104,14 @@
* @see
org.apache.cocoon.sitemap.SitemapModelComponent#setup(org.apache.cocoon.environment.SourceResolver,
java.util.Map, java.lang.String,
org.apache.avalon.framework.parameters.Parameters)
*/
public void setup(SourceResolver resolver,
- Map objectModel,
- String src,
- Parameters par)
+ Map objectModel,
+ String src,
+ Parameters par)
throws ProcessingException, SAXException, IOException {
super.setup(resolver, objectModel, src, par);
+ // instantiate the portal service for this request
+ // and set the portal-name
PortalService service = null;
try {
service = (PortalService)this.manager.lookup(PortalService.ROLE);
