Source code: org/objectstyle/cayenne/dba/postgres/PostgresAdapter.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.postgres;
57
58 import org.objectstyle.cayenne.access.trans.QualifierTranslator;
59 import org.objectstyle.cayenne.access.trans.QueryAssembler;
60 import org.objectstyle.cayenne.access.trans.TrimmingQualifierTranslator;
61 import org.objectstyle.cayenne.access.types.ByteArrayType;
62 import org.objectstyle.cayenne.access.types.CharType;
63 import org.objectstyle.cayenne.access.types.ExtendedTypeMap;
64 import org.objectstyle.cayenne.dba.JdbcAdapter;
65 import org.objectstyle.cayenne.dba.PkGenerator;
66 import org.objectstyle.cayenne.map.DbEntity;
67
68 /**
69 * DbAdapter implementation for <a href="http://www.postgresql.org">PostgreSQL RDBMS</a>.
70 * Sample <a target="_top" href="../../../../../../../developerguide/unit-tests.html">connection
71 * settings</a> to use with PostgreSQL are shown below:
72 *
73 <pre>
74 test-postgresql.cayenne.adapter = org.objectstyle.cayenne.dba.postgres.PostgresAdapter
75 test-postgresql.jdbc.username = test
76 test-postgresql.jdbc.password = secret
77 test-postgresql.jdbc.url = jdbc:postgresql://serverhostname/cayenne
78 test-postgresql.jdbc.driver = org.postgresql.Driver
79 </pre>
80 *
81 * @author Dirk Olmes, Holger Hoffstaette
82 */
83 public class PostgresAdapter extends JdbcAdapter
84 {
85 /**
86 * Installs appropriate ExtendedTypes as converters for passing values
87 * between JDBC and Java layers.
88 */
89 protected void configureExtendedTypes(ExtendedTypeMap map) {
90 super.configureExtendedTypes(map);
91
92 // create specially configured CharType handler
93 map.registerType(new CharType(true, true));
94
95 // create specially configured ByteArrayType handler
96 map.registerType(new ByteArrayType(true, true));
97 }
98
99
100 /**
101 * Adds the CASCADE option to the DROP TABLE clause.
102 * @see JdbcAdapter#dropTable(DbEntity)
103 */
104 public String dropTable(DbEntity ent) {
105 return super.dropTable(ent) + " CASCADE";
106 }
107
108 /**
109 * Returns a trimming translator.
110 */
111 public QualifierTranslator getQualifierTranslator(QueryAssembler queryAssembler) {
112 return new TrimmingQualifierTranslator(queryAssembler, "RTRIM");
113 }
114
115 /**
116 * @see JdbcAdapter#createPkGenerator()
117 */
118 protected PkGenerator createPkGenerator() {
119 return new PostgresPkGenerator();
120 }
121 }