View Javadoc

1   package org.apache.torque.adapter;
2   
3   /* ====================================================================
4    * The Apache Software License, Version 1.1
5    *
6    * Copyright (c) 2001 The Apache Software Foundation.  All rights
7    * 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,
22   *    if any, must include the following acknowledgment:
23   *       "This product includes software developed by the
24   *        Apache Software Foundation (http://www.apache.org/)."
25   *    Alternately, this acknowledgment may appear in the software itself,
26   *    if and wherever such third-party acknowledgments normally appear.
27   *
28   * 4. The names "Apache" and "Apache Software Foundation" and
29   *    "Apache Turbine" must not be used to endorse or promote products
30   *    derived from this software without prior written permission. For
31   *    written permission, please contact apache@apache.org.
32   *
33   * 5. Products derived from this software may not be called "Apache",
34   *    "Apache Turbine", nor may "Apache" appear in their name, without
35   *    prior written permission of the Apache Software Foundation.
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 APACHE SOFTWARE FOUNDATION 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 on behalf of the Apache Software Foundation.  For more
53   * information on the Apache Software Foundation, please see
54   * <http://www.apache.org/>.
55   */
56  
57  import java.sql.Connection;
58  import java.sql.SQLException;
59  import java.sql.Statement;
60  
61  /***
62   * This is used to connect to SapDB databases.
63   *
64   * <a href="http://www.sapdb.org">http://www.sapdb.org</a>
65   *
66   * @author <a href="mailto:dave.polito@planetcad.com">Dave Polito</a>
67   * @version $Id: DBSapDB.java,v 1.7 2002/06/02 15:36:23 mpoeschl Exp $
68   */
69  public class DBSapDB extends DB
70  {
71      /***
72       * Empty constructor.
73       */
74      protected DBSapDB()
75      {
76      }
77  
78      /***
79       * This method is used to ignore case.
80       *
81       * @param in The string to transform to upper case.
82       * @return The upper case string.
83       */
84      public String toUpperCase(String in)
85      {
86          return new StringBuffer("UPPER(").append(in).append(")").toString();
87      }
88  
89      /***
90       * This method is used to ignore case.
91       *
92       * @param in The string whose case to ignore.
93       * @return The string in a case that can be ignored.
94       */
95      public String ignoreCase(String in)
96      {
97          return new StringBuffer("UPPER(").append(in).append(")").toString();
98      }
99  
100     /***
101      * @see org.apache.torque.adapter.DB#getIDMethodType()
102      */
103     public String getIDMethodType()
104     {
105         return SEQUENCE;
106     }
107 
108     /***
109      * Returns the next key from a sequence.  Uses the following
110      * implementation:
111      *
112      * <blockquote><code><pre>
113      * select sequenceName.nextval from dual
114      * </pre></code></blockquote>
115      *
116      * @param sequenceName The name of the sequence (should be of type
117      * <code>String</code>).
118      * @return SQL to retreive the next database key.
119      * @see org.apache.torque.adapter.DB#getIDMethodSQL(Object)
120      */
121     public String getIDMethodSQL(Object sequenceName)
122     {
123         return ("select " + sequenceName + ".nextval from dual");
124     }
125 
126     /***
127      * Locks the specified table.
128      *
129      * @param con The JDBC connection to use.
130      * @param table The name of the table to lock.
131      * @exception SQLException No Statement could be created or executed.
132      */
133     public void lockTable(Connection con, String table) throws SQLException
134     {
135         Statement statement = con.createStatement();
136 
137         StringBuffer stmt = new StringBuffer();
138         stmt.append("SELECT next_id FROM ")
139         .append(table)
140         .append(" FOR UPDATE");
141 
142         statement.executeQuery(stmt.toString());
143     }
144 
145    /***
146     * This method is for the SqlExpression.quoteAndEscape rules.  The rule is,
147     * any string in a SqlExpression with a BACKSLASH will either be changed to
148     * "//" or left as "\".  SapDB does not need the escape character.
149     *
150     * @return false.
151     */
152 
153     public boolean escapeText()
154     {
155         return false;
156     }
157 
158     /***
159      * Unlocks the specified table.
160      *
161      * @param con The JDBC connection to use.
162      * @param table The name of the table to unlock.
163      * @exception SQLException No Statement could be created or
164      * executed.
165      */
166     public void unlockTable(Connection con, String table) throws SQLException
167     {
168         // Tables in SapDB are unlocked when a commit is issued.  The
169         // user may have issued a commit but do it here to be sure.
170         con.commit();
171     }
172 }