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.portal.layout.renderer.aspect;
18:
19: import java.util.Iterator;
20:
21: import org.apache.avalon.framework.component.Component;
22: import org.apache.avalon.framework.parameters.ParameterException;
23: import org.apache.avalon.framework.parameters.Parameters;
24: import org.apache.cocoon.portal.PortalService;
25: import org.apache.cocoon.portal.layout.Layout;
26: import org.xml.sax.ContentHandler;
27: import org.xml.sax.SAXException;
28:
29: /**
30: * A renderer aspect extends a renderer with a distinct functionality.
31: * It can add a particular decoration like a border or buttons for example.
32: * A renderer aspect has to be thread safe!
33: *
34: * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
35: * @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
36: *
37: * @version CVS $Id: RendererAspect.java 433543 2006-08-22 06:22:54Z crossley $
38: */
39: public interface RendererAspect extends Component {
40:
41: String ROLE = RendererAspect.class.getName();
42:
43: /**
44: * Stream out raw layout
45: */
46: void toSAX(RendererAspectContext context, Layout layout,
47: PortalService service, ContentHandler handler)
48: throws SAXException;
49:
50: /**
51: * Return the aspects required for this renderer
52: * @return An iterator for the aspect descriptions or null.
53: */
54: Iterator getAspectDescriptions(Object preparedConfiguration);
55:
56: /**
57: * Compile the configuration.
58: * A renderer aspect can "compile" the configuration in
59: * order to increase performance.
60: * If the renderer does not want to compile it should
61: * simply return the configuration.
62: * The "compiled" configuration is passed to the
63: * {@link #getAspectDescriptions(Object)} method and
64: * is available during streaming via the context object.
65: * This method can also be used for validation the configuration.
66: */
67: Object prepareConfiguration(Parameters configuration)
68: throws ParameterException;
69:
70: boolean isRequired();
71: }
|