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
46 package org.melati.poem;
47
48 import org.melati.poem.generated.TableInfoTableBase;
49
50 /**
51 * A {@link Table} which holds information about all {@link Table}s in
52 * the Database.
53 *
54 * If a database does not contain a table called <tt>tableinfo</tt>
55 * it will be created during the unification phase of startup.
56 * see Database#unifyWithDB
57 *
58 * Note that when overriding you need to override defaultTableInfoFor.
59 *
60 * Melati POEM generated, programmer modifiable stub
61 * for a <code>TableInfoTable</code> object.
62 * <p>
63 * Description:
64 * Configuration information about a table in the database.
65 * </p>
66 *
67 *
68 * <table>
69 * <caption>
70 * Field summary for SQL table <code>TableInfo</code>
71 * </caption>
72 * <tr><th>Name</th><th>Type</th><th>Description</th></tr>
73 * <tr><td> id </td><td> Integer </td><td> The Table Row Object ID </td></tr>
74 * <tr><td> name </td><td> String </td><td> A code-name for the table
75 * </td></tr>
76 * <tr><td> displayname </td><td> String </td><td> A user-friendly name for
77 * the table </td></tr>
78 * <tr><td> description </td><td> String </td><td> A brief description of the
79 * table's function </td></tr>
80 * <tr><td> displayorder </td><td> Integer </td><td> A rank determining where
81 * the table appears in the list of all tables </td></tr>
82 * <tr><td> defaultcanread </td><td> Capability </td><td> The capability
83 * required, by default, for reading the table's records </td></tr>
84 * <tr><td> defaultcanwrite </td><td> Capability </td><td> The capability
85 * required, by default, for updating the table's records </td></tr>
86 * <tr><td> defaultcandelete </td><td> Capability </td><td> The capability
87 * required, by default, for deleting the table's records </td></tr>
88 * <tr><td> cancreate </td><td> Capability </td><td> The capability required,
89 * by default, for creating records in the table </td></tr>
90 * <tr><td> cachelimit </td><td> Integer </td><td> The maximum number of
91 * records from the table to keep in the cache </td></tr>
92 * <tr><td> seqcached </td><td> Boolean </td><td> Whether the display
93 * sequence for the table's records is cached </td></tr>
94 * <tr><td> category </td><td> TableCategory </td><td> Which category the
95 * table falls into </td></tr>
96 * </table>
97 *
98 * See org.melati.poem.prepro.TableDef#generateTableMainJava
99 */
100
101 public class TableInfoTable<T extends TableInfo> extends TableInfoTableBase<T> {
102
103 /**
104 * Constructor.
105 *
106 * See org.melati.poem.prepro.TableDef#generateTableMainJava
107 * @param database the POEM database we are using
108 * @param name the name of this <code>Table</code>
109 * @param definitionSource which definition is being used
110 * @throws PoemException if anything goes wrong
111 */
112 public TableInfoTable(
113 Database database, String name,
114 DefinitionSource definitionSource) throws PoemException {
115 super(database, name, definitionSource);
116 }
117
118 // programmer's domain-specific code here
119
120
121 /**
122 * Create a {@link TableInfo} of the correct type for our DB.
123 * NOTE you should override this if you extend TableInfo in your own db.
124 *
125 * @param table the Table to get metadata from.
126 * @return a new TableInfo Persistent
127 */
128 protected TableInfo defaultTableInfoFor(Table<?> table) {
129 return new TableInfo(table);
130 }
131
132 }