01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.webapps.portal.components;
18:
19: import java.util.Map;
20:
21: import org.xml.sax.ContentHandler;
22: import org.xml.sax.ext.LexicalHandler;
23: import org.xml.sax.SAXException;
24: import org.apache.excalibur.source.SourceParameters;
25: import org.apache.cocoon.ProcessingException;
26:
27: /**
28: * The coplet interface
29: *
30: * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
31: * @version CVS $Id: Coplet.java 433543 2006-08-22 06:22:54Z crossley $
32: */
33: public interface Coplet {
34:
35: /**
36: * This will be called before execute() is called. Should really
37: * only be called when the coplet is loaded (caching).
38: *
39: */
40: boolean init(Map objectModel, SourceParameters parameters)
41: throws ProcessingException;
42:
43: /**
44: * Should stream the content to the consumer.
45: * The content must be inside a <content> node!
46: * If no content is provided (e.g. if size is min)
47: * than no <content> node should be generated!
48: */
49: void execute(ContentHandler contentHandler,
50: LexicalHandler lexicalHandler, Map objectModel,
51: SourceParameters parameters) throws SAXException,
52: ProcessingException;
53: }
|