org.mmbase.framework

Interface Processor

All Known Implementing Classes:

AbstractProcessor, JspProcessor

public interface Processor

A Processor handles interaction of a Block. It is like a Renderer, but it renders nothing, it only can change the state of the block, and hence influence the renderers. The other difference is that there be several Blocks in a request, which are all rendered, but at most one of them has its Processor executed. Processing itself happens with the process(org.mmbase.util.functions.Parameters) method, which is typically done using Framework.process(org.mmbase.framework.Processor, org.mmbase.util.functions.Parameters, org.mmbase.util.functions.Parameters).

Since:

MMBase-1.9

Version:

$Id$

Author:

Michiel Meeuwissen

Method Summary

Modifier and Type	Method and Description
Block	getBlock() Every processor processes for a certain block.
Parameter[]	getParameters() A processor may need certain parameters.
URI	getUri() An URI which may identify the implementation of this Renderer.
void	process(Parameters blockParameters) Process.

Method Detail

getBlock

Block getBlock()

Every processor processes for a certain block.

getParameters

Parameter[] getParameters()

A processor may need certain parameters. These are added to the block-parameters. This method is called on instantation of the processor.

process

void process(Parameters blockParameters)
      throws FrameworkException

Process. In case of e.g. a JSPProcessor, the parameters must also contain the Http Servlet response and request, besided specific parameters for this component.

Throws:

FrameworkException

getUri

URI getUri()

An URI which may identify the implementation of this Renderer.