KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > dataobjects > DataObjectFactory


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.core.dataobjects;
66
67 /**
68  * Constructs 'often' DataObjects based upon standard order of initialization
69  * and the interfaces it implements. For example, Defineable objects must
70  * have setDefinition() called first, then setDataContext(), then setUid()
71  *
72  * @author Michael Rimov
73  */
74
75 public final class DataObjectFactory {
76
77     private DataObjectFactory() {
78     }
79
80     /**
81      * Creates an object that doesn't implement Defineable.
82      *
83      * @param clazz Object class name
84      * @param dataContext Database context
85      * @param uid the user id that will be set if the object is Securable
86      * @return an instantiated and properly constructed object.
87      * @throws DataException upon error
88      */
89     public static Object JavaDoc createObject(Class JavaDoc clazz,
90                                       String JavaDoc dataContext, int uid)
91             throws DataException {
92         return DataObjectFactory.createObject(clazz, dataContext, null, uid);
93
94     }
95
96     /**
97      * Typesafe way of creating a data object that doesn't implement Defineable
98      *
99      * @param clazz Object class
100      * @param dataContext Database context
101      * @param uid the user id that will be set if the object is Securable
102      * @return an instantiated and properly constructed object.
103      * @throws DataException upon error
104      */
105     public static DataObject createDataObject(Class JavaDoc clazz,
106                                               String JavaDoc dataContext, int uid)
107             throws DataException {
108         return (DataObject) DataObjectFactory.createObject(clazz, dataContext, null, uid);
109     }
110
111
112     /**
113      * Typesafe way of creating a dataobject
114      *
115      * @param definition The definition to define the Defineable Object. If
116      * the object does not implement Defineable, this parameter may be null.
117      * @param clazz Object class
118      * @param dataContext Database context
119      * @param uid the user id that will be set if the object is Securable
120      * @return an instantiated and properly constructed DataObject.
121      * @throws DataException upon error
122      */
123     public static DataObject createDataObject(Class JavaDoc clazz, String JavaDoc dataContext,
124                                               String JavaDoc definition, int uid)
125             throws DataException {
126         return (DataObject) DataObjectFactory.createObject(clazz, dataContext, definition, uid);
127     }
128
129     /**
130      * Create an object given the class, datacontext, definition and uid.
131      *
132      * @param definition The definition to define the Defineable Object. If
133      * the object does not implement Defineable, this parameter may be null.
134      * @param clazz Object class
135      * @param dataContext Database context
136      * @param uid the user id that will be set if the object is Securable
137      * @return an instantiated and properly constructed object.
138      * @throws DataException upon error
139      */
140     public static Object JavaDoc createObject(Class JavaDoc clazz, String JavaDoc dataContext,
141                                       String JavaDoc definition, int uid)
142             throws DataException {
143         Object JavaDoc returnValue;
144         try {
145             returnValue = clazz.newInstance();
146         } catch (IllegalAccessException JavaDoc ex) {
147             throw new DataException("No default constructor for: "
148                     + clazz.getName(), ex);
149         } catch (InstantiationException JavaDoc ex) {
150             throw new DataException("Error creating new instance of "
151                     + clazz.getName(), ex);
152         }
153
154         if (returnValue instanceof Defineable) {
155             if (definition == null) {
156                 throw new IllegalArgumentException JavaDoc("Must have non-null " +
157                         "definition for Defineable objects!");
158             }
159
160             ((Defineable) returnValue).setDefinitionName(definition);
161         }
162
163         if (returnValue instanceof ContextNested) {
164             ((ContextNested) returnValue).setDataContext(dataContext);
165         }
166
167
168         if (returnValue instanceof Securable) {
169             ((Securable) returnValue).setRequestingUid(uid);
170         }
171
172         return returnValue;
173     }
174 }
Popular Tags