KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > dba > openbase > OpenBaseQualifierTranslator


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.dba.openbase;
57
58 import org.objectstyle.cayenne.access.trans.QualifierTranslator;
59 import org.objectstyle.cayenne.access.trans.QueryAssembler;
60 import org.objectstyle.cayenne.exp.Expression;
61 import org.objectstyle.cayenne.map.DbAttribute;
62
63 /**
64  * Translates query qualifier to SQL. Used as a helper class by query translators.
65  *
66  * @author <a HREF="mailto:mkienenb@alaska.net">Mike Kienenberger</a>
67  * @author Andrei Adamchik
68  *
69  * @since 1.1
70  */
71 public class OpenBaseQualifierTranslator extends QualifierTranslator {
72
73     public OpenBaseQualifierTranslator() {
74         this(null);
75     }
76
77     public OpenBaseQualifierTranslator(QueryAssembler queryAssembler) {
78         super(queryAssembler);
79     }
80
81     public void startNode(Expression node, Expression parentNode) {
82
83         if (node.getOperandCount() == 2) {
84             // binary nodes are the only ones that currently require this
85 detectObjectMatch(node);
86
87             if (parenthesisNeeded(node, parentNode)) {
88                 qualBuf.append('(');
89             }
90
91             // super implementation has special handling
92 // of LIKE_IGNORE_CASE and NOT_LIKE_IGNORE_CASE
93 // OpenBase is case-insensitive by default
94 // ...
95 }
96         else {
97             super.startNode(node, parentNode);
98         }
99     }
100
101     public void endNode(Expression node, Expression parentNode) {
102         if (node.getOperandCount() == 2) {
103             // check if we need to use objectMatchTranslator to finish building the expression
104 if (matchingObject) {
105                 appendObjectMatch();
106             }
107
108             if (parenthesisNeeded(node, parentNode))
109                 qualBuf.append(')');
110
111             // super implementation has special handling
112 // of LIKE_IGNORE_CASE and NOT_LIKE_IGNORE_CASE
113 // OpenBase is case-insensitive by default
114 // ...
115 }
116         else {
117             super.endNode(node, parentNode);
118         }
119     }
120
121     protected void appendLiteralDirect(
122         StringBuffer JavaDoc buf,
123         Object JavaDoc val,
124         DbAttribute attr,
125         Expression parentExpression) {
126
127         // Special handling of string matching is needed:
128 // Case-sensitive LIKE must be converted to [x][Y][z] format
129 if (val instanceof String JavaDoc
130             && (parentExpression.getType() == Expression.LIKE
131                 || parentExpression.getType() == Expression.NOT_LIKE)) {
132
133             val = caseSensitiveLikePattern((String JavaDoc) val);
134         }
135
136         super.appendLiteralDirect(buf, val, attr, parentExpression);
137     }
138
139     private String JavaDoc caseSensitiveLikePattern(String JavaDoc pattern) {
140         int len = pattern.length();
141         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc(len * 3);
142
143         for (int i = 0; i < len; i++) {
144             char c = pattern.charAt(i);
145             if (c == '%' || c == '?') {
146                 buffer.append(c);
147             }
148             else {
149                 buffer.append("[").append(c).append("]");
150             }
151         }
152
153         return buffer.toString();
154     }
155
156     public void finishedChild(Expression node, int childIndex, boolean hasMoreChildren) {
157         if (!hasMoreChildren) {
158             return;
159         }
160
161         // super implementation has special handling
162 // of LIKE_IGNORE_CASE and NOT_LIKE_IGNORE_CASE
163 // OpenBase is case-insensitive by default
164 // ...
165
166         switch (node.getType()) {
167
168             case Expression.LIKE_IGNORE_CASE :
169                 finishedChildNodeAppendExpression(node, " LIKE ");
170                 break;
171             case Expression.NOT_LIKE_IGNORE_CASE :
172                 finishedChildNodeAppendExpression(node, " NOT LIKE ");
173                 break;
174             default :
175                 super.finishedChild(node, childIndex, hasMoreChildren);
176         }
177     }
178
179     private void finishedChildNodeAppendExpression(Expression node, String JavaDoc operation) {
180         StringBuffer JavaDoc buf = (matchingObject) ? new StringBuffer JavaDoc() : qualBuf;
181         buf.append(operation);
182         if (matchingObject) {
183             objectMatchTranslator.setOperation(buf.toString());
184             objectMatchTranslator.setExpression(node);
185         }
186     }
187 }
Popular Tags