View Javadoc
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  /**
49   * Thrown when there is a mismatch over the uniqueness of an index in the Poem
50   * metadata and the jdbc metadata.
51   */
52  public class IndexUniquenessPoemException extends SeriousPoemException {
53    private static final long serialVersionUID = 1L;
54  
55    /** The Column we are dealing with. */
56    public Column<?> column;
57    /** The column's index. */
58    public String indexName;
59    /** Whether this Column should be unique. */
60    public boolean meantToBeUnique;
61  
62    /** Constructor. */
63    public IndexUniquenessPoemException(Column<?> column, String indexName,
64                                        boolean meantToBeUnique) {
65      this.column = column;
66      this.indexName = indexName;
67      this.meantToBeUnique = meantToBeUnique;
68    }
69  
70    /**
71     * @return The detail message
72     * @see java.lang.Throwable#getMessage()
73     */
74    public String getMessage() {
75      return "The column " + column + " is " + (meantToBeUnique ? "" : "not ")
76              + "meant to be unique, " + "but its index `" + indexName + "' is "
77              + (meantToBeUnique ? " not " : "") + "a unique index";
78    }
79  }