View Javadoc

1   /*
2    * $Source: /usr/cvsroot/melati/maven-dsd-plugin/src/main/java/org/melati/poem/prepro/IntegerFieldDef.java,v $
3    * $Revision: 1.20 $
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 an <tt>IntegerPoemType</tt> from the DSD.
54   * This type is the base for all the metadata field types.
55   * 
56   * Its member variables are populated from the DSD or defaults.
57   * Its methods are used to generate the java code.
58   */ 
59  public class IntegerFieldDef extends AtomFieldDef {
60  
61   /**
62    * Constructor.
63    *
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 IntegerFieldDef(int lineNo, TableDef table, String name, int displayOrder,
73                           Vector<FieldQualifier> qualifiers) throws IllegalityException {
74      super(lineNo, table, name, "Integer", displayOrder, qualifiers);
75      if (isTroidColumn())
76        table.addImport("org.melati.poem.TroidPoemType", 
77                        "table");
78      else
79        table.addImport("org.melati.poem.IntegerPoemType", 
80                        "table");
81    }
82  
83   /**
84    * @param w The base persistent java file.
85    * @throws IOException 
86    *           if something goes wrong with the file system
87    */   
88    public void generateBaseMethods(Writer w) throws IOException {
89      super.generateBaseMethods(w);
90  
91      w.write(
92        "\n /**\n"
93        + "  * Sets the <code>" 
94        + capitalisedName 
95        + "</code> value, with checking, for this \n"
96        + "  * <code>" 
97        + table.nameFromDsd 
98        + "</code> <code>Persistent</code>.\n"
99        + ((description != null) ?   "  * Field description: \n" 
100                                  + DSD.javadocFormat(2, 3, description)
101                                  + "  * \n"
102                                : "")
103       + "  * \n"
104       + "  * Generated by " 
105       + this.getClass().getName()
106       + "#generateBaseMethods \n"
107       + "  * @param cooked  a validated <code>int</code>\n"
108       + "  * @throws AccessPoemException \n"
109       + "  *         if the current <code>AccessToken</code> \n"
110       + "  *         does not confer write access rights\n"
111       + "  * @throws ValidationPoemException \n"
112       + "  *         if the value is not valid\n"
113       + "  */\n");
114     w.write("\n" +
115             "  public final void set" + capitalisedName + "(int cooked)\n" +
116             "      throws AccessPoemException, ValidationPoemException {\n" +
117             "    set" + capitalisedName + "(new Integer(cooked));\n" +
118             "  }\n");
119   }
120 
121  /** @return the Java string for this <code>PoemType</code>. */
122   public String poemTypeJava() {
123     return isTroidColumn() ? "new TroidPoemType()" : super.poemTypeJava();
124   }
125 }