View Javadoc
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  package org.melati.poem;
46  
47  import org.melati.poem.generated.ValueInfoTableBase;
48  
49  /**
50   * Melati POEM generated, programmer modifiable stub 
51   * for a <code>ValueInfoTable</code> object.
52   *
53   * 
54   * <table> 
55   * <caption>
56   * Field summary for SQL table <code>ValueInfo</code>
57   * </caption>
58   * <tr><th>Name</th><th>Type</th><th>Description</th></tr>
59   * <tr><td> displayname </td><td> String </td><td> A user-friendly name for 
60   * the field </td></tr> 
61   * <tr><td> description </td><td> String </td><td> A brief description of the 
62   * field's function </td></tr> 
63   * <tr><td> usereditable </td><td> Boolean </td><td> Whether it makes sense 
64   * for the user to update the field's value </td></tr> 
65   * <tr><td> typefactory </td><td> PoemTypeFactory </td><td> The field's 
66   * Melati type </td></tr> 
67   * <tr><td> nullable </td><td> Boolean </td><td> Whether the field can be 
68   * empty </td></tr> 
69   * <tr><td> size </td><td> Integer </td><td> For character fields, the 
70   * maximum number of characters that can be stored, (-1 for unlimited) 
71   * </td></tr> 
72   * <tr><td> width </td><td> Integer </td><td> A sensible width for text boxes 
73   * used for entering the field, where appropriate </td></tr> 
74   * <tr><td> height </td><td> Integer </td><td> A sensible height for text 
75   * boxes used for entering the field, where appropriate </td></tr> 
76   * <tr><td> precision </td><td> Integer </td><td> Precision (total number of 
77   * digits) for fixed-point numbers </td></tr> 
78   * <tr><td> scale </td><td> Integer </td><td> Scale (number of digits after 
79   * the decimal) for fixed-point numbers </td></tr> 
80   * <tr><td> renderinfo </td><td> String </td><td> The name of the Melati 
81   * templet (if not the default) to use for input controls for the field 
82   * </td></tr> 
83   * <tr><td> rangelow_string </td><td> String </td><td> The low end of the 
84   * range of permissible values for the field </td></tr> 
85   * <tr><td> rangelimit_string </td><td> String </td><td> The (exclusive) 
86   * limit of the range of permissible values for the field </td></tr> 
87   * </table> 
88   * 
89   * See  org.melati.poem.prepro.TableDef#generateTableMainJava 
90   */
91  public class ValueInfoTable<T extends ValueInfo> extends ValueInfoTableBase<T> {
92  
93   /**
94    * Constructor.
95    * 
96    * See org.melati.poem.prepro.TableDef#generateTableMainJava 
97    * @param database          the POEM database we are using
98    * @param name              the name of this <code>Table</code>
99    * @param definitionSource  which definition is being used
100   * @throws PoemException    if anything goes wrong
101   */
102   public ValueInfoTable(
103       Database database, String name,
104       DefinitionSource definitionSource) throws PoemException {
105     super(database, name, definitionSource);
106   }
107 
108   // programmer's domain-specific code here
109 }