KickJava   Java API By Example, From Geeks To Geeks.

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


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.Iterator JavaDoc;
60
61 import org.objectstyle.cayenne.map.DataMap;
62 import org.objectstyle.cayenne.map.MappingNamespace;
63 import org.objectstyle.cayenne.map.ObjEntity;
64 import org.objectstyle.cayenne.map.Relationship;
65
66 /**
67  * Attributes and Methods for working with ObjEntities.
68  *
69  * @since 1.2
70  * @author Mike Kienenberger
71  */
72 public class EntityUtils {
73
74     // template substitution values
75 protected String JavaDoc subClassName;
76     protected String JavaDoc superClassName;
77     protected String JavaDoc baseClassName;
78     protected String JavaDoc subPackageName;
79     protected String JavaDoc superPackageName;
80     protected String JavaDoc basePackageName;
81
82     protected DataMap primaryDataMap;
83     protected ObjEntity objEntity;
84     
85     public EntityUtils(DataMap dataMap, ObjEntity objEntity, String JavaDoc fqnBaseClass, String JavaDoc fqnSuperClass, String JavaDoc fqnSubClass)
86     {
87         super();
88         
89         StringUtils stringUtils = StringUtils.getInstance();
90         
91         this.baseClassName = stringUtils.stripPackageName(fqnBaseClass);
92         this.basePackageName = stringUtils.stripClass(fqnBaseClass);
93         this.superClassName = stringUtils.stripPackageName(fqnSuperClass);
94         this.superPackageName = stringUtils.stripClass(fqnSuperClass);
95         this.subClassName = stringUtils.stripPackageName(fqnSubClass);
96         this.subPackageName = stringUtils.stripClass(fqnSubClass);
97
98         this.primaryDataMap = dataMap;
99         
100         this.objEntity = objEntity;
101     }
102     
103     /**
104      * Returns class name (without a package) of the sub class associated with this
105      * generator.
106      */
107     public String JavaDoc getSubClassName() {
108         return subClassName;
109     }
110
111     /**
112      * Returns the super class (without a package) of the data object class
113      * associated with this generator
114      */
115     public String JavaDoc getSuperClassName() {
116         return superClassName;
117     }
118
119     /**
120      * Returns the base class (without a package) of the data object class
121      * associated with this generator. Class name must not include a package.
122      */
123     public String JavaDoc getBaseClassName() {
124         return baseClassName;
125     }
126
127     /**
128      * Returns Java package name of the class associated with this generator.
129      */
130     public String JavaDoc getSubPackageName() {
131         return subPackageName;
132     }
133
134     /**
135      * Returns <code>superPackageName</code> property that defines a
136      * superclass's package name.
137      */
138     public String JavaDoc getSuperPackageName() {
139         return superPackageName;
140     }
141
142     /**
143      * Returns <code>basePackageName</code> property that defines a
144      * baseclass's (superclass superclass) package name.
145      */
146     public String JavaDoc getBasePackageName() {
147         return basePackageName;
148     }
149
150     /**
151      * @return Returns the primary DataMap.
152      *
153      * @since 1.2
154      */
155     public DataMap getPrimaryDataMap() {
156         return primaryDataMap;
157     }
158
159     /**
160      * Returns the EntityResolver for this set of DataMaps.
161      *
162      * @since 1.2
163      */
164     public MappingNamespace getEntityResolver() {
165         return primaryDataMap.getNamespace();
166     }
167
168     /**
169      * Returns true if current ObjEntity contains at least one toMany relationship.
170      *
171      * @since 1.2
172      */
173     public boolean hasToManyRelationships() {
174         return hasToManyRelationships(objEntity);
175     }
176
177     /**
178      * Returns true if an ObjEntity contains at least one toMany relationship.
179      *
180      * @since 1.2
181      */
182     public boolean hasToManyRelationships(ObjEntity anObjEntity) {
183         if (anObjEntity == null) {
184             return false;
185         }
186         
187         Iterator JavaDoc it = anObjEntity.getRelationships().iterator();
188         while(it.hasNext()) {
189             Relationship r = (Relationship) it.next();
190             if(r.isToMany()) {
191                 return true;
192             }
193         }
194
195         return false;
196     }
197     
198     /**
199      * Returns true if current ObjEntity contains at least one toOne relationship.
200      *
201      * @since 1.2
202      */
203     public boolean hasToOneRelationships() {
204         return hasToOneRelationships(objEntity);
205     }
206     
207     /**
208      * Returns true if an ObjEntity contains at least one toOne relationship.
209      *
210      * @since 1.2
211      */
212     public boolean hasToOneRelationships(ObjEntity anObjEntity) {
213         if (anObjEntity == null) {
214             return false;
215         }
216         
217         Iterator JavaDoc it = anObjEntity.getRelationships().iterator();
218         while(it.hasNext()) {
219             Relationship r = (Relationship) it.next();
220             if(false == r.isToMany()) {
221                 return true;
222             }
223         }
224
225         return false;
226     }
227 }
Popular Tags