| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ColumnInfoTable |
|
| 1.0;1 |
| 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.ColumnInfoTableBase; | |
| 49 | ||
| 50 | /** | |
| 51 | * A {@link Table} which holds information about all {@link Column}s in | |
| 52 | * a {@link Database}. | |
| 53 | * If a database does not contain a table called <tt>columninfo</tt> | |
| 54 | * it will be created. | |
| 55 | * | |
| 56 | * Melati POEM generated, programmer modifiable stub | |
| 57 | * for a <code>ColumnInfoTable</code> object. | |
| 58 | * <p> | |
| 59 | * Description: | |
| 60 | * Configuration information about a column in the database. | |
| 61 | * </p> | |
| 62 | * | |
| 63 | * | |
| 64 | * <table> | |
| 65 | * <caption> | |
| 66 | * Field summary for SQL table <code>ColumnInfo</code> | |
| 67 | * </caption> | |
| 68 | * <tr><th>Name</th><th>Type</th><th>Description</th></tr> | |
| 69 | * <tr><td> id </td><td> Integer </td><td> </td></tr> | |
| 70 | * <tr><td> tableinfo </td><td> TableInfo </td><td> The table to which the | |
| 71 | * field belongs </td></tr> | |
| 72 | * <tr><td> name </td><td> String </td><td> A code-name for the field | |
| 73 | * </td></tr> | |
| 74 | * <tr><td> displayorder </td><td> Integer </td><td> A rank determining where | |
| 75 | * the field appears in lists </td></tr> | |
| 76 | * <tr><td> usercreateable </td><td> Boolean </td><td> Whether it makes sense | |
| 77 | * for the user to initialise the field's value </td></tr> | |
| 78 | * <tr><td> displaylevel </td><td> DisplayLevel </td><td> A category | |
| 79 | * determining what granularity of report the field appears in </td></tr> | |
| 80 | * <tr><td> searchability </td><td> Searchability </td><td> A category | |
| 81 | * determining what level of searching this field supports </td></tr> | |
| 82 | * <tr><td> displayorderpriority </td><td> Integer </td><td> If present, the | |
| 83 | * level at which lists of records are sorted by the field </td></tr> | |
| 84 | * <tr><td> sortdescending </td><td> Boolean </td><td> Whether when sorting | |
| 85 | * by this column, the sort order should be reversed </td></tr> | |
| 86 | * <tr><td> indexed </td><td> Boolean </td><td> Whether the field is indexed | |
| 87 | * (ignored if the field is marked `unique') </td></tr> | |
| 88 | * <tr><td> unique </td><td> Boolean </td><td> Whether the field is unique | |
| 89 | * (implies that it's `indexed') </td></tr> | |
| 90 | * <tr><td> integrityfix </td><td> StandardIntegrityFix </td><td> How | |
| 91 | * referential integrity is maintained, what to do when the object referred | |
| 92 | * to is deleted </td></tr> | |
| 93 | * </table> | |
| 94 | * | |
| 95 | * See org.melati.poem.prepro.TableDef#generateTableMainJava | |
| 96 | */ | |
| 97 | public class ColumnInfoTable<T extends ColumnInfo> extends ColumnInfoTableBase<T> { | |
| 98 | ||
| 99 | /** | |
| 100 | * Constructor. | |
| 101 | * | |
| 102 | * See org.melati.poem.prepro.TableDef#generateTableMainJava | |
| 103 | * @param database the POEM database we are using | |
| 104 | * @param name the name of this <code>Table</code> | |
| 105 | * @param definitionSource which definition is being used | |
| 106 | * @throws PoemException if anything goes wrong | |
| 107 | */ | |
| 108 | public ColumnInfoTable(Database database, String name, | |
| 109 | DefinitionSource definitionSource) | |
| 110 | throws PoemException { | |
| 111 | 64 | super(database, name, definitionSource); |
| 112 | 64 | } |
| 113 | ||
| 114 | // programmer's domain-specific code here | |
| 115 | ||
| 116 | } |