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 At 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  
50  /**
51   * A definition of a <tt>BinaryPoemType</tt> from the DSD.
52   * 
53   * Its member variables are populated from the DSD or defaults. Its methods are
54   * used to generate the java code.
55   */
56  public class BinaryFieldDef extends AtomFieldDef {
57  
58    int size;
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 part of
65     * @param name         the name of this field
66     * @param displayOrder where to place this field in a list
67     * @param qualifiers   all the qualifiers of this field
68     * @throws IllegalityException if a semantic inconsistency is detected
69     */
70    public BinaryFieldDef(int lineNo, TableDef table, String name,
71        int displayOrder, Vector<FieldQualifier> qualifiers) throws IllegalityException {
72      super(lineNo, table, name, "byte[]", displayOrder, qualifiers);
73      if (size == 0)
74        throw new BinarySizeZeroException(this);
75      if (searchability == "yes")
76        throw new BinarySearchableException(this);
77      table.addImport("org.melati.poem.BinaryPoemType", "table");
78    }
79  
80    /** @return the Java string for this <code>PoemType</code>. */
81    public String poemTypeJava() {
82      return "new BinaryPoemType(" + isNullable() + ", " + size + ")";
83    }
84  
85    /**
86     * Get the size.
87     * @return the size
88     */
89    public int getSize() {
90      return size;
91    }
92  
93    /**
94     * Set the size property. 
95     * @param size the size to set 
96     */
97    public void setSize(int size) {
98      if (this.size != 0)
99        throw new IllegalityException(lineNumber,
100           "Binary field size already set to " + this.size + 
101           " cannot overwrite with " + size);
102     this.size = size;
103   }
104 }