KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > access > types > AbstractType


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */

56 package org.objectstyle.cayenne.access.types;
57
58 import java.sql.CallableStatement JavaDoc;
59 import java.sql.PreparedStatement JavaDoc;
60 import java.sql.ResultSet JavaDoc;
61
62 import org.apache.commons.lang.builder.ToStringBuilder;
63 import org.objectstyle.cayenne.map.DbAttribute;
64 import org.objectstyle.cayenne.validation.ValidationResult;
65
66 /**
67  * A convenience superclass of ExtendedType implementations. Implements
68  * {@link #setJdbcObject(PreparedStatement, Object, int, int, int)}in a generic fashion
69  * by calling "setObject(..)" on PreparedStatement. Some adapters may need to override
70  * this behavior as it doesn't work consistently across all JDBC drivers.
71  *
72  * @author Andrei Adamchik
73  */

74 public abstract class AbstractType implements ExtendedType {
75
76     /**
77      * Calls "PreparedStatement.setObject(..)". Some DbAdapters may need to override this
78      * behavior for at least some of the object types, as it doesn't work consistently
79      * across all JDBC drivers.
80      */

81     public void setJdbcObject(
82             PreparedStatement JavaDoc st,
83             Object JavaDoc val,
84             int pos,
85             int type,
86             int precision) throws Exception JavaDoc {
87
88         if (precision != -1) {
89             st.setObject(pos, val, type, precision);
90         }
91         else {
92             st.setObject(pos, val, type);
93         }
94     }
95
96     public abstract String JavaDoc getClassName();
97
98     public abstract Object JavaDoc materializeObject(CallableStatement JavaDoc rs, int index, int type)
99             throws Exception JavaDoc;
100
101     public abstract Object JavaDoc materializeObject(ResultSet JavaDoc rs, int index, int type)
102             throws Exception JavaDoc;
103
104     /**
105      * Always returns true. Simplifies subclass implementation, as only some of the types
106      * can perform the validation.
107      */

108     public boolean validateProperty(
109             Object JavaDoc source,
110             String JavaDoc property,
111             Object JavaDoc value,
112             DbAttribute dbAttribute,
113             ValidationResult validationResult) {
114         return true;
115     }
116
117     public String JavaDoc toString() {
118         return new ToStringBuilder(this).append("className", getClassName()).toString();
119     }
120 }
121
Popular Tags