KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > sitemap > SitemapModelComponent


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.sitemap;
17
18 import org.apache.avalon.framework.component.Component;
19 import org.apache.avalon.framework.parameters.Parameters;
20 import org.apache.cocoon.ProcessingException;
21 import org.apache.cocoon.environment.SourceResolver;
22 import org.xml.sax.SAXException JavaDoc;
23
24 import java.io.IOException JavaDoc;
25 import java.util.Map JavaDoc;
26
27 /**
28  * This interface marks a component as a sitemap component that is used
29  * in the processing phase, like a generator, a transformer, a serializer
30  * or a reader.
31  *
32  * @author <a HREF="mailto:pier@apache.org">Pierpaolo Fumagalli</a>
33  * (Apache Software Foundation)
34  * @version CVS $Id: SitemapModelComponent.java 30932 2004-07-29 17:35:38Z vgritsenko $
35  */
36 public interface SitemapModelComponent extends Component {
37     /**
38      * Set the <code>SourceResolver</code>, objectModel <code>Map</code>,
39      * the source and sitemap <code>Parameters</code> used to process the request.
40      */
41     void setup(SourceResolver resolver, Map JavaDoc objectModel, String JavaDoc src, Parameters par)
42     throws ProcessingException, SAXException JavaDoc, IOException JavaDoc;
43 }
44
Popular Tags