org.apache.cocoon.sitemap
Interface Sitemap

All Superinterfaces:

CompiledComponent, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, Modifiable, Processor

All Known Implementing Classes:

AbstractSitemap

public interface Sitemap

extends CompiledComponent, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, Processor

Base interface for generated Sitemap classes

Version:

CVS $Id: Sitemap.java,v 1.4 2002/02/22 07:03:55 cziegeler Exp $

Author:

Giacomo Pati

Field Summary

static int	ACTION
static int	GENERATOR
static int	MATCHER
static int	READER
static int	SELECTOR
static int	SERIALIZER
static int	TRANSFORMER

Fields inherited from interface org.apache.cocoon.Processor

ROLE

Method Summary

org.apache.avalon.framework.component.ComponentManager	getComponentManager() Return the component manager for this sitemap
boolean	process(Environment environment) Process the given Environment
boolean	process(Environment environment, StreamPipeline pipeline, EventPipeline eventPipeline) Process the given Environment assebling a StreamPipeline and an EventPipeline

Methods inherited from interface org.apache.avalon.framework.component.Composable

compose

Methods inherited from interface org.apache.cocoon.Modifiable

modifiedSince

Methods inherited from interface org.apache.avalon.framework.configuration.Configurable

configure

Methods inherited from interface org.apache.avalon.framework.context.Contextualizable

contextualize

Field Detail

GENERATOR

public static final int GENERATOR

TRANSFORMER

public static final int TRANSFORMER

SERIALIZER

public static final int SERIALIZER

READER

public static final int READER

ACTION

public static final int ACTION

MATCHER

public static final int MATCHER

SELECTOR

public static final int SELECTOR

Method Detail

getComponentManager

public org.apache.avalon.framework.component.ComponentManager getComponentManager()

Return the component manager for this sitemap

process

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

Process the given Environment

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 assebling a StreamPipeline and an EventPipeline

Specified by:

process in interface Processor