KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > dba > mysql > MySQLAdapter


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.mysql;
57
58 import java.sql.Types JavaDoc;
59
60 import org.objectstyle.cayenne.CayenneRuntimeException;
61 import org.objectstyle.cayenne.access.types.CharType;
62 import org.objectstyle.cayenne.access.types.ExtendedTypeMap;
63 import org.objectstyle.cayenne.dba.JdbcAdapter;
64 import org.objectstyle.cayenne.dba.PkGenerator;
65 import org.objectstyle.cayenne.map.DbAttribute;
66 import org.objectstyle.cayenne.map.DbRelationship;
67
68 /**
69  * DbAdapter implementation for <a HREF="http://www.mysql.com">MySQL RDBMS</a>.
70  * Sample <a target="_top" HREF="../../../../../../../developerguide/unit-tests.html">connection
71  * settings</a> to use with MySQL are shown below:
72  *
73 <pre>
74 test-mysql.cayenne.adapter = org.objectstyle.cayenne.dba.mysql.MySQLAdapter
75 test-mysql.jdbc.username = test
76 test-mysql.jdbc.password = secret
77 test-mysql.jdbc.url = jdbc:mysql://serverhostname/cayenne
78 test-mysql.jdbc.driver = com.mysql.jdbc.Driver
79 </pre>
80  *
81  * @author Andrei Adamchik
82  */
83 public class MySQLAdapter extends JdbcAdapter {
84
85     public MySQLAdapter() {
86         // init defaults
87 this.setSupportsFkConstraints(false);
88         this.setSupportsUniqueConstraints(true);
89         this.setSupportsGeneratedKeys(true);
90     }
91
92     /**
93      * Installs appropriate ExtendedTypes used as converters for passing values
94      * between JDBC and Java layers.
95      */
96     protected void configureExtendedTypes(ExtendedTypeMap map) {
97         super.configureExtendedTypes(map);
98
99         // must handle CLOBs as strings, otherwise there
100 // are problems with NULL clobs that are treated
101 // as empty strings... somehow this doesn't happen
102 // for BLOBs (ConnectorJ v. 3.0.9)
103 map.registerType(new CharType(false, false));
104     }
105
106     public DbAttribute buildAttribute(
107         String JavaDoc name,
108         String JavaDoc typeName,
109         int type,
110         int size,
111         int precision,
112         boolean allowNulls) {
113
114         // all LOB types are returned by the driver as OTHER... must remap them manually
115 // (at least on MySQL 3.23)
116 if (type == Types.OTHER) {
117             if ("longblob".equalsIgnoreCase(typeName)) {
118                 type = Types.BLOB;
119             }
120             else if ("mediumblob".equalsIgnoreCase(typeName)) {
121                 type = Types.BLOB;
122             }
123             else if ("blob".equalsIgnoreCase(typeName)) {
124                 type = Types.BLOB;
125             }
126             else if ("tinyblob".equalsIgnoreCase(typeName)) {
127                 type = Types.VARBINARY;
128             }
129             else if ("longtext".equalsIgnoreCase(typeName)) {
130                 type = Types.CLOB;
131             }
132             else if ("mediumtext".equalsIgnoreCase(typeName)) {
133                 type = Types.CLOB;
134             }
135             else if ("text".equalsIgnoreCase(typeName)) {
136                 type = Types.CLOB;
137             }
138             else if ("tinytext".equalsIgnoreCase(typeName)) {
139                 type = Types.VARCHAR;
140             }
141         }
142
143         return super.buildAttribute(name, typeName, type, size, precision, allowNulls);
144     }
145
146     /** Throws an exception, since FK constraints are not supported by MySQL. */
147     public String JavaDoc createFkConstraint(DbRelationship rel) {
148         throw new CayenneRuntimeException("FK constraints are not supported.");
149     }
150
151     /**
152      * Returns null, since views are not yet supported in MySQL. Views
153      * support is promised in MySQL 4.1.
154      */
155     public String JavaDoc tableTypeForView() {
156         return null;
157     }
158
159     /**
160       * Creates and returns a primary key generator. Overrides superclass
161       * implementation to return an
162       * instance of MySQLPkGenerator that does the correct table locking.
163       */
164     protected PkGenerator createPkGenerator() {
165         return new MySQLPkGenerator();
166     }
167     
168     protected void createTableAppendColumn(StringBuffer JavaDoc sqlBuffer, DbAttribute column) {
169         super.createTableAppendColumn(sqlBuffer, column);
170         
171         if(column.isGenerated()) {
172             sqlBuffer.append(" AUTO_INCREMENT");
173         }
174     }
175 }
176
Popular Tags