KickJava   Java API By Example, From Geeks To Geeks.

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


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.DbJoin;
61 import org.objectstyle.cayenne.map.DbRelationship;
62 import org.objectstyle.cayenne.project.ProjectPath;
63 import org.objectstyle.cayenne.util.Util;
64
65 /**
66  * @author Andrei Adamchik
67  */
68 public class DbRelationshipValidator extends TreeNodeValidator {
69
70     /**
71      * Constructor for DbRelationshipValidator.
72      */
73     public DbRelationshipValidator() {
74         super();
75     }
76
77     public void validateObject(ProjectPath path, Validator validator) {
78         DbRelationship rel = (DbRelationship) path.getObject();
79         if (rel.getTargetEntity() == null) {
80             validator.registerWarning("DbRelationship " + dbRelationshipIdentifier(rel) + " has no target entity.", path);
81         }
82         else if (rel.getJoins().size() == 0) {
83             validator.registerWarning("DbRelationship " + dbRelationshipIdentifier(rel) + " has no joins.", path);
84         }
85         else {
86             // validate joins
87 Iterator JavaDoc joins = rel.getJoins().iterator();
88             while (joins.hasNext()) {
89                 DbJoin join = (DbJoin) joins.next();
90                 if (join.getSource() == null && join.getTarget() == null) {
91                     validator
92                             .registerWarning(
93                                     "DbRelationship " + dbRelationshipIdentifier(rel) + " join has no source and target attributes selected.",
94                                     path);
95                 }
96                 else if (join.getSource() == null) {
97                     validator.registerWarning(
98                             "DbRelationship " + dbRelationshipIdentifier(rel) + " join has no source attribute selected.",
99                             path);
100                 }
101                 else if (join.getTarget() == null) {
102                     validator.registerWarning(
103                             "DbRelationship " + dbRelationshipIdentifier(rel) + " join has no target attribute selected.",
104                             path);
105                 }
106             }
107
108             // validate reverse
109 if (rel.getReverseRelationship() == null) {
110                 validator
111                         .registerWarning(
112                                 "Missing reverse DbRelationship " + dbRelationshipIdentifier(rel) + " (currently required by Cayenne).",
113                                 path);
114             }
115         }
116
117         if (Util.isEmptyString(rel.getName())) {
118             validator.registerError("Unnamed DbRelationship.", path);
119         }
120         // check if there are attributes having the same name
121 else if (rel.getSourceEntity().getAttribute(rel.getName()) != null) {
122             validator.registerWarning(
123                     "DbRelationship " + dbRelationshipIdentifier(rel) + " has the same name as one of DbAttributes",
124                     path);
125         }
126         else {
127             MappingNamesHelper helper = MappingNamesHelper.getInstance();
128             String JavaDoc invalidChars = helper.invalidCharsInDbPathComponent(rel.getName());
129
130             if (invalidChars != null) {
131                 validator
132                         .registerWarning(
133                                 "DbRelationship " + dbRelationshipIdentifier(rel) + " name contains invalid characters: "
134                                         + invalidChars,
135                                 path);
136             }
137         }
138     }
139     
140     public String JavaDoc dbRelationshipIdentifier(DbRelationship rel)
141     {
142         if (null == rel.getSourceEntity())
143         {
144             return "<[null source entity]." + rel.getName() + ">";
145         }
146         return "<" + rel.getSourceEntity().getName() + "." + rel.getName() + ">";
147     }
148 }
Popular Tags