org.apache.cocoon
Interface Processor

All Superinterfaces:

Component

All Known Implementing Classes:

Cocoon, ConcreteTreeProcessor, ProcessorWrapper, TreeProcessor

public interface Processor

extends Component

Version:

CVS $Id: Processor.java 433543 2006-08-22 06:22:54Z crossley $

Author:

Pierpaolo Fumagalli (Apache Software Foundation), Carsten Ziegeler

Field Summary

static String

ROLE

Method Summary

ProcessingPipeline	buildPipeline(Environment environment) Process the given Environment to assemble a ProcessingPipeline.
Map	getComponentConfigurations() Get the sitemap component configurations
Processor	getRootProcessor() Get the root processor parent of this processor.
boolean	process(Environment environment) Process the given Environment producing the output.

Field Detail

ROLE

public static final String ROLE

Method Detail

process

public boolean process(Environment environment)
                throws Exception

Process the given Environment producing the output.

Returns:

If the processing is successfull true is returned. If no 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

Exception

buildPipeline

public ProcessingPipeline buildPipeline(Environment environment)
                                 throws Exception

Process the given Environment to assemble a ProcessingPipeline.

Throws:

Exception

Since:

2.1

getComponentConfigurations

public Map getComponentConfigurations()

Get the sitemap component configurations

Since:

2.1

getRootProcessor

public Processor getRootProcessor()

Get the root processor parent of this processor.

Since:

2.1.1