KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.util.List JavaDoc;
60
61 import org.objectstyle.cayenne.map.DbEntity;
62 import org.objectstyle.cayenne.map.DbJoin;
63 import org.objectstyle.cayenne.map.DbRelationship;
64 import org.objectstyle.cayenne.map.DeleteRule;
65 import org.objectstyle.cayenne.map.ObjEntity;
66 import org.objectstyle.cayenne.map.ObjRelationship;
67 import org.objectstyle.cayenne.project.ProjectPath;
68 import org.objectstyle.cayenne.util.Util;
69
70 /**
71  * @author Andrei Adamchik
72  */
73 public class ObjRelationshipValidator extends TreeNodeValidator {
74
75     /**
76      * Constructor for ObjRelationshipValidator.
77      */
78     public ObjRelationshipValidator() {
79         super();
80     }
81
82     public void validateObject(ProjectPath path, Validator validator) {
83         ObjRelationship rel = (ObjRelationship) path.getObject();
84
85         // skip validation of inherited relationships
86 if (path.getObjectParent() != null
87                 && path.getObjectParent() != rel.getSourceEntity()) {
88             return;
89         }
90
91         if (Util.isEmptyString(rel.getName())) {
92             validator.registerError("Unnamed ObjRelationship.", path);
93         }
94         // check if there are attributes having the same name
95 else if (rel.getSourceEntity().getAttribute(rel.getName()) != null) {
96             validator.registerWarning(
97                     "ObjRelationship " + objRelationshipIdentifier(rel) + " has the same name as one of ObjAttributes",
98                     path);
99         }
100         else {
101             MappingNamesHelper helper = MappingNamesHelper.getInstance();
102             String JavaDoc invalidChars = helper.invalidCharsInObjPathComponent(rel.getName());
103
104             if (invalidChars != null) {
105                 validator.registerWarning(
106                         "ObjRelationship " + objRelationshipIdentifier(rel) + " name contains invalid characters: "
107                                 + invalidChars,
108                         path);
109             }
110             else if (helper.invalidDataObjectProperty(rel.getName())) {
111                 validator.registerWarning("ObjRelationship " + objRelationshipIdentifier(rel) + " name is invalid.", path);
112             }
113         }
114
115         if (rel.getTargetEntity() == null) {
116             validator.registerWarning("ObjRelationship " + objRelationshipIdentifier(rel) + " has no target entity.", path);
117         }
118         else {
119             // check for missing DbRelationship mappings
120 List JavaDoc dbRels = rel.getDbRelationships();
121             if (dbRels.size() == 0) {
122                 validator.registerWarning(
123                         "ObjRelationship " + objRelationshipIdentifier(rel) + " has no DbRelationship mapping.",
124                         path);
125             }
126             else {
127                 DbEntity expectedSrc = ((ObjEntity) rel.getSourceEntity()).getDbEntity();
128                 DbEntity expectedTarget = ((ObjEntity) rel.getTargetEntity())
129                         .getDbEntity();
130
131                 if (((DbRelationship) dbRels.get(0)).getSourceEntity() != expectedSrc
132                         || ((DbRelationship) dbRels.get(dbRels.size() - 1))
133                                 .getTargetEntity() != expectedTarget) {
134                     validator.registerWarning(
135                             "ObjRelationship " + objRelationshipIdentifier(rel) + " has incomplete DbRelationship mapping.",
136                             path);
137                 }
138             }
139         }
140
141         //Disallow a Nullify delete rule where the relationship is toMany and the
142 //foreign key attributes are mandatory.
143 if (rel.isToMany()
144                 && !rel.isFlattened()
145                 && (rel.getDeleteRule() == DeleteRule.NULLIFY)) {
146             ObjRelationship inverse = rel.getReverseRelationship();
147             if (inverse != null) {
148                 DbRelationship firstRel = (DbRelationship) inverse
149                         .getDbRelationships()
150                         .get(0);
151                 Iterator JavaDoc attributePairIterator = firstRel.getJoins().iterator();
152                 while (attributePairIterator.hasNext()) {
153                     DbJoin pair = (DbJoin) attributePairIterator.next();
154                     if (pair.getSource().isMandatory()) {
155                         validator
156                                 .registerWarning(
157                                         "ObjRelationship " + objRelationshipIdentifier(rel) + " has a Nullify delete rule and a mandatory reverse relationship ",
158                                         path);
159                     }
160                 }
161             }
162         }
163     }
164     
165     public String JavaDoc objRelationshipIdentifier(ObjRelationship rel)
166     {
167         if (null == rel.getSourceEntity())
168         {
169             return "<[null source entity]." + rel.getName() + ">";
170         }
171         return "<" + rel.getSourceEntity().getName() + "." + rel.getName() + ">";
172     }
173 }
Popular Tags