KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > dbutils > handlers > MapHandler


1 /*
2  * $Header: /home/cvs/jakarta-commons/dbutils/src/java/org/apache/commons/dbutils/handlers/MapHandler.java,v 1.1 2003/11/02 19:15:24 dgraham Exp $
3  * $Revision: 1.1 $
4  * $Date: 2003/11/02 19:15:24 $
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 2003 The Apache Software Foundation. All rights
11  * reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in
22  * the documentation and/or other materials provided with the
23  * distribution.
24  *
25  * 3. The end-user documentation included with the redistribution, if
26  * any, must include the following acknowledgement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowledgement may appear in the software itself,
30  * if and wherever such third-party acknowledgements normally appear.
31  *
32  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33  * Foundation" must not be used to endorse or promote products derived
34  * from this software without prior written permission. For written
35  * permission, please contact apache@apache.org.
36  *
37  * 5. Products derived from this software may not be called "Apache"
38  * nor may "Apache" appear in their names without prior written
39  * permission of the Apache Software Foundation.
40  *
41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This software consists of voluntary contributions made by many
56  * individuals on behalf of the Apache Software Foundation. For more
57  * information on the Apache Software Foundation, please see
58  * <http://www.apache.org/>.
59  *
60  */
61
62 package org.apache.commons.dbutils.handlers;
63
64 import java.sql.ResultSet JavaDoc;
65 import java.sql.SQLException JavaDoc;
66
67 import org.apache.commons.dbutils.BasicRowProcessor;
68 import org.apache.commons.dbutils.ResultSetHandler;
69 import org.apache.commons.dbutils.RowProcessor;
70
71 /**
72  * <code>ResultSetHandler</code> implementation that converts the first
73  * <code>ResultSet</code> row into a <code>Map</code>. This class is thread
74  * safe.
75  *
76  * @see ResultSetHandler
77  * @author Juozas Baliuka
78  * @author David Graham
79  */
80 public class MapHandler implements ResultSetHandler {
81
82     /**
83      * The RowProcessor implementation to use when converting rows
84      * into Maps.
85      */
86     private RowProcessor convert = BasicRowProcessor.instance();
87
88     /**
89      * Creates a new instance of MapHandler using a
90      * <code>BasicRowProcessor</code> for conversion.
91      */
92     public MapHandler() {
93         super();
94     }
95
96     /**
97      * Creates a new instance of MapHandler.
98      *
99      * @param convert The <code>RowProcessor</code> implementation
100      * to use when converting rows into Maps.
101      */
102     public MapHandler(RowProcessor convert) {
103         super();
104         this.convert = convert;
105     }
106
107     /**
108      * Converts the first row in the <code>ResultSet</code> into a
109      * <code>Map</code>.
110      *
111      * @return A <code>Map</code> with the values from the first row or
112      * <code>null</code> if there are no rows in the <code>ResultSet</code>.
113      *
114      * @throws SQLException
115      *
116      * @see org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet)
117      */
118     public Object JavaDoc handle(ResultSet JavaDoc rs) throws SQLException JavaDoc {
119         return rs.next() ? this.convert.toMap(rs) : null;
120     }
121
122 }
123
Popular Tags