KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > controls > system > jdbc > ResultSetMapper


1 /*
2  * Copyright 2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  * $Header:$
17  */
18 package org.apache.beehive.controls.system.jdbc;
19
20 import org.apache.beehive.controls.api.context.ControlBeanContext;
21
22 import java.lang.reflect.Method JavaDoc;
23 import java.sql.ResultSet JavaDoc;
24 import java.util.Calendar JavaDoc;
25
26 /**
27  * Extend this class to create new ResultSet mappers. The extended class will be invoked by the JdbcController
28  * when it is time to map a ResultSet to a method's return type.
29  *
30  * ResultSet mappers are specified on a per method basis using the SQL annotation's resultSetMapper field.
31  */
32 public abstract class ResultSetMapper {
33
34     /**
35      * Map a ResultSet to an object type
36      *
37      * @param context A ControlBeanContext instance, see Beehive controls javadoc for additional information
38      * @param m Method assoicated with this call.
39      * @param resultSet Result set to map.
40      * @param cal A Calendar instance for time/date value resolution.
41      * @return The Object resulting from the ResultSet
42      */
43     public abstract Object JavaDoc mapToResultType(ControlBeanContext context, Method JavaDoc m, ResultSet JavaDoc resultSet, Calendar JavaDoc cal);
44
45     /**
46      * Can the ResultSet which this mapper uses be closed by the Jdbc control?
47      * @return true if the ResultSet can be closed by the JdbcControl
48      */
49     public boolean canCloseResultSet() { return true; }
50 }
51
Popular Tags