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.generation;
18:
19: import org.apache.cocoon.ProcessingException;
20: import org.apache.cocoon.sitemap.SitemapModelComponent;
21: import org.apache.cocoon.xml.XMLProducer;
22: import org.xml.sax.SAXException;
23:
24: import java.io.IOException;
25:
26: /**
27: * A generator is the starting point of a pipeline. It "generates" XML
28: * and starts streaming them into the pipeline.
29: *
30: * @author <a href="mailto:pier@apache.org">Pierpaolo Fumagalli</a>
31: * (Apache Software Foundation)
32: * @version CVS $Id: Generator.java 433543 2006-08-22 06:22:54Z crossley $
33: */
34: public interface Generator extends XMLProducer, SitemapModelComponent {
35:
36: String ROLE = Generator.class.getName();
37:
38: /**
39: * Generate the XML and stream it into the pipeline
40: */
41: void generate() throws IOException, SAXException,
42: ProcessingException;
43: }
|