KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > access > trans > BatchQueryBuilder


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
57 package org.objectstyle.cayenne.access.trans;
58
59 import java.sql.PreparedStatement JavaDoc;
60 import java.sql.SQLException JavaDoc;
61 import java.sql.Types JavaDoc;
62 import java.util.ArrayList JavaDoc;
63 import java.util.List JavaDoc;
64
65 import org.objectstyle.cayenne.dba.DbAdapter;
66 import org.objectstyle.cayenne.map.DbAttribute;
67 import org.objectstyle.cayenne.query.BatchQuery;
68
69 /**
70  * Superclass of batch query translators.
71  *
72  * @author Andriy Shapochka, Andrei Adamchik
73  */
74
75 public abstract class BatchQueryBuilder {
76
77     protected DbAdapter adapter;
78     protected String JavaDoc trimFunction;
79
80     public BatchQueryBuilder() {
81     }
82
83     public BatchQueryBuilder(DbAdapter adapter) {
84         this.adapter = adapter;
85     }
86
87     /**
88      * Translates BatchQuery into an SQL string formatted to use in a PreparedStatement.
89      */
90     public abstract String JavaDoc createSqlString(BatchQuery batch);
91
92     /**
93      * Appends the name of the column to the query buffer. Subclasses use this method to
94      * append column names in the WHERE clause, i.e. for the columns that are not being
95      * updated.
96      */
97     protected void appendDbAttribute(StringBuffer JavaDoc buf, DbAttribute dbAttribute) {
98
99         // TODO: (Andrus) is there a need for trimming binary types?
100 boolean trim = dbAttribute.getType() == Types.CHAR && trimFunction != null;
101         if (trim) {
102             buf.append(trimFunction).append('(');
103         }
104
105         buf.append(dbAttribute.getName());
106
107         if (trim) {
108             buf.append(')');
109         }
110     }
111
112     public void setAdapter(DbAdapter adapter) {
113         this.adapter = adapter;
114     }
115
116     public DbAdapter getAdapter() {
117         return adapter;
118     }
119
120     public String JavaDoc getTrimFunction() {
121         return trimFunction;
122     }
123
124     public void setTrimFunction(String JavaDoc string) {
125         trimFunction = string;
126     }
127
128     /**
129      * Binds parameters for the current batch iteration to the PreparedStatement.
130      *
131      * @deprecated since 1.1 use 'bindParameters' without dbAttributes argument.
132      */
133     public void bindParameters(
134             PreparedStatement JavaDoc statement,
135             BatchQuery query,
136             List JavaDoc dbAttributes) throws SQLException JavaDoc, Exception JavaDoc {
137         this.bindParameters(statement, query);
138     }
139
140     /**
141      * Binds parameters for the current batch iteration to the PreparedStatement.
142      *
143      * @since 1.2
144      */
145     public void bindParameters(PreparedStatement JavaDoc statement, BatchQuery query)
146             throws SQLException JavaDoc, Exception JavaDoc {
147
148         List JavaDoc dbAttributes = query.getDbAttributes();
149         int attributeCount = dbAttributes.size();
150
151         for (int i = 0; i < attributeCount; i++) {
152             Object JavaDoc value = query.getValue(i);
153             DbAttribute attribute = (DbAttribute) dbAttributes.get(i);
154             adapter.bindParameter(statement, value, i + 1, attribute.getType(), attribute
155                     .getPrecision());
156
157         }
158     }
159
160     /**
161      * Returns a list of values for the current batch iteration. Used primarily for
162      * logging.
163      *
164      * @since 1.2
165      */
166     public List JavaDoc getParameterValues(BatchQuery query) {
167         List JavaDoc attributes = query.getDbAttributes();
168         int len = attributes.size();
169         List JavaDoc values = new ArrayList JavaDoc(len);
170         for (int i = 0; i < len; i++) {
171             values.add(query.getValue(i));
172         }
173         return values;
174     }
175 }
Popular Tags