KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > dba > postgres > PostgresPkGenerator


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.postgres;
57
58 import java.sql.Connection JavaDoc;
59 import java.sql.ResultSet JavaDoc;
60 import java.sql.SQLException JavaDoc;
61 import java.sql.Statement JavaDoc;
62 import java.util.ArrayList JavaDoc;
63 import java.util.Collections JavaDoc;
64 import java.util.List JavaDoc;
65
66 import org.objectstyle.cayenne.CayenneRuntimeException;
67 import org.objectstyle.cayenne.access.DataNode;
68 import org.objectstyle.cayenne.access.QueryLogger;
69 import org.objectstyle.cayenne.dba.oracle.OraclePkGenerator;
70 import org.objectstyle.cayenne.map.DbEntity;
71 import org.objectstyle.cayenne.map.DbKeyGenerator;
72
73 /**
74  * Default PK generator for PostgreSQL that uses sequences for PK generation.
75  */

76 public class PostgresPkGenerator extends OraclePkGenerator {
77
78     protected String JavaDoc createSequenceString(DbEntity ent) {
79         // note that PostgreSQL 7.4 and newer supports INCREMENT BY and START WITH
80
// however 7.3 doesn't like BY and WITH, so using older more neutral syntax
81
// that works with all tested versions.
82
StringBuffer JavaDoc buf = new StringBuffer JavaDoc();
83         buf
84                 .append("CREATE SEQUENCE ")
85                 .append(sequenceName(ent))
86                 .append(" INCREMENT ")
87                 .append(pkCacheSize(ent))
88                 .append(" START 200");
89         return buf.toString();
90     }
91
92     /**
93      * Generates primary key by calling Oracle sequence corresponding to the
94      * <code>dbEntity</code>. Executed SQL looks like this:
95      *
96      * <pre>
97      * SELECT nextval(pk_table_name)
98      * </pre>
99      */

100     protected int pkFromDatabase(DataNode node, DbEntity ent) throws Exception JavaDoc {
101
102         DbKeyGenerator pkGenerator = ent.getPrimaryKeyGenerator();
103         String JavaDoc pkGeneratingSequenceName;
104         if (pkGenerator != null
105                 && DbKeyGenerator.ORACLE_TYPE.equals(pkGenerator.getGeneratorType())
106                 && pkGenerator.getGeneratorName() != null)
107             pkGeneratingSequenceName = pkGenerator.getGeneratorName();
108         else
109             pkGeneratingSequenceName = sequenceName(ent);
110
111         Connection JavaDoc con = node.getDataSource().getConnection();
112         try {
113             Statement JavaDoc st = con.createStatement();
114             try {
115                 String JavaDoc sql = "SELECT nextval('" + pkGeneratingSequenceName + "')";
116                 QueryLogger.logQuery(QueryLogger.DEFAULT_LOG_LEVEL,
117                         sql,
118                         Collections.EMPTY_LIST);
119                 ResultSet JavaDoc rs = st.executeQuery(sql);
120                 try {
121                     //Object pk = null;
122
if (!rs.next()) {
123                         throw new CayenneRuntimeException(
124                                 "Error generating pk for DbEntity " + ent.getName());
125                     }
126                     return rs.getInt(1);
127                 }
128                 finally {
129                     rs.close();
130                 }
131             }
132             finally {
133                 st.close();
134             }
135         }
136         finally {
137             con.close();
138         }
139     }
140
141     /**
142      * Fetches a list of existing sequences that might match Cayenne generated ones.
143      */

144     protected List JavaDoc getExistingSequences(DataNode node) throws SQLException JavaDoc {
145
146         // check existing sequences
147
Connection JavaDoc con = node.getDataSource().getConnection();
148
149         try {
150             Statement JavaDoc sel = con.createStatement();
151             try {
152                 String JavaDoc sql = "SELECT relname FROM pg_class WHERE relkind='S'";
153                 QueryLogger.logQuery(QueryLogger.DEFAULT_LOG_LEVEL,
154                         sql,
155                         Collections.EMPTY_LIST);
156                 ResultSet JavaDoc rs = sel.executeQuery(sql);
157                 try {
158                     List JavaDoc sequenceList = new ArrayList JavaDoc();
159                     while (rs.next()) {
160                         sequenceList.add(rs.getString(1));
161                     }
162                     return sequenceList;
163                 }
164                 finally {
165                     rs.close();
166                 }
167             }
168             finally {
169                 sel.close();
170             }
171         }
172         finally {
173             con.close();
174         }
175     }
176 }
Popular Tags