KickJava   Java API By Example, From Geeks To Geeks.

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


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.objectstyle.cayenne.map.DbAttribute;
63 import org.objectstyle.cayenne.validation.ValidationResult;
64
65 /**
66  * Defines methods to read Java objects from JDBC ResultSets and write as parameters of
67  * PreparedStatements.
68  *
69  * @author Andrei Adamchik
70  */
71 public interface ExtendedType {
72
73     /**
74      * Returns a full name of Java class that this ExtendedType supports.
75      */
76     String JavaDoc getClassName();
77
78     /**
79      * Performs validation of an object property. Property is considered valid if this it
80      * satisfies the database constraints known to this ExtendedType. In case of
81      * validation failure, failures are appended to the ValidationResult object and
82      * <code>false</code> is returned.
83      *
84      * @since 1.1
85      */
86     boolean validateProperty(
87             Object JavaDoc source,
88             String JavaDoc property,
89             Object JavaDoc value,
90             DbAttribute dbAttribute,
91             ValidationResult validationResult);
92
93     /**
94      * Initializes a single parameter of a PreparedStatement with object value.
95      */
96     void setJdbcObject(
97             PreparedStatement JavaDoc statement,
98             Object JavaDoc value,
99             int pos,
100             int type,
101             int precision) throws Exception JavaDoc;
102
103     /**
104      * Reads an object from JDBC ResultSet column, converting it to class returned by
105      * 'getClassName' method.
106      *
107      * @throws Exception if read error ocurred, or an object can't be converted to a
108      * target Java class.
109      */
110     Object JavaDoc materializeObject(ResultSet JavaDoc rs, int index, int type) throws Exception JavaDoc;
111
112     /**
113      * Reads an object from a stored procedure OUT parameter, converting it to class
114      * returned by 'getClassName' method.
115      *
116      * @throws Exception if read error ocurred, or an object can't be converted to a
117      * target Java class.
118      */
119     Object JavaDoc materializeObject(CallableStatement JavaDoc rs, int index, int type) throws Exception JavaDoc;
120 }
121
Popular Tags