1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2001 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@paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.poem.dbms;
47
48 import java.sql.SQLException;
49
50 import org.melati.poem.Column;
51 import org.melati.poem.ExecutingSQLPoemException;
52 import org.melati.poem.Table;
53
54 /**
55 * Thrown when an attempt to insert a value which is already present
56 * in a column with a unique index is made.
57 *
58 * @author WilliamC@paneris.org
59 */
60 public class DuplicateKeySQLPoemException extends ExecutingSQLPoemException {
61 private static final long serialVersionUID = 1L;
62
63 /** The Table we are dealing with. */
64 public String table;
65 /** The Column we are dealing with. */
66 public String column;
67 /** Whether this was an insert operation or not.*/
68 public boolean insert;
69
70 /** Constructor. */
71 public DuplicateKeySQLPoemException(Table<?> table, String sql,
72 boolean insert, SQLException e) {
73 super(sql, e);
74 if (table != null)
75 try {
76 this.table = table.getDisplayName();
77 }
78 catch (Exception f) {
79 this.table = table.getName();
80 }
81
82 column = null;
83 this.insert = insert;
84 }
85
86 /** Constructor. */
87 public DuplicateKeySQLPoemException(Column<?> column, String sql,
88 boolean insert, SQLException e) {
89 super(sql, e);
90 if (column != null) {
91 try {
92 table = column.getTable().getDisplayName();
93 }
94 catch (Exception f) {
95 table = column.getTable().getName();
96 }
97
98 try {
99 this.column = column.getDisplayName();
100 }
101 catch (Exception f) {
102 this.column = column.getName();
103 }
104 }
105
106 this.insert = insert;
107 }
108
109 /**
110 * @return The table name.
111 */
112 public final String getTable() {
113 return table;
114 }
115
116 /**
117 * @return The column name.
118 */
119 public final String getColumn() {
120 return column;
121 }
122
123 /**
124 * @return whether operation was an insert
125 */
126 public final boolean getWasInsert() {
127 return insert;
128 }
129
130 /** @return The detail message. */
131 public String getMessage() {
132 String quant = insert ? "an existing" : "another";
133 if (column == null) {
134 String desc = table == null ? "record" : table;
135 return "Unable to create " + desc + ": one or more fields clashed " +
136 "with " + quant + " " + desc;
137 }
138 else {
139 return "The " + table + "'s " + column + " clashes with that of " +
140 quant + " " + table;
141 }
142 }
143 }