1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 William Chesters
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * William Chesters <williamc At paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.poem;
47
48 import java.sql.SQLException;
49
50 /**
51 * Thrown when there is an {@link SQLException} thrown by the dbms
52 * in a situation where it matters.
53 *
54 * @author WilliamC@paneris.org
55 */
56 public class SQLSeriousPoemException extends SeriousPoemException {
57 private static final long serialVersionUID = 1L;
58
59 /**
60 * The SQL string that was being executed when the error occurred.
61 */
62 public String sql;
63
64 /**
65 * An SQL exception and the statement that provoked it.
66 *
67 * @param sqlException the db exception that has been caught
68 * @param sql the SQL statement that provoked the exception
69 */
70 public SQLSeriousPoemException(SQLException sqlException, String sql) {
71 super(sqlException);
72 this.sql = sql;
73 }
74
75 /**
76 * Constructor for use if you do not have the SQL string.
77 *
78 * @param sqlException the db exception that has been caught
79 */
80 public SQLSeriousPoemException(SQLException sqlException) {
81 this(sqlException, null);
82 }
83
84 /**
85 * @return The detail message
86 * @see java.lang.Throwable#getMessage()
87 */
88 public String getMessage() {
89 return (sql == null ? "" : "Executing: " + sql) +
90 "An error was reported by the SQL driver:\n" +
91 subException.getMessage();
92 }
93 }