Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

Source code: org/objectstyle/cayenne/dba/mysql/MySQLAdapter.java


1   /* ====================================================================
2    * 
3    * The ObjectStyle Group Software License, Version 1.0 
4    *
5    * Copyright (c) 2002-2003 The ObjectStyle Group 
6    * and individual authors of the software.  All rights reserved.
7    *
8    * Redistribution and use in source and binary forms, with or without
9    * modification, are permitted provided that the following conditions
10   * are met:
11   *
12   * 1. Redistributions of source code must retain the above copyright
13   *    notice, this list of conditions and the following disclaimer. 
14   *
15   * 2. Redistributions in binary form must reproduce the above copyright
16   *    notice, this list of conditions and the following disclaimer in
17   *    the documentation and/or other materials provided with the
18   *    distribution.
19   *
20   * 3. The end-user documentation included with the redistribution, if
21   *    any, must include the following acknowlegement:  
22   *       "This product includes software developed by the 
23   *        ObjectStyle Group (http://objectstyle.org/)."
24   *    Alternately, this acknowlegement may appear in the software itself,
25   *    if and wherever such third-party acknowlegements normally appear.
26   *
27   * 4. The names "ObjectStyle Group" and "Cayenne" 
28   *    must not be used to endorse or promote products derived
29   *    from this software without prior written permission. For written 
30   *    permission, please contact andrus@objectstyle.org.
31   *
32   * 5. Products derived from this software may not be called "ObjectStyle"
33   *    nor may "ObjectStyle" appear in their names without prior written
34   *    permission of the ObjectStyle Group.
35   *
36   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39   * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
40   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47   * SUCH DAMAGE.
48   * ====================================================================
49   *
50   * This software consists of voluntary contributions made by many
51   * individuals on behalf of the ObjectStyle Group.  For more
52   * information on the ObjectStyle Group, please see
53   * <http://objectstyle.org/>.
54   *
55   */
56  package org.objectstyle.cayenne.dba.mysql;
57  
58  import org.objectstyle.cayenne.CayenneRuntimeException;
59  import org.objectstyle.cayenne.dba.JdbcAdapter;
60  import org.objectstyle.cayenne.dba.PkGenerator;
61  import org.objectstyle.cayenne.map.DbRelationship;
62  
63  /**
64   * DbAdapter implementation for <a href="http://www.mysql.com">MySQL RDBMS</a>.
65   * Sample <a target="_top" href="../../../../../../../developerguide/unit-tests.html">connection 
66   * settings</a> to use with MySQL are shown below:
67   * 
68  <pre>
69  test-mysql.cayenne.adapter = org.objectstyle.cayenne.dba.mysql.MySQLAdapter
70  test-mysql.jdbc.username = test
71  test-mysql.jdbc.password = secret
72  test-mysql.jdbc.url = jdbc:mysql://serverhostname/cayenne
73  test-mysql.jdbc.driver = org.gjt.mm.mysql.Driver
74  </pre>
75   * 
76   * @author Andrei Adamchik
77   */
78  public class MySQLAdapter extends JdbcAdapter {
79    public boolean supportsFkConstraints() {
80      return false;
81    }
82  
83    /** Throws an exception, since FK constraints are not supported by MySQL. */
84    public String createFkConstraint(DbRelationship rel) {
85      throw new CayenneRuntimeException("FK constraints are not supported.");
86    }
87  
88    /** 
89     * Returns null, since views are not yet supported in MySQL. Views
90     * support is promised in MySQL 4.1.
91     */
92    public String tableTypeForView() {
93      return null;
94    }
95  
96    /**
97      * Creates and returns a primary key generator. Overrides superclass 
98      * implementation to return an
99      * instance of MySQLPkGenerator that does the correct table locking.
100     */
101   protected PkGenerator createPkGenerator() {
102     return new MySQLPkGenerator();
103   }
104 }