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.PreparedStatement;
49  import java.sql.ResultSet;
50  import java.sql.SQLException;
51  import java.sql.Types;
52  
53  import org.apache.commons.codec.binary.Base64;
54  import org.melati.poem.dbms.Dbms;
55  import org.melati.poem.util.StringUtils;
56  
57  /**
58   * A <tt>Blob</tt> {@link Field} type.
59   */
60  public class BinaryPoemType extends SizedAtomPoemType<byte[]> {
61   
62    /**
63     * Constructor.
64     * @param nullable whether nullable
65     * @param size how big
66     */
67    public BinaryPoemType(boolean nullable, int size) {
68      super(Types.VARBINARY, "VARBINARY", nullable, size);
69    }
70  
71    protected void _assertValidRaw(Object raw)
72        throws ValidationPoemException {
73      if (raw != null) {
74        if (!(raw instanceof byte[]))
75          throw new TypeMismatchPoemException(raw, this);
76        if (!sizeGreaterEqual(getSize(), ((byte[])raw).length))
77          throw new BinaryLengthValidationPoemException(this, (byte[])raw);
78      }
79    }
80  
81    protected String _stringOfRaw(Object raw) {
82      return new String(Base64.encodeBase64((byte[])raw));
83    }
84  
85    protected byte[] _getRaw(ResultSet rs, int col) throws SQLException {
86      return rs.getBytes(col);
87    }
88  
89    protected void _setRaw(PreparedStatement ps, int col, Object string)
90        throws SQLException {
91      ps.setBytes(col, (byte[])string);
92    }
93  
94    protected byte[] _rawOfString(String rawString) {
95      return Base64.decodeBase64(rawString.getBytes());
96    }
97  
98    protected String _sqlDefinition(Dbms dbms) {
99      try {
100       return dbms.getBinarySqlDefinition(getSize());
101     } catch (SQLException e) {
102       throw new SQLSeriousPoemException(e);
103     }
104   }
105 
106   protected boolean _canRepresent(SQLPoemType<?> other) {
107     return 
108         sqlTypeCode() == other.sqlTypeCode() && 
109         other instanceof BinaryPoemType &&
110         sizeGreaterEqual(getSize(), ((BinaryPoemType)other).getSize());
111   }
112 
113   /**
114    * {@inheritDoc}
115    * @see org.melati.poem.BasePoemType#toString()
116    */
117   public String toString() {
118     return (getNullable() ? "nullable " : "") + "binary(" + getSize() + ")";
119   }
120 
121   /**
122    * {@inheritDoc}
123    * @see org.melati.poem.PoemType#toDsdType()
124    */
125   public String toDsdType() {
126     return "byte[]";
127   }
128 
129   protected void _saveColumnInfo(ColumnInfo columnInfo)
130       throws AccessPoemException {
131     columnInfo.setTypefactory(PoemTypeFactory.BINARY);
132     columnInfo.setSize(getSize());
133   }
134 
135   protected String _quotedRaw(Object raw) {
136     return StringUtils.quoted(_stringOfRaw(raw), '\'');
137   }
138 
139 }
140 
141