| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| GroupTable |
|
| 1.5;1.5 |
| 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.GroupTableBase; | |
| 49 | ||
| 50 | /** | |
| 51 | * The {@link Table} of {@link Group}s. | |
| 52 | * | |
| 53 | * Every Melati DB has this table. | |
| 54 | * This table will contain at least | |
| 55 | * <code>Melati database administrators</code>. | |
| 56 | * | |
| 57 | * Melati POEM generated, programmer modifiable stub | |
| 58 | * for a <code>GroupTable</code> object. | |
| 59 | * <p> | |
| 60 | * Description: | |
| 61 | * A group to which registered users of the database can belong. | |
| 62 | * </p> | |
| 63 | * | |
| 64 | * | |
| 65 | * <table> | |
| 66 | * <caption> | |
| 67 | * Field summary for SQL table <code>Group</code> | |
| 68 | * </caption> | |
| 69 | * <tr><th>Name</th><th>Type</th><th>Description</th></tr> | |
| 70 | * <tr><td> id </td><td> Integer </td><td> The Table Row Object ID </td></tr> | |
| 71 | * <tr><td> name </td><td> String </td><td> A human-readable name for the | |
| 72 | * group </td></tr> | |
| 73 | * </table> | |
| 74 | * | |
| 75 | * See org.melati.poem.prepro.TableDef#generateTableMainJava | |
| 76 | */ | |
| 77 | public class GroupTable<T extends Group> extends GroupTableBase<T> { | |
| 78 | ||
| 79 | /** | |
| 80 | * Constructor. | |
| 81 | * | |
| 82 | * See org.melati.poem.prepro.TableDef#generateTableMainJava | |
| 83 | * @param database the POEM database we are using | |
| 84 | * @param name the name of this <code>Table</code> | |
| 85 | * @param definitionSource which definition is being used | |
| 86 | * @throws PoemException if anything goes wrong | |
| 87 | */ | |
| 88 | public GroupTable( | |
| 89 | Database database, String name, | |
| 90 | DefinitionSource definitionSource) throws PoemException { | |
| 91 | 64 | super(database, name, definitionSource); |
| 92 | 64 | } |
| 93 | ||
| 94 | // programmer's domain-specific code here | |
| 95 | ||
| 96 | private Group administratorsGroup; | |
| 97 | ||
| 98 | /** | |
| 99 | * @return the Group to which administrators belong | |
| 100 | */ | |
| 101 | public Group administratorsGroup() { | |
| 102 | 83 | return administratorsGroup; |
| 103 | } | |
| 104 | ||
| 105 | public void postInitialise() { | |
| 106 | 41 | super.postInitialise(); |
| 107 | ||
| 108 | 41 | administratorsGroup = ensure("Melati database administrators"); |
| 109 | ||
| 110 | 41 | } |
| 111 | ||
| 112 | /** | |
| 113 | * Make sure that a record exists. | |
| 114 | * | |
| 115 | * @param name the name of the {@link Group} to ensure | |
| 116 | * @return the existing or newly created {@link Group} | |
| 117 | */ | |
| 118 | public Group ensure(String name) { | |
| 119 | 47 | Group group = (Group)getNameColumn().firstWhereEq(name); |
| 120 | 47 | if (group != null) |
| 121 | 21 | return group; |
| 122 | else { | |
| 123 | 26 | group = (Group)newPersistent(); |
| 124 | 26 | group.setName(name); |
| 125 | 26 | return (Group)getNameColumn().ensure(group); |
| 126 | } | |
| 127 | } | |
| 128 | ||
| 129 | } |