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.sitemap;
18:
19: import org.apache.avalon.framework.component.Component;
20: import org.apache.avalon.framework.parameters.Parameters;
21: import org.apache.cocoon.ProcessingException;
22: import org.apache.cocoon.environment.SourceResolver;
23: import org.xml.sax.SAXException;
24:
25: import java.io.IOException;
26: import java.util.Map;
27:
28: /**
29: * This interface marks a component as a sitemap component that is used
30: * in the processing phase, like a generator, a transformer, a serializer
31: * or a reader.
32: *
33: * @author <a href="mailto:pier@apache.org">Pierpaolo Fumagalli</a>
34: * (Apache Software Foundation)
35: * @version CVS $Id: SitemapModelComponent.java 433543 2006-08-22 06:22:54Z crossley $
36: */
37: public interface SitemapModelComponent extends Component {
38: /**
39: * Set the <code>SourceResolver</code>, objectModel <code>Map</code>,
40: * the source and sitemap <code>Parameters</code> used to process the request.
41: */
42: void setup(SourceResolver resolver, Map objectModel, String src,
43: Parameters par) throws ProcessingException, SAXException,
44: IOException;
45: }
|