org.apache.cocoon.webapps.portal.components
Interface Coplet

public interface Coplet

The coplet interface

Version:

CVS $Id: Coplet.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler

Method Summary

void	execute(ContentHandler contentHandler, LexicalHandler lexicalHandler, Map objectModel, SourceParameters parameters) Should stream the content to the consumer.
boolean	init(Map objectModel, SourceParameters parameters) This will be called before execute() is called.

Method Detail

init

boolean init(Map objectModel,
             SourceParameters parameters)
             throws ProcessingException

This will be called before execute() is called. Should really only be called when the coplet is loaded (caching).

Throws:

ProcessingException

execute

void execute(ContentHandler contentHandler,
             LexicalHandler lexicalHandler,
             Map objectModel,
             SourceParameters parameters)
             throws SAXException,
                    ProcessingException

Should stream the content to the consumer. The content must be inside a node! If no content is provided (e.g. if size is min) than no node should be generated!

Throws:

SAXException

ProcessingException