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@paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45 package org.melati.poem;
46
47 import org.melati.poem.generated.TableCategoryTableBase;
48
49 /**
50 * A {@link Table} which holds {@link TableCategory}s.
51 *
52 * Melati POEM generated, programmer modifiable stub
53 * for a <code>TableCategoryTable</code> object.
54 * <p>
55 * Description:
56 * A category under which a table can be classified.
57 * </p>
58 *
59 *
60 * <table>
61 * <caption>
62 * Field summary for SQL table <code>TableCategory</code>
63 * </caption>
64 * <tr><th>Name</th><th>Type</th><th>Description</th></tr>
65 * <tr><td> id </td><td> Integer </td><td> The Table Row Object ID </td></tr>
66 * <tr><td> name </td><td> String </td><td> A human-readable name for the
67 * category </td></tr>
68 * </table>
69 *
70 * See org.melati.poem.prepro.TableDef#generateTableMainJava
71 */
72
73 public class TableCategoryTable<T extends TableCategory> extends TableCategoryTableBase<T> {
74
75 /**
76 * Constructor.
77 *
78 * See org.melati.poem.prepro.TableDef#generateTableMainJava
79 * @param database the POEM database we are using
80 * @param name the name of this <code>Table</code>
81 * @param definitionSource which definition is being used
82 * @throws PoemException if anything goes wrong
83 */
84 public TableCategoryTable(
85 Database database, String name,
86 DefinitionSource definitionSource) throws PoemException {
87 super(database, name, definitionSource);
88 }
89
90 // programmer's domain-specific code here
91
92 /** Category name for normal tables. */
93 public static final String normalTableCategoryName = "Normal";
94 /** The category for ordinary data tables. */
95 public TableCategory NORMAL;
96 /**
97 * Create an entry with the given name if it doesn't exist.
98 * @param name the name of the Category
99 * @return the existing or newly created TableCategory
100 */
101 public TableCategory ensure(String name) {
102 TableCategory it = (TableCategory)newPersistent();
103 it.setName(name);
104 return (TableCategory)getNameColumn().ensure(it);
105 }
106
107 /**
108 * Setup default access capabilities and ensure that the Normal category exists.
109 */
110 public void postInitialise() {
111 super.postInitialise();
112 NORMAL = ensure(normalTableCategoryName);
113 }
114 }