KickJava   Java API By Example, From Geeks To Geeks.

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


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.query.Query;
64 import org.objectstyle.cayenne.query.SQLTemplate;
65 import org.objectstyle.cayenne.util.Util;
66
67 /**
68  * Validator for SQLTemplate queries.
69  *
70  * @author Andrei Adamchik
71  * @since 1.1
72  */

73 public class SQLTemplateValidator extends TreeNodeValidator {
74
75     public void validateObject(ProjectPath treeNodePath, Validator validator) {
76         SQLTemplate query = (SQLTemplate) treeNodePath.getObject();
77
78         validateName(query, treeNodePath, validator);
79         validateRoot(query, treeNodePath, validator);
80         validateResultType(query, treeNodePath, validator);
81         validateDefaultSQL(query, treeNodePath, validator);
82     }
83
84     protected void validateDefaultSQL(
85             SQLTemplate query,
86             ProjectPath path,
87             Validator validator) {
88
89         if (Util.isEmptyString(query.getDefaultTemplate())) {
90             // see if there is at least one adapter-specific template...
91

92             Iterator JavaDoc it = query.getTemplateKeys().iterator();
93             while (it.hasNext()) {
94                 String JavaDoc key = (String JavaDoc) it.next();
95                 if (!Util.isEmptyString(query.getCustomTemplate(key))) {
96                     return;
97                 }
98             }
99
100             validator.registerWarning("Query has no default SQL template", path);
101         }
102     }
103
104     protected void validateRoot(Query query, ProjectPath path, Validator validator) {
105         DataMap map = (DataMap) path.firstInstanceOf(DataMap.class);
106         if (query.getRoot() == null && map != null) {
107             validator.registerWarning("Query has no root", path);
108         }
109     }
110
111     protected void validateName(Query query, ProjectPath path, Validator validator) {
112         String JavaDoc name = query.getName();
113
114         // Must have name
115
if (Util.isEmptyString(name)) {
116             validator.registerError("Unnamed Query.", path);
117             return;
118         }
119
120         DataMap map = (DataMap) path.getObjectParent();
121         if (map == null) {
122             return;
123         }
124
125         // check for duplicate names in the parent context
126
Iterator JavaDoc it = map.getQueries().iterator();
127         while (it.hasNext()) {
128             Query otherQuery = (Query) it.next();
129             if (otherQuery == query) {
130                 continue;
131             }
132
133             if (name.equals(otherQuery.getName())) {
134                 validator.registerError("Duplicate Query name: " + name + ".", path);
135                 break;
136             }
137         }
138     }
139
140     protected void validateResultType(
141             SQLTemplate query,
142             ProjectPath path,
143             Validator validator) {
144
145         if (query.isSelecting()
146                 && !query.isFetchingDataRows()
147                 && query.getRoot() != null
148                 && !(query.getRoot() instanceof ObjEntity || query.getRoot() instanceof Class JavaDoc)) {
149             
150             validator.registerWarning(
151                     "Missing result entity for SQLTemplate fetching DataObjects.",
152                     path);
153         }
154     }
155 }
Popular Tags