1 /*
2 * $Source: /usr/cvsroot/melati/maven-dsd-plugin/src/main/java/org/melati/poem/prepro/BooleanFieldDef.java,v $
3 * $Revision: 1.21 $
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.prepro;
47
48 import java.util.Vector;
49 import java.io.Writer;
50 import java.io.IOException;
51
52 /**
53 * A definition of a <tt>BooleanPoemType</tt> from the DSD.
54 *
55 * Its member variables are populated from the DSD or defaults.
56 * Its methods are used to generate the java code.
57 */
58 public class BooleanFieldDef extends AtomFieldDef {
59
60 /**
61 * Constructor.
62 *
63 * @param lineNo the line number in the DSD file
64 * @param table the {@link TableDef} that this <code>Field</code> is
65 * part of
66 * @param name the name of this field
67 * @param displayOrder where to place this field in a list
68 * @param qualifiers all the qualifiers of this field
69 *
70 * @throws IllegalityException if a semantic inconsistency is detected
71 */
72 public BooleanFieldDef(int lineNo, TableDef table, String name, int displayOrder,
73 Vector<FieldQualifier> qualifiers) throws IllegalityException {
74 super(lineNo, table, name, "Boolean", displayOrder, qualifiers);
75 if (isDeletedColumn())
76 table.addImport("org.melati.poem.DeletedPoemType",
77 "table");
78 else
79 table.addImport("org.melati.poem.BooleanPoemType",
80 "table");
81 }
82
83 /**
84 * Write out this <code>Column</code>'s base methods.
85 *
86 * @param w The base persistent java file.
87 * @throws IOException
88 * if something goes wrong with the file system
89 */
90 public void generateBaseMethods(Writer w) throws IOException {
91 super.generateBaseMethods(w);
92 w.write(
93 "\n /**\n"
94 + " * Sets the <code>"
95 + capitalisedName
96 + "</code> value, with checking, \n"
97 + " * from a <code>boolean</code>, for this \n"
98 + " * <code>"
99 + table.nameFromDsd
100 + "</code> <code>Persistent</code>.\n"
101 + ((description != null) ? " * Field description: \n"
102 + DSD.javadocFormat(2, 3, description)
103 + " * \n"
104 : "")
105 + " * \n"
106 + " * Generated by "
107 + "org.melati.poem.prepro.BooleanFieldDef"
108 + "#generateBaseMethods \n"
109 + " * @param cooked a <code>boolean</code> \n"
110 + " * @throws AccessPoemException \n"
111 + " * if the current <code>AccessToken</code> \n"
112 + " * does not confer write access rights\n"
113 + " * @throws ValidationPoemException \n"
114 + " * if the value is not valid\n"
115 + " */\n");
116 w.write("\n" +
117 " public final void set" + capitalisedName + "(boolean cooked)\n" +
118 " throws AccessPoemException, ValidationPoemException {\n" +
119 " set" + capitalisedName + "(cooked ? Boolean.TRUE : Boolean.FALSE);\n" +
120 " }\n");
121 }
122
123 /** @return the Java string for this <code>PoemType</code>. */
124 public String poemTypeJava() {
125 return isDeletedColumn() ? "new DeletedPoemType()" : super.poemTypeJava();
126 }
127 }