JavaTypeWriter


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.toJava;
56  
57  import org.jboss.axis.wsdl.gen.Generator;
58  import org.jboss.axis.wsdl.symbolTable.SchemaUtils;
59  import org.jboss.axis.wsdl.symbolTable.SymTabEntry;
60  import org.jboss.axis.wsdl.symbolTable.SymbolTable;
61  import org.jboss.axis.wsdl.symbolTable.TypeEntry;
62  import org.w3c.dom.Node  ;
63  
64  import javax.xml.namespace.QName  ;
65  import java.io.IOException  ;
66  import java.util.Vector  ;
67  
68  /**
69   * This is Wsdl2java's Type Writer.  It writes the following files, as appropriate:
70   * <typeName>.java, <typeName>Holder.java.
71   */
72  public class JavaTypeWriter implements Generator
73  {
74     public static final String   HOLDER_IS_NEEDED = "Holder is needed";
75  
76     private Generator typeWriter = null;
77     private Generator holderWriter = null;
78  
79     /**
80      * Constructor.
81      */
82     public JavaTypeWriter(Emitter emitter,
83                           TypeEntry type,
84                           SymbolTable symbolTable)
85     {
86  
87        if (type.isReferenced() && !type.isOnlyLiteralReferenced())
88        {
89  
90           // Determine what sort of type this is and instantiate
91           // the appropriate Writer.
92           Node   node = type.getNode();
93  
94           // If it's an array, don't emit a class
95           if (!type.getName().endsWith("[]"))
96           {
97  
98              // Generate the proper class for either "complex" or "enumeration" types
99              Vector   v = Utils.getEnumerationBaseAndValues(node, symbolTable);
100             if (v != null)
101             {
102                typeWriter = getEnumTypeWriter(emitter, type, v);
103             }
104             else
105             {
106                TypeEntry base = SchemaUtils.getComplexElementExtensionBase(node, symbolTable);
107                if (base == null)
108                {
109                   QName   baseQName = SchemaUtils.getSimpleTypeBase(node);
110                   if (baseQName != null)
111                   {
112                      base = symbolTable.getType(baseQName);
113                   }
114                }
115 
116                typeWriter = getBeanWriter(emitter,
117                        type,
118                        SchemaUtils.getContainedElementDeclarations(node,
119                                symbolTable),
120                        base,
121                        SchemaUtils.getContainedAttributeTypes(node,
122                                symbolTable));
123             }
124          }
125 
126          // If the holder is needed (ie., something uses this type as an out or inout
127          // parameter), instantiate the holder writer.
128          if (holderIsNeeded(type))
129          {
130             holderWriter = getHolderWriter(emitter, type);
131          }
132       }
133    } // ctor
134 
135    /**
136     * Write all the service bindnigs:  service and testcase.
137     */
138    public void generate() throws IOException  
139    {
140       if (typeWriter != null)
141       {
142          typeWriter.generate();
143       }
144       if (holderWriter != null)
145       {
146          holderWriter.generate();
147       }
148    } // generate
149 
150    /**
151     * Does anything use this type as an inout/out parameter?  Query the Type dynamicVar
152     */
153    private boolean holderIsNeeded(SymTabEntry entry)
154    {
155       Boolean   holderIsNeeded =
156               (Boolean  )entry.getDynamicVar(HOLDER_IS_NEEDED);
157       return (holderIsNeeded != null && holderIsNeeded.booleanValue());
158    } // holderIsNeeded
159 
160    /**
161     * getEnumWriter
162     */
163    protected JavaWriter getEnumTypeWriter(Emitter emitter, TypeEntry type, Vector   v)
164    {
165       return new JavaEnumTypeWriter(emitter, type, v);
166    }
167 
168    /**
169     * getBeanWriter
170     */
171    protected JavaWriter getBeanWriter(Emitter emitter, TypeEntry type,
172                                       Vector   elements, TypeEntry base,
173                                       Vector   attributes)
174    {
175       JavaWriter helperWriter = getBeanHelperWriter(emitter, type, elements, base,
176               attributes);
177       // If this complexType is referenced in a
178       // fault context, emit a bean-like exception
179       // class
180       Boolean   isComplexFault = (Boolean  )
181               type.getDynamicVar(JavaGeneratorFactory.COMPLEX_TYPE_FAULT);
182       if (isComplexFault != null &&
183               isComplexFault.booleanValue())
184       {
185          return new JavaBeanFaultWriter(emitter, type,
186                  elements, base, attributes,
187                  helperWriter);
188       }
189       return new JavaBeanWriter(emitter, type,
190               elements, base, attributes,
191               helperWriter);
192    }
193 
194    /**
195     * getHelperWriter
196     */
197    protected JavaWriter getBeanHelperWriter(Emitter emitter, TypeEntry type,
198                                             Vector   elements, TypeEntry base,
199                                             Vector   attributes)
200    {
201       return new JavaBeanHelperWriter(emitter, type, elements, base, attributes);
202    }
203 
204    /**
205     * getHolderWriter
206     */
207    protected Generator getHolderWriter(Emitter emitter, TypeEntry type)
208    {
209       return new JavaHolderWriter(emitter, type);
210    }
211 } // class JavaTypeWriter
212
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags