org.apache.cocoon.sitemap
Class SitemapManager

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.sitemap.Manager
              |
              +--org.apache.cocoon.sitemap.SitemapManager

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.logger.LogKitManageable, Processor, org.apache.avalon.framework.thread.ThreadSafe

public class SitemapManager

extends Manager

implements Processor, org.apache.avalon.framework.configuration.Configurable

A Processor based on the sitemap language files.

Version:

CVS $Id: SitemapManager.java,v 1.10.2.1 2002/09/21 03:01:13 vgritsenko Exp $

Author:

Sylvain Wallez, Vadim Gritsenko

Field Summary

protected java.lang.String	sitemapFileName The sitemap file
protected Handler	sitemapHandler The root sitemap's handler

Fields inherited from class org.apache.cocoon.sitemap.Manager

conf, context, handlerClass, manager, sitemapLogKitManager, sitemapRoles

Fields inherited from interface org.apache.cocoon.Processor

ROLE

Constructor Summary

SitemapManager()

Method Summary

void	configure(org.apache.avalon.framework.configuration.Configuration sconf) Get a configuration
void	dispose() Disposable
void	generateSitemap(Environment environment) Process the given Environment to generate the sitemap.
boolean	process(Environment environment) Process the given Environment producing the output.
boolean	process(Environment environment, StreamPipeline pipeline, EventPipeline eventPipeline) Process the given Environment to assemble a StreamPipeline and an EventPipeline.

Methods inherited from class org.apache.cocoon.sitemap.Manager

compose, contextualize, createHandler, invoke, invoke, setLogKitManager, setRoleManager

Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable

getLogger, setLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sitemapFileName

protected java.lang.String sitemapFileName

The sitemap file

sitemapHandler

protected Handler sitemapHandler

The root sitemap's handler

Constructor Detail

SitemapManager

public SitemapManager()

Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration sconf)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Description copied from class: Manager

Get a configuration

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Overrides:

configure in class Manager

Following copied from class: org.apache.cocoon.sitemap.Manager

Parameters:

conf - the configuration

generateSitemap

public void generateSitemap(Environment environment)
                     throws java.lang.Exception

Process the given Environment to generate the sitemap.

process

public boolean process(Environment environment)
                throws java.lang.Exception

Process the given Environment producing the output.

Specified by:

process in interface Processor

Following copied from interface: org.apache.cocoon.Processor

Returns:

If the processing is successfull true is returned. If not match is found in the sitemap false is returned.

Throws:

ResourceNotFoundException - If a sitemap component tries to access a resource which can not be found, e.g. the generator ConnectionResetException If the connection was reset

process

public boolean process(Environment environment,
                       StreamPipeline pipeline,
                       EventPipeline eventPipeline)
                throws java.lang.Exception

Process the given Environment to assemble a StreamPipeline and an EventPipeline.

Specified by:

process in interface Processor

dispose

public void dispose()

Description copied from class: Manager

Disposable

Overrides:

dispose in class Manager