KickJava   Java API By Example, From Geeks To Geeks.

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


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.Arrays JavaDoc;
59 import java.util.Collection JavaDoc;
60 import java.util.StringTokenizer JavaDoc;
61
62 /**
63  * Defines a set of rules for validating java and db mapping identifiers.
64  *
65  * @author Andrei Adamchik
66  * @since 1.1
67  */
68 public class MappingNamesHelper {
69
70     // TODO: used by StringUtils and ClassGenerationInfo... need to refactor..
71 static final Collection JavaDoc RESERVED_JAVA_KEYWORDS = Arrays.asList(new Object JavaDoc[] {
72             "abstract", "assert", "default", "if", "private", "this", "boolean", "do",
73             "implements", "protected", "throw", "break", "double", "import", "public",
74             "throws", "byte", "else", "instanceof", "return", "transient", "case",
75             "extends", "int", "short", "try", "catch", "final", "interface", "static",
76             "void", "char", "finally", "long", "strictfp", "volatile", "class", "float",
77             "native", "super", "while", "const", "for", "new", "switch", "continue",
78             "goto", "package", "synchronized"
79     });
80
81     public boolean isReservedJavaKeyword(String JavaDoc word)
82     {
83         return RESERVED_JAVA_KEYWORDS.contains(word);
84     }
85     
86     // a property is considered invalid if there is a getter or a setter for it in
87 // java.lang.Object or CayenneDataObject
88 static final Collection JavaDoc INVALID_JAVA_PROPERTIES = Arrays.asList(new Object JavaDoc[] {
89             "class", "committedSnapshot", "currentSnapshot", "dataContext", "objectId",
90             "persistenceState", "snapshotVersion"
91     });
92
93     static final MappingNamesHelper sharedInstance = new MappingNamesHelper();
94
95     /**
96      * Returns shared instance of the validator.
97      */
98     public static MappingNamesHelper getInstance() {
99         return sharedInstance;
100     }
101
102     /**
103      * This is more of a sanity check than a real validation. As different DBs allow
104      * different chars in identifiers, here we simply check for dots.
105      */
106     String JavaDoc invalidCharsInDbPathComponent(String JavaDoc dbPathComponent) {
107         return (dbPathComponent.indexOf('.') >= 0) ? "." : null;
108     }
109
110     /**
111      * Scans a name of ObjAttribute or ObjRelationship for invalid characters.
112      */
113     String JavaDoc invalidCharsInObjPathComponent(String JavaDoc objPathComponent) {
114         String JavaDoc invalidChars = validateJavaIdentifier(objPathComponent, "");
115         return (invalidChars.length() > 0) ? invalidChars : null;
116     }
117
118     String JavaDoc invalidCharsInJavaClassName(String JavaDoc javaClassName) {
119         if (javaClassName == null) {
120             return null;
121         }
122
123         String JavaDoc invalidChars = "";
124
125         StringTokenizer JavaDoc toks = new StringTokenizer JavaDoc(javaClassName, ".");
126         while (toks.hasMoreTokens()) {
127             invalidChars = validateJavaIdentifier(toks.nextToken(), invalidChars);
128         }
129
130         return (invalidChars.length() > 0) ? invalidChars : null;
131     }
132
133     boolean invalidDataObjectClass(String JavaDoc dataObjectClassFQN) {
134         if (dataObjectClassFQN == null) {
135             return true;
136         }
137
138         StringTokenizer JavaDoc toks = new StringTokenizer JavaDoc(dataObjectClassFQN, ".");
139         while (toks.hasMoreTokens()) {
140             if (RESERVED_JAVA_KEYWORDS.contains(toks.nextToken())) {
141                 return true;
142             }
143         }
144
145         return false;
146     }
147
148     private String JavaDoc validateJavaIdentifier(String JavaDoc id, String JavaDoc invalidChars) {
149         // TODO: Java spec seems to allow "$" char in identifiers... Cayenne expressions do
150 // not, so we should probably check for this char presence...
151
152         int len = (id != null) ? id.length() : 0;
153         if (len == 0) {
154             return invalidChars;
155         }
156
157         if (!Character.isJavaIdentifierStart(id.charAt(0))) {
158             if (invalidChars.indexOf(id.charAt(0)) < 0) {
159                 invalidChars = invalidChars + id.charAt(0);
160             }
161         }
162
163         for (int i = 1; i < len; i++) {
164
165             if (!Character.isJavaIdentifierPart(id.charAt(i))) {
166                 if (invalidChars.indexOf(id.charAt(i)) < 0) {
167                     invalidChars = invalidChars + id.charAt(i);
168                 }
169             }
170         }
171
172         return invalidChars;
173     }
174
175     /**
176      * Returns whether a given String is a valid DataObject property. A property is
177      * considered invalid if there is a getter or a setter for it in java.lang.Object or
178      * CayenneDataObject.
179      */
180     boolean invalidDataObjectProperty(String JavaDoc dataObjectProperty) {
181         return dataObjectProperty == null
182                 || INVALID_JAVA_PROPERTIES.contains(dataObjectProperty);
183     }
184 }
Popular Tags