KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > dba > derby > DerbyAdapter


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.dba.derby;
58
59 import org.objectstyle.cayenne.CayenneRuntimeException;
60 import org.objectstyle.cayenne.access.trans.QualifierTranslator;
61 import org.objectstyle.cayenne.access.trans.QueryAssembler;
62 import org.objectstyle.cayenne.access.trans.TrimmingQualifierTranslator;
63 import org.objectstyle.cayenne.access.types.ByteType;
64 import org.objectstyle.cayenne.access.types.CharType;
65 import org.objectstyle.cayenne.access.types.ExtendedTypeMap;
66 import org.objectstyle.cayenne.access.types.ShortType;
67 import org.objectstyle.cayenne.dba.JdbcAdapter;
68 import org.objectstyle.cayenne.dba.TypesMapping;
69 import org.objectstyle.cayenne.map.DbAttribute;
70 import org.objectstyle.cayenne.map.DbEntity;
71
72 /**
73  * DbAdapter implementation for the <a
74  * HREF="http://incubator.apache.org/derby/"> Derby RDBMS </a>. Sample <a
75  * target="_top"
76  * HREF="../../../../../../../developerguide/unit-tests.html">connection
77  * settings </a> to use with Derby are shown below:
78  *
79  * <pre>
80  * test-derby.cayenne.adapter = org.objectstyle.cayenne.dba.derby.DerbyAdapter
81  * test-derby.jdbc.url = jdbc:derby:testdb;create=true
82  * test-derby.jdbc.driver = org.apache.derby.jdbc.EmbeddedDriver
83  * </pre>
84  *
85  */
86 public class DerbyAdapter extends JdbcAdapter {
87
88     /**
89      * Installs appropriate ExtendedTypes as converters for passing values
90      * between JDBC and Java layers.
91      */
92     protected void configureExtendedTypes(ExtendedTypeMap map) {
93         super.configureExtendedTypes(map);
94
95         // create specially configured CharType handler
96 map.registerType(new CharType(true, false));
97         
98         // address Derby driver inability to handle java.lang.Short and java.lang.Byte
99 map.registerType(new ShortType(true));
100         map.registerType(new ByteType(true));
101     }
102
103     /**
104      * Appends SQL for column creation to CREATE TABLE buffer.
105      *
106      * Only change for Derby is that " NULL" is not supported.
107      *
108      * @since 1.2
109      */
110     protected void createTableAppendColumn(StringBuffer JavaDoc sqlBuffer, DbAttribute column) {
111         String JavaDoc[] types = externalTypesForJdbcType(column.getType());
112         if (types == null || types.length == 0) {
113             String JavaDoc entityName = column.getEntity() != null ? ((DbEntity) column.getEntity())
114                     .getFullyQualifiedName() : "<null>";
115             throw new CayenneRuntimeException("Undefined type for attribute '" + entityName + "."
116                     + column.getName() + "': " + column.getType());
117         }
118
119         String JavaDoc type = types[0];
120         sqlBuffer.append(column.getName()).append(' ').append(type);
121
122         // append size and precision (if applicable)
123 if (TypesMapping.supportsLength(column.getType())) {
124             int len = column.getMaxLength();
125             int prec = TypesMapping.isDecimal(column.getType()) ? column.getPrecision() : -1;
126
127             // sanity check
128 if (prec > len) {
129                 prec = -1;
130             }
131
132             if (len > 0) {
133                 sqlBuffer.append('(').append(len);
134
135                 if (prec >= 0) {
136                     sqlBuffer.append(", ").append(prec);
137                 }
138
139                 sqlBuffer.append(')');
140             }
141         }
142
143         //sqlBuffer.append(column.isMandatory() ? " NOT NULL" : " NULL");
144 if (column.isMandatory()) {
145             sqlBuffer.append(" NOT NULL");
146         }
147     }
148
149     /**
150      * Returns a trimming translator.
151      */
152     public QualifierTranslator getQualifierTranslator(QueryAssembler queryAssembler) {
153         return new TrimmingQualifierTranslator(queryAssembler, "RTRIM");
154     }
155
156 }
Popular Tags