Java > Open Source Codes > com > sun > jdo > spi > persistence > support > ejb > ejbc > CMPTemplateFormatter


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24
25
26 /*
27  * CMPTemplateFormatter.java
28  *
29  * Created on December 03, 2001
30  */
31
32 package com.sun.jdo.spi.persistence.support.ejb.ejbc;
33
34 import java.io.*;
35
36 import java.text.MessageFormat ;
37 import java.util.HashMap ;
38 import java.util.Properties ;
39 import java.util.StringTokenizer ;
40
41 import com.sun.jdo.spi.persistence.utility.generator.JavaClassWriterHelper;
42
43 /*
44  * This is the helper class for JDO specific generation of
45  * a concrete bean implementation.
46  *
47  * @author Marina Vatkina
48  */
49 public class CMPTemplateFormatter extends JavaClassWriterHelper{
50
51     private final static String templateFile =
52         "com/sun/jdo/spi/persistence/support/ejb/ejbc/CMPTemplates.properties"; // NOI18N
53
54     // Strings for CMP code generation:
55 public final static String ejb_ = "ejb"; // NOI18N
56 public final static String ejbObject_ = "EJBObject"; // NOI18N
57 public final static String ejbHome_ = "EJBHome"; // NOI18N
58 public final static String ejbContext_ = "EJBContext"; // NOI18N
59 public final static String context_ = "context"; // NOI18N
60 public final static String key_ = "key"; // NOI18N
61 public final static String keys_ = "keys"; // NOI18N
62 public final static String oid_ = "jdoObjectId"; // NOI18N
63 public final static String oids_ = "oids"; // NOI18N
64 public final static String pc_ = "pc"; // NOI18N
65 public final static String cmpImplComments_ = "cmpImplComments"; // NOI18N
66 public final static String imports_ = "imports"; // NOI18N
67 public final static String interfaces_ = "interfaces"; // NOI18N
68 public final static String helperImports_ = "helperImports"; // NOI18N
69 public final static String staticTransientPackageVariables_ = "staticTransientPackageVariables"; // NOI18N
70 public final static String privateStaticVariables_ = "privateStaticVariables"; // NOI18N
71 public final static String privateTransientVariables_ = "privateTransientVariables"; // NOI18N
72 public final static String privateStaticFinalVariables_ = "privateStaticFinalVariables"; // NOI18N
73 public final static String publicStaticFinalVariables_ = "publicStaticFinalVariables"; // NOI18N
74 public final static String finderSelectorStaticVariables_ = "finderSelectorStaticVariables"; // NOI18N
75 public final static String finderSelectorStaticFinalVariables_ = "finderSelectorStaticFinalVariables"; // NOI18N
76 public final static String otherVariables_ = "otherVariables"; // NOI18N
77 public final static String setNull_ = "setNull"; // NOI18N
78 public final static String commonPrivateMethods_ = "commonPrivateMethods"; // NOI18N
79 public final static String commonPublicMethods_ = "commonPublicMethods"; // NOI18N
80 public final static String otherPublicMethods_ = "otherPublicMethods"; // NOI18N
81 public final static String jdoLookupPersistenceManagerFactory_
82                                                           = "jdoLookupPersistenceManagerFactory"; // NOI18N
83 public final static String helperMethods_ = "helperMethods"; // NOI18N
84 public final static String getInstance_ = "jdoGetInstance"; // NOI18N
85 public final static String findByPrimaryKey_ = "findByPrimaryKey"; // NOI18N
86 public final static String ejbFindByPrimaryKey_ = "ejbFindByPrimaryKey"; // NOI18N
87 public final static String ejbFinderSelectorBody_ = "ejbFinderSelectorBody"; // NOI18N
88 public final static String ejbQueryExecutionParamConvBody_ = "ejbQueryExecutionParamConvBody"; // NOI18N
89 public final static String ejbQueryExecutionParamConvBodyArgument_ = "ejbQueryExecutionParamConvBodyArgument"; // NOI18N
90 public final static String ejbQueryExecutionBody_ = "ejbQueryExecutionBody"; // NOI18N
91 public final static String ejbAggregateQueryExecutionBody_ = "ejbAggregateQueryExecutionBody"; // NOI18N
92 public final static String ejbAggregateQueryExecutionParamConvBody_ = "ejbAggregateQueryExecutionParamConvBody"; // NOI18N
93 public final static String ejbMultiFinderBody_ = "ejbMultiFinderBody"; // NOI18N
94 public final static String ejbMultiFinderBodyEnumeration_ = "ejbMultiFinderBodyEnumeration"; // NOI18N
95 public final static String ejbSingleFinderBody_ = "ejbSingleFinderBody"; // NOI18N
96 public final static String jdoGetJdoInstanceClass_ = "jdoGetJdoInstanceClass"; // NOI18N
97 public final static String find_ = "find"; // NOI18N
98 public final static String catchClause_ = "catchClause"; //NOI18N
99 public final static String ejbSelect_ = "ejbSelect"; // NOI18N
100 public final static String create_ = "create"; // NOI18N
101 public final static String remove_ = "remove"; // NOI18N
102 public final static String ejbCreate_ = "ejbCreate"; // NOI18N
103 public final static String ejbCreateUnknownPK_ = "ejbCreateUnknownPK"; // NOI18N
104 public final static String ejbPostCreate_ = "ejbPostCreate"; // NOI18N
105 public final static String ejbRemove_ = "ejbRemove"; // NOI18N
106 public final static String ejbLoad_ = "ejbLoad"; // NOI18N
107 public final static String CreateException_ = "javax.ejb.CreateException"; // NOI18N
108 public final static String DuplicateKeyException_ = "javax.ejb.DuplicateKeyException"; // NOI18N
109 public final static String RemoveException_ = "javax.ejb.RemoveException"; // NOI18N
110 public final static String ejbException_ = "EJBException"; // NOI18N
111 public final static String finderException_ = "javax.ejb.FinderException"; // NOI18N
112 public final static String assertInTransaction_ = "assertInTransaction"; // NOI18N
113 public final static String assertPersistenceManagerIsNull_
114                                                           = "assertPersistenceManagerIsNull"; // NOI18N
115 public final static String assertPersistenceManagerIsNullCall_
116                                                           = "assertPersistenceManagerIsNullCall"; // NOI18N
117 public final static String setEntityContext_ = "setEntityContext"; // NOI18N
118 public final static String EntityContext_ = "javax.ejb.EntityContext"; // NOI18N
119 public final static String castKey_ = "castKey"; // NOI18N
120 public final static String castOid_ = "castOid"; // NOI18N
121 public final static String getPK_ = "getPK"; // NOI18N
122 public final static String getPKClone_ = "getPKClone"; // NOI18N
123 public final static String newPK_ = "newPK"; // NOI18N
124 public final static String newOid_ = "newOid"; // NOI18N
125 public final static String getPK1_ = "getPK1"; // NOI18N
126 public final static String getPK1Clone_ = "getPK1Clone"; // NOI18N
127 public final static String getPK1primitive_ = "getPK1primitive"; // NOI18N
128 public final static String getOid_ = "getOid"; // NOI18N
129 public final static String getOidString_ = "getOidString"; // NOI18N
130 public final static String getOidClone_ = "getOidClone"; // NOI18N
131 public final static String getOid1_ = "getOid1"; // NOI18N
132 public final static String getOid1primitive_ = "getOid1primitive"; // NOI18N
133 public final static String getOid1String_ = "getOid1String"; // NOI18N
134 public final static String getOid1Clone_ = "getOid1Clone"; // NOI18N
135 public final static String getObjectId_ = "jdoGetObjectId"; // NOI18N
136 public final static String convertObjectIdToPrimaryKey_
137                                      = "convertObjectIdToPrimaryKey"; // NOI18N
138 public final static String convertPrimaryKeyToObjectId_
139                                      = "convertPrimaryKeyToObjectId"; // NOI18N
140
141     public final static String convertPCToEJBObject_ = "convertPCToEJBObject"; // NOI18N
142 public final static String convertEJBObjectToPC_ = "convertEJBObjectToPC"; // NOI18N
143 public final static String convertEJBLocalObjectToPC_
144                                      = "convertEJBLocalObjectToPC"; // NOI18N
145
146     public final static String jdoPersistenceManager_ = "_jdoPersistenceManager"; // NOI18N
147 public final static String jdoPersistenceManagerClass_
148                                      = "com.sun.jdo.api.persistence.support.PersistenceManager"; // NOI18N
149 public final static String jdoGetPersistenceManager_ = "jdoGetPersistenceManager"; // NOI18N
150 public final static String jdoClosePersistenceManager_= "jdoClosePersistenceManager"; // NOI18N
151 public final static String jdoReleasePersistenceManager_
152                                      = "jdoReleasePersistenceManager"; // NOI18N
153
154     public final static String jdoArrayCopy_ = "jdoArrayCopy"; // NOI18N
155 public final static String jdoCleanAllRefs_ = "jdoCleanAllRefs"; // NOI18N
156 public final static String returnKey_ = "return key;"; // NOI18N
157 public final static String returnOid_ = "return jdoObjectId;"; // NOI18N
158
159     // Inner helper Class strings.
160 public final static String helperComments_ = "helperComments"; // NOI18N
161 public final static String helperVariables_ = "helperVariables"; // NOI18N
162 public final static String getHelperInstance_ = "getHelperInstance"; // NOI18N
163
164     public final static String getPCClass_ = "getPCClass"; // NOI18N
165 public final static String getContainer_ = "getContainer"; // NOI18N
166 public final static String assertInstanceOfRemoteInterfaceImpl_
167                                                           = "assertInstanceOfRemoteInterfaceImpl"; // NOI18N
168 public final static String assertPKNotNull_ = "assertPKNotNull"; // NOI18N
169 public final static String assertPKFieldNotNull_ = "assertPKFieldNotNull"; // NOI18N
170 public final static String assertOidNotNull_ = "assertOidNotNull"; // NOI18N
171 public final static String afterCompletion_ = "afterCompletion"; // NOI18N
172 public final static String ejb__flush_ = "ejb__flush"; // NOI18N
173 public final static String ejb__refresh_ = "ejb__refresh"; // NOI18N
174 public final static String ejb__remove_ = "ejb__remove"; // NOI18N
175
176     // property key for the CVS keyword substitution
177 public final static String signature_ = "signature"; //NOI18N
178
179     public final static String signatureDelimiter_ = " ## "; //NOI18N
180
181     // Code generator templates.
182 public static Properties helpers = null;
183
184     // JDOHelper comments have the concrete impl name.
185 public static MessageFormat hcomformatter = null;
186
187     // variables
188 public static MessageFormat privatetransientvformatter = null; // private transient varibales
189 public static MessageFormat privatestaticfinalvformatter = null; // final static variables
190 public static MessageFormat publicstaticfinalvformatter = null; // static final variables
191 public static MessageFormat finderselectorstaticvformatter = null; // finder / selector static variables
192 public static MessageFormat finderselectorstaticfinalvformatter = null; // finder / selector static final variables
193 public static MessageFormat hvformatter = null; // helper class variables
194
195     // methods
196 public static MessageFormat giformatter = null; // jdoGetInstance
197 public static MessageFormat goidformatter = null; // jdoGetObjectId
198 public static MessageFormat intxformatter = null; // assertInTransaction
199 public static MessageFormat jdolookuppmfformatter = null; // jdoLookupPersistenceManagerFactory
200 public static MessageFormat jdoarraycopyformatter = null; // jdoCopyArray
201
202     // finder/selector methods
203 public static MessageFormat finderselectorformatter = null; //common body for selector and finder
204 public static MessageFormat queryexecformatter = null; //body for queryexec without paramconversion
205 public static MessageFormat aggqueryexecformatter = null; //body for aggqueryexec without paramconversion
206 public static MessageFormat queryexecparamconvformatter = null; //body for queryexec with paramconversion
207 public static MessageFormat queryexecparamconvargumentformatter = null; //body for the argument of the queryexec with paramconversion
208 public static MessageFormat aggqueryexecparamconvformatter = null; //body for aggqueryexec with paramconversion
209 public static MessageFormat multifinderformatter = null; // finder body for multi-value-objects
210 public static MessageFormat multifinderenumerationformatter = null; // finder body for multi-value-objects with conversion to Enumeration (CMP11))
211 public static MessageFormat singlefinderformatter = null; // finder body for single-value-objects
212
213     // PK and Oid handling
214 public static MessageFormat pkcformatter = null; // cast PK statement
215 public static MessageFormat oidcformatter = null; // cast Oid statement
216 public static MessageFormat npkformatter = null; // new PK statement
217 public static MessageFormat noidformatter = null; // new Oid statement
218 public static MessageFormat pkformatter = null;
219     public static MessageFormat oidformatter = null;
220     public static MessageFormat oidstringformatter = null; // PK -> Oid for String PK field
221 public static MessageFormat pkcloneformatter = null; // Oid -> PK for mutable PK field
222 public static MessageFormat oidcloneformatter = null; // PK -> Oid for mutable PK field
223 public static MessageFormat pk1formatter = null;
224     public static MessageFormat oid1formatter = null;
225     public static MessageFormat pk1pformatter = null;
226     public static MessageFormat oid1pformatter = null;
227     public static MessageFormat oid1stringformatter = null; // PK -> Oid for String PK class
228 public static MessageFormat pk1cloneformatter = null; // Oid -> PK for mutable PK class
229 public static MessageFormat oid1cloneformatter = null; // PK -> Oid for mutable PK class
230 public static MessageFormat assertpkfieldformatter = null; // for assertPKFieldNotNull_
231
232     // Other JDOHelper methods.
233 public static MessageFormat pcclassgetterformatter = null;
234
235     // standard templates for the corresponding keys, so that a template "xxxTemplate"
236 // corresponds to a "xxx" key.
237 public static String cmpImplCommentsTemplate = null;
238     public static String privateStaticVariablesTemplate = null;
239     public static String otherVariablesTemplate = null;
240     public static String jdoGetJdoInstanceClassTemplate = null;
241     public static String assertPersistenceManagerIsNullTemplate = null;
242     public static String assertInstanceOfRemoteInterfaceImplTemplate = null;
243     public static String getHelperInstanceTemplate = null;
244     public static String catchClauseTemplate = null;
245     public static String signatureTemplate = null;
246     public static String assertPKNotNullTemplate = null;
247     public static String assertOidNotNullTemplate = null;
248
249     // standard templates that had been converted to String[] to be used
250 // in a 'for' loop.
251 public static String [] importsArray = null;
252     public static String [] interfacesArray = null;
253     public static String [] helperImportsArray = null;
254     public static String [] commonPublicMethodsArray = null;
255     public static String [] otherPublicMethodsArray = null;
256     public static String [] commonPrivateMethodsArray = null;
257
258
259     // standard method bodies for the corresponding keys, so that a method body with
260 // a name "xxxBody" corresponds to a "xxx" key.
261 public static String [] ejbFindByPrimaryKeyBody = null;
262     public static String [] afterCompletionBody = null;
263     public static String [] jdoGetPersistenceManagerBody = null;
264     public static String [] assertPersistenceManagerIsNullBody = null;
265     public static String [] jdoClosePersistenceManagerBody = null;
266     public static String [] jdoReleasePersistenceManagerBody = null;
267     public static String [] setEntityContextBody = null;
268     public static String [] getContainerBody = null;
269
270     /**
271      * Constructs a new <code>CMPTemplateFormatter</code> instance.
272      */
273     CMPTemplateFormatter() {
274     }
275
276     /**
277      * Initializes templates for code generation.
278      */
279     static synchronized void initHelpers() throws IOException {
280         if (helpers == null) {
281             helpers = new Properties ();
282             loadProperties(helpers, templateFile);
283             initFormatters();
284             initTemplates();
285         }
286     }
287
288     /**
289      * Loads Properties object from the specified template file.
290      */
291     static synchronized void loadProperties(Properties helpers,
292             final String templateFile) throws IOException {
293
294         BufferedInputStream bin = null;
295         try {
296             final ClassLoader loader = CMPTemplateFormatter.class.getClassLoader();
297             InputStream in = (InputStream)java.security.AccessController.doPrivileged(
298                 new java.security.PrivilegedAction () {
299                     public Object run() {
300                         if (loader != null) {
301                             return loader.getResourceAsStream(templateFile);
302                         } else {
303                             return ClassLoader.getSystemResourceAsStream(templateFile);
304                         }
305                     }
306                 }
307             );
308
309             bin = new BufferedInputStream(in);
310             helpers.load(bin);
311         } finally {
312             try {
313                 bin.close();
314             } catch (Exception e) {
315                 // no action
316 }
317         }
318     }
319
320     /**
321      * Initializes MessageFormats for code generation.
322      */
323     private static void initFormatters() {
324         // JDOHelper comments have the concrete impl name.
325 hcomformatter = new MessageFormat (helpers.getProperty(helperComments_));
326
327         // variables
328 privatetransientvformatter = new MessageFormat (helpers.getProperty(privateTransientVariables_));
329         privatestaticfinalvformatter = new MessageFormat (helpers.getProperty(privateStaticFinalVariables_));
330         publicstaticfinalvformatter = new MessageFormat (helpers.getProperty(publicStaticFinalVariables_));
331         finderselectorstaticvformatter = new MessageFormat (helpers.getProperty(finderSelectorStaticVariables_));
332         finderselectorstaticfinalvformatter = new MessageFormat (helpers.getProperty(finderSelectorStaticFinalVariables_));
333         hvformatter = new MessageFormat (helpers.getProperty(helperVariables_));
334
335         // methods
336 giformatter = new MessageFormat (helpers.getProperty(getInstance_));
337         goidformatter = new MessageFormat (helpers.getProperty(getObjectId_));
338         intxformatter = new MessageFormat (helpers.getProperty(assertInTransaction_));
339         jdolookuppmfformatter = new MessageFormat (helpers.getProperty(jdoLookupPersistenceManagerFactory_));
340         jdoarraycopyformatter = new MessageFormat (helpers.getProperty(jdoArrayCopy_));
341
342         // finder/selector methods
343 finderselectorformatter = new MessageFormat (helpers.getProperty(ejbFinderSelectorBody_));
344         queryexecparamconvformatter = new MessageFormat (helpers.getProperty(ejbQueryExecutionParamConvBody_));
345         queryexecparamconvargumentformatter = new MessageFormat (helpers.getProperty(ejbQueryExecutionParamConvBodyArgument_));
346         queryexecformatter = new MessageFormat (helpers.getProperty(ejbQueryExecutionBody_));
347         aggqueryexecformatter = new MessageFormat (helpers.getProperty(ejbAggregateQueryExecutionBody_));
348         aggqueryexecparamconvformatter = new MessageFormat (helpers.getProperty(ejbAggregateQueryExecutionParamConvBody_));
349         multifinderformatter = new MessageFormat (helpers.getProperty(ejbMultiFinderBody_));
350         multifinderenumerationformatter = new MessageFormat (helpers.getProperty(ejbMultiFinderBodyEnumeration_));
351         singlefinderformatter = new MessageFormat (helpers.getProperty(ejbSingleFinderBody_));
352
353         // PK and Oid handling
354 pkcformatter = new MessageFormat (helpers.getProperty(castKey_));
355         oidcformatter = new MessageFormat (helpers.getProperty(castOid_));
356         npkformatter = new MessageFormat (helpers.getProperty(newPK_));
357         noidformatter = new MessageFormat (helpers.getProperty(newOid_));
358         pk1formatter = new MessageFormat (helpers.getProperty(getPK1_));
359         pk1cloneformatter = new MessageFormat (helpers.getProperty(getPK1Clone_));
360         oid1formatter = new MessageFormat (helpers.getProperty(getOid1_));
361         pk1pformatter = new MessageFormat (helpers.getProperty(getPK1primitive_));
362         oid1pformatter = new MessageFormat (helpers.getProperty(getOid1primitive_));
363         oid1stringformatter = new MessageFormat (helpers.getProperty(getOid1String_));
364         oid1cloneformatter = new MessageFormat (helpers.getProperty(getOid1Clone_));
365         pkformatter = new MessageFormat (helpers.getProperty(getPK_));
366         pkcloneformatter = new MessageFormat (helpers.getProperty(getPKClone_));
367         oidformatter = new MessageFormat (helpers.getProperty(getOid_));
368         oidstringformatter = new MessageFormat (helpers.getProperty(getOidString_));
369         oidcloneformatter = new MessageFormat (helpers.getProperty(getOidClone_));
370
371         assertpkfieldformatter = new MessageFormat (helpers.getProperty(assertPKFieldNotNull_));
372
373         // Other JDOHelper methods.
374 pcclassgetterformatter = new MessageFormat (helpers.getProperty(getPCClass_));
375
376     }
377
378     /**
379      * Initializes standard templates for code generation.
380      */
381     private static void initTemplates() {
382         cmpImplCommentsTemplate = helpers.getProperty(cmpImplComments_);
383         privateStaticVariablesTemplate = helpers.getProperty(privateStaticVariables_);
384         otherVariablesTemplate = helpers.getProperty(otherVariables_);
385         jdoGetJdoInstanceClassTemplate = helpers.getProperty(jdoGetJdoInstanceClass_);
386         assertPersistenceManagerIsNullTemplate = helpers.getProperty(
387             assertPersistenceManagerIsNullCall_);
388         assertInstanceOfRemoteInterfaceImplTemplate = helpers.getProperty(
389             assertInstanceOfRemoteInterfaceImpl_);
390         getHelperInstanceTemplate = helpers.getProperty(getHelperInstance_);
391         catchClauseTemplate = helpers.getProperty(catchClause_);
392         signatureTemplate = helpers.getProperty(signature_);
393         assertPKNotNullTemplate = helpers.getProperty(assertPKNotNull_);
394         assertOidNotNullTemplate = helpers.getProperty(assertOidNotNull_);
395
396         importsArray = tokenize(imports_);
397         interfacesArray = tokenize(interfaces_);
398         helperImportsArray = tokenize(helperImports_);
399         commonPublicMethodsArray = tokenize(commonPublicMethods_);
400         otherPublicMethodsArray = tokenize(otherPublicMethods_);
401         commonPrivateMethodsArray = tokenize(commonPrivateMethods_);
402
403         ejbFindByPrimaryKeyBody = getBodyAsStrings(helpers.getProperty(ejbFindByPrimaryKey_));
404         afterCompletionBody = getBodyAsStrings(helpers.getProperty(afterCompletion_));
405         jdoGetPersistenceManagerBody = getBodyAsStrings(helpers.getProperty(jdoGetPersistenceManager_));
406         jdoClosePersistenceManagerBody = getBodyAsStrings(helpers.getProperty(jdoClosePersistenceManager_));
407         jdoReleasePersistenceManagerBody = getBodyAsStrings(helpers.getProperty(jdoReleasePersistenceManager_));
408         setEntityContextBody = getBodyAsStrings(helpers.getProperty(setEntityContext_));
409         getContainerBody = getBodyAsStrings(helpers.getProperty(getContainer_));
410         assertPersistenceManagerIsNullBody = getBodyAsStrings(helpers.getProperty(assertPersistenceManagerIsNull_));
411     }
412
413     static String [] tokenize(String template) {
414         StringTokenizer st = new StringTokenizer (helpers.getProperty(template), delim_);
415         String [] rc = new String [st.countTokens()];
416
417         int i = 0;
418         while (st.hasMoreElements()) {
419             rc[i++] = st.nextToken();
420         }
421
422         return rc;
423     }
424 }
425

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags