KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > wsdl > gen > GeneratorFactory


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55 package org.jboss.axis.wsdl.gen;
56
57 import org.jboss.axis.wsdl.symbolTable.BaseTypeMapping;
58 import org.jboss.axis.wsdl.symbolTable.SymbolTable;
59 import org.jboss.axis.wsdl.symbolTable.TypeEntry;
60
61 import javax.wsdl.Binding;
62 import javax.wsdl.Definition;
63 import javax.wsdl.Message;
64 import javax.wsdl.PortType;
65 import javax.wsdl.Service;
66
67 /**
68  * Generator and Generatoractory are part of the generator framework.
69  * Folks who want to use the emitter to generate stuff from WSDL should
70  * do 3 things:
71  * 1. Write implementations of the Generator interface, one each fo
72  * Message, PortType, Binding, Service, and Type. These
73  * implementations generate the stuff for each of these WSDL types.
74  * 2. Write an implementation of the GeneratorFactory interface that
75  * returns instantiations of these Generator implementations as
76  * appropriate.
77  * 3. Implement a class with a main method (like WSDL2Java) that
78  * instantiates an Emitter and passes it the GeneratorFactory
79  * implementation.
80  */
81
82 public interface GeneratorFactory
83 {
84    /**
85     * Allow the Generator extension to make a pass through the
86     * symbol table doing any pre-generation logic, like creating
87     * the Java names for each object and constructing signature
88     * strings.
89     */
90    public void generatorPass(Definition def, SymbolTable symbolTable);
91
92    /**
93     * Get a Generator implementation that will generate bindings for the given Message.
94     */
95    public Generator getGenerator(Message message, SymbolTable symbolTable);
96
97    /**
98     * Get a Generator implementation that will generate bindings for the given PortType.
99     */
100    public Generator getGenerator(PortType portType, SymbolTable symbolTable);
101
102    /**
103     * Get a Generator implementation that will generate bindings for the given Binding.
104     */
105    public Generator getGenerator(Binding binding, SymbolTable symbolTable);
106
107    /**
108     * Get a Generator implementation that will generate bindings for the given Service.
109     */
110    public Generator getGenerator(Service service, SymbolTable symbolTable);
111
112    /**
113     * Get a Generator implementation that will generate bindings for the given Type.
114     */
115    public Generator getGenerator(TypeEntry type, SymbolTable symbolTable);
116
117    /**
118     * Get a Generator implementation that will generate anything that doesn't
119     * fit into the scope of any of the other Generators.
120     */
121    public Generator getGenerator(Definition definition, SymbolTable symbolTable);
122
123    /**
124     * Get TypeMapping to use for translating
125     * QNames to base types
126     */
127    public void setBaseTypeMapping(BaseTypeMapping btm);
128
129    public BaseTypeMapping getBaseTypeMapping();
130
131 }
132
Popular Tags