KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > project > validator > ObjEntityValidator


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 package org.objectstyle.cayenne.project.validator;
57
58 import java.util.Iterator JavaDoc;
59
60 import org.objectstyle.cayenne.map.DataMap;
61 import org.objectstyle.cayenne.map.ObjEntity;
62 import org.objectstyle.cayenne.project.ProjectPath;
63 import org.objectstyle.cayenne.util.Util;
64
65 /**
66  * @author Andrei Adamchik
67  */
68 public class ObjEntityValidator extends TreeNodeValidator {
69
70     /**
71      * Constructor for ObjEntityValidator.
72      */
73     public ObjEntityValidator() {
74         super();
75     }
76
77     public void validateObject(ProjectPath path, Validator validator) {
78         ObjEntity ent = (ObjEntity) path.getObject();
79         validateName(ent, path, validator);
80         validateClassName(ent, path, validator);
81         validateSuperClassName(ent, path, validator);
82
83         // validate DbEntity presence
84 if (ent.getDbEntity() == null) {
85             validator.registerWarning("ObjEntity has no DbEntity mapping.", path);
86         }
87     }
88
89     private void validateClassName(ObjEntity ent, ProjectPath path, Validator validator) {
90         String JavaDoc className = ent.getClassName();
91
92         if (Util.isEmptyString(className)) {
93             validator.registerWarning("ObjEntity has no Java class mapped.", path);
94             return;
95         }
96
97         MappingNamesHelper helper = MappingNamesHelper.getInstance();
98         String JavaDoc invalidChars = helper.invalidCharsInJavaClassName(className);
99
100         if (invalidChars != null) {
101             validator.registerWarning(
102                     "ObjEntity Java class contains invalid characters: " + invalidChars,
103                     path);
104         }
105         else if (helper.invalidDataObjectClass(className)) {
106             validator.registerWarning(
107                     "ObjEntity Java class is invalid: " + className,
108                     path);
109         }
110
111         DataMap map = (DataMap) path.getObjectParent();
112         if (map == null) {
113             return;
114         }
115
116         // check for duplicate class names in the parent context
117 Iterator JavaDoc it = map.getObjEntities().iterator();
118         while (it.hasNext()) {
119             ObjEntity otherEnt = (ObjEntity) it.next();
120             if (otherEnt == ent) {
121                 continue;
122             }
123
124             if (className.equals(otherEnt.getClassName())) {
125                 validator.registerWarning("Duplicate ObjEntity class name: "
126                         + className
127                         + ".", path);
128                 break;
129             }
130         }
131     }
132
133     private void validateSuperClassName(
134             ObjEntity ent,
135             ProjectPath path,
136             Validator validator) {
137         String JavaDoc superClassName = ent.getSuperClassName();
138
139         if (Util.isEmptyString(superClassName)) {
140             return; // null is Ok
141 }
142
143         MappingNamesHelper helper = MappingNamesHelper.getInstance();
144         String JavaDoc invalidChars = helper.invalidCharsInJavaClassName(superClassName);
145
146         if (invalidChars != null) {
147             validator.registerWarning(
148                     "ObjEntity Java superclass contains invalid characters: "
149                             + invalidChars,
150                     path);
151         }
152         else if (helper.invalidDataObjectClass(superClassName)) {
153             validator.registerWarning("ObjEntity Java superclass is invalid: "
154                     + superClassName, path);
155         }
156
157         DataMap map = (DataMap) path.getObjectParent();
158         if (map == null) {
159             return;
160         }
161     }
162
163     protected void validateName(ObjEntity ent, ProjectPath path, Validator validator) {
164         String JavaDoc name = ent.getName();
165
166         // Must have name
167 if (Util.isEmptyString(name)) {
168             validator.registerError("Unnamed ObjEntity.", path);
169             return;
170         }
171
172         DataMap map = (DataMap) path.getObjectParent();
173         if (map == null) {
174             return;
175         }
176
177         // check for duplicate names in the parent context
178 Iterator JavaDoc it = map.getObjEntities().iterator();
179         while (it.hasNext()) {
180             ObjEntity otherEnt = (ObjEntity) it.next();
181             if (otherEnt == ent) {
182                 continue;
183             }
184
185             if (name.equals(otherEnt.getName())) {
186                 validator.registerError("Duplicate ObjEntity name: " + name + ".", path);
187                 break;
188             }
189         }
190     }
191 }
Popular Tags