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 * A possible origin for metadata for a {@link Field}, {@link Column}
50 * or {@link Table}.
51 *
52 * The definition sources are unified during Poem initialisation.
53 *
54 * @see Database#unifyWithDB
55 * @see Table#unifyWithDB
56 * @see Column#unifyWithIndex
57 *
58 */
59 public class DefinitionSource {
60 private String name;
61
62 /** Constructor. */
63 public DefinitionSource(Object what) {
64 this.name = what.toString();
65 }
66
67 /**
68 * {@inheritDoc}
69 * @see java.lang.Object#toString()
70 */
71 public String toString() {
72 return name;
73 }
74
75 /* Defined definition sources. */
76 /** The DSD. */
77 public static final DefinitionSource
78 dsd = new DefinitionSource("the data structure definition");
79 /** The metadata tables. */
80 public static final DefinitionSource
81 infoTables = new DefinitionSource("the data dictionary");
82 /** The JDBC metatdata. */
83 public static final DefinitionSource
84 sqlMetaData = new DefinitionSource("the JDBC metadata");
85 /** The current running application; transitory,
86 * as next time this data will be in the data dictionary. */
87 public static final DefinitionSource
88 runtime = new DefinitionSource("the running application");
89 }