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 java.util.Enumeration;
49
50 import org.melati.poem.generated.GroupMembershipTableBase;
51
52 /**
53 * The {@link Table} of {@link GroupMembership}s.
54 *
55 * Every Melati DB has this table.
56 * This table will contain at least the tuple
57 * <code>_administrator_</code>:<code>Melati database administrators</code>.
58 *
59 * Melati POEM generated, programmer modifiable stub
60 * for a <code>GroupMembershipTable</code> object.
61 * <p>
62 * Description:
63 * A record that a given user is a member of a given group.
64 * </p>
65 *
66 *
67 * <table>
68 * <caption>
69 * Field summary for SQL table <code>GroupMembership</code>
70 * </caption>
71 * <tr><th>Name</th><th>Type</th><th>Description</th></tr>
72 * <tr><td> id </td><td> Integer </td><td> The Table Row Object ID </td></tr>
73 * <tr><td> user </td><td> User </td><td> The user who belongs to the group
74 * </td></tr>
75 * <tr><td> group </td><td> Group </td><td> The group to which the user
76 * belongs </td></tr>
77 * </table>
78 *
79 * See org.melati.poem.prepro.TableDef#generateTableMainJava
80 */
81
82 public class GroupMembershipTable<T extends GroupMembership> extends GroupMembershipTableBase<T> {
83
84 /**
85 * Constructor.
86 *
87 * See org.melati.poem.prepro.TableDef#generateTableMainJava
88 * @param database the POEM database we are using
89 * @param name the name of this <code>Table</code>
90 * @param definitionSource which definition is being used
91 * @throws PoemException if anything goes wrong
92 */
93 public GroupMembershipTable(
94 Database database, String name,
95 DefinitionSource definitionSource) throws PoemException {
96 super(database, name, definitionSource);
97 }
98
99 // programmer's domain-specific code here
100
101 public void postInitialise() {
102 super.postInitialise();
103
104 Database d = getDatabase();
105 GroupMembership admin = (GroupMembership)newPersistent();
106 admin.setUser(d.getUserTable().administratorUser());
107 admin.setGroup(d.getGroupTable().administratorsGroup());
108 if (!exists(admin))
109 create(admin);
110 }
111 /**
112 * Make sure that a record exists.
113 *
114 * @return the existing or newly created {@link GroupMembership}
115 */
116 public GroupMembership ensure(Group group, User user) {
117 GroupMembership p = (GroupMembership)newPersistent();
118 p.setGroup(group);
119 p.setUser(user);
120 Enumeration<T> them = selection(p);
121 if (them.hasMoreElements())
122 return them.nextElement();
123 else {
124 p.makePersistent();
125 return p;
126 }
127 }
128
129
130 }