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;
47  
48  import java.sql.ResultSet;
49  import java.sql.PreparedStatement;
50  import java.sql.Types;
51  import java.sql.SQLException;
52  import java.util.Enumeration;
53  import org.melati.poem.util.LongEnumeration;
54  import org.melati.poem.dbms.Dbms;
55  
56  /**
57   * Normal longs: <code>INT8</code>.
58   */
59  public class LongPoemType extends AtomPoemType<Long> {
60  
61    /** Instance of a nullable LongPoemType. */
62    public static final LongPoemType nullableInstance = new LongPoemType(true);
63  
64    /**
65     * Constructor.
66     * @param nullable whether null is an allowed value
67     */
68    public LongPoemType(boolean nullable) {
69      super(Types.BIGINT, "INT8", nullable); 
70    }
71  
72    protected LongPoemType(int sqlTypeCode, String sqlTypeName,
73                           boolean nullable) {
74      super(sqlTypeCode, sqlTypeName, nullable);
75    }
76  
77    /**
78     * TODO Do down-counting??
79     */
80    protected Enumeration<Long> _possibleRaws() {
81      Long low = (Long)getLowRaw();
82      Long limit = (Long)getLimitRaw();
83      return low == null ?
84          null :
85          new LongEnumeration(low.longValue(),
86                              limit == null ?
87                                  Long.MAX_VALUE : limit.longValue());
88    }
89  
90    protected void _assertValidRaw(Object raw) {
91      if (raw != null && !(raw instanceof Long))
92        throw new TypeMismatchPoemException(raw, this);
93    }
94  
95    protected Long _getRaw(ResultSet rs, int col) throws SQLException {
96      synchronized (rs) {
97        long i = rs.getLong(col);
98        return i == 0 && rs.wasNull() ? null : new Long(i); }
99    }
100 
101   protected void _setRaw(PreparedStatement ps, int col, Object integer)
102       throws SQLException {
103     ps.setLong(col, ((Long)integer).longValue());
104   }
105 
106   protected Long _rawOfString(String rawString)
107       throws ParsingPoemException {
108     try {
109       return new Long(rawString);
110     }
111     catch (NumberFormatException e) {
112       throw new ParsingPoemException(this, rawString, e);
113     }
114   }
115 
116   protected String _sqlDefinition(Dbms dbms) {
117       return dbms.getLongSqlDefinition();
118   }
119 
120 
121   /** 
122    * Longs can represent Integers.
123    *  
124    * {@inheritDoc}
125    * @see org.melati.poem.BasePoemType#_canRepresent(org.melati.poem.SQLPoemType)
126    */
127   protected boolean _canRepresent(SQLPoemType<?> other) {
128     // Sql type code is not checked
129     if (other instanceof LongPoemType) 
130       return true;
131     return other instanceof IntegerPoemType;
132   }
133 
134   /**
135    * {@inheritDoc}
136    * @see org.melati.poem.PoemType#toDsdType()
137    */
138   public String toDsdType() {
139     return "Long";
140   }
141 
142   protected void _saveColumnInfo(ColumnInfo columnInfo)
143       throws AccessPoemException {
144     columnInfo.setTypefactory(PoemTypeFactory.LONG);
145   }
146 
147 }