KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > gen > ImportUtils


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56
57 package org.objectstyle.cayenne.gen;
58
59 import java.util.ArrayList JavaDoc;
60 import java.util.Collections JavaDoc;
61 import java.util.Comparator JavaDoc;
62 import java.util.HashMap JavaDoc;
63 import java.util.Iterator JavaDoc;
64 import java.util.List JavaDoc;
65 import java.util.Map JavaDoc;
66
67 /**
68  * Methods for mangling strings.
69  *
70  * @author Mike Kienenberger
71  */
72 public class ImportUtils {
73
74     public static final String JavaDoc importOrdering[] = new String JavaDoc[] {
75         "java.", "javax.", "org.", "com." };
76
77 // public static final String primitiveTypes[] = new String[] {
78 // "long", "double", "byte", "boolean", "float", "short", "int" };
79
80     protected Map JavaDoc importTypesMap = new HashMap JavaDoc();
81     
82     protected String JavaDoc packageName;
83     
84     public ImportUtils()
85     {
86         super();
87     }
88     
89     public void addType(String JavaDoc typeName)
90     {
91         // Not sure why this would ever happen, but it did
92 if (null == typeName) return;
93         
94         StringUtils stringUtils = StringUtils.getInstance();
95         String JavaDoc typeClassName = stringUtils.stripPackageName(typeName);
96         String JavaDoc typePackageName = stringUtils.stripClass(typeName);
97         
98         if (typePackageName.length() == 0) return; // disallow non-packaged types (primatives, probably)
99 if ("java.lang".equals(typePackageName)) return;
100         if (packageName.equals(typePackageName)) return;
101         
102         // Can only have one type -- rest must use fqn
103 if (importTypesMap.containsKey(typeClassName)) return;
104         
105         importTypesMap.put(typeClassName, typeName);
106     }
107     
108     public void setPackage(String JavaDoc packageName)
109     {
110         this.packageName = packageName;
111     }
112     
113     /**
114      * Removes registered package and type name prefixes from java types
115      */
116     public String JavaDoc formatJavaType(String JavaDoc typeName) {
117         if (typeName != null) {
118             StringUtils stringUtils = StringUtils.getInstance();
119             String JavaDoc typeClassName = stringUtils.stripPackageName(typeName);
120             
121             if (importTypesMap.containsKey(typeClassName))
122             {
123                 if (typeName.equals(importTypesMap.get(typeClassName))) return typeClassName;
124             }
125             
126             String JavaDoc typePackageName = stringUtils.stripClass(typeName);
127             if ("java.lang".equals(typePackageName)) return typeClassName;
128             if (packageName.equals(typePackageName)) return typeClassName;
129         }
130
131         return typeName;
132     }
133     
134     public String JavaDoc generate()
135     {
136         StringBuffer JavaDoc outputBuffer = new StringBuffer JavaDoc();
137
138         if (null != packageName)
139         {
140             outputBuffer.append("package ");
141             outputBuffer.append(packageName);
142             outputBuffer.append(';');
143             outputBuffer.append(System.getProperty("line.separator"));
144             outputBuffer.append(System.getProperty("line.separator"));
145         }
146
147         List JavaDoc typesList = new ArrayList JavaDoc(importTypesMap.values());
148         Collections.sort(typesList, new Comparator JavaDoc() {
149
150             public boolean equals(Object JavaDoc obj) {
151                 return this.equals(obj);
152             }
153
154             public int compare(Object JavaDoc o1, Object JavaDoc o2) {
155                 
156                 String JavaDoc s1 = (String JavaDoc)o1;
157                 String JavaDoc s2 = (String JavaDoc)o2;
158                 
159                 for (int index = 0; index < importOrdering.length; index++) {
160                     String JavaDoc ordering = importOrdering[index];
161                     
162                     if ( (s1.startsWith(ordering)) && (!s2.startsWith(ordering)) )
163                         return -1;
164                     if ( (!s1.startsWith(ordering)) && (s2.startsWith(ordering)) )
165                         return 1;
166                 }
167                     
168                 return s1.compareTo(s2);
169             }
170         });
171         
172         String JavaDoc lastStringPrefix = null;
173         Iterator JavaDoc typesIterator = typesList.iterator();
174         while (typesIterator.hasNext()) {
175             String JavaDoc typeName = (String JavaDoc)typesIterator.next();
176
177             // Output another newline if we're in a different root package.
178 // Find root package
179 String JavaDoc thisStringPrefix = typeName;
180             int dotIndex = typeName.indexOf('.');
181             if (-1 != dotIndex)
182             {
183                 thisStringPrefix = typeName.substring(0, dotIndex);
184             }
185             // if this isn't the first import,
186 if (null != lastStringPrefix)
187             {
188                 // and it's different from the last import
189 if (false == thisStringPrefix.equals(lastStringPrefix))
190                 {
191                     // output a newline
192 outputBuffer.append(System.getProperty("line.separator"));
193                 }
194             }
195             lastStringPrefix = thisStringPrefix;
196
197             outputBuffer.append("import ");
198             outputBuffer.append(typeName);
199             outputBuffer.append(';');
200             if (typesIterator.hasNext())
201             {
202                 outputBuffer.append(System.getProperty("line.separator"));
203             }
204         }
205
206         return outputBuffer.toString();
207     }
208 }
Popular Tags