KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > dbutils > ResultSetIterator


1 /*
2  * $Header: /home/cvs/jakarta-commons/dbutils/src/java/org/apache/commons/dbutils/ResultSetIterator.java,v 1.1 2003/11/02 19:15:23 dgraham Exp $
3  * $Revision: 1.1 $
4  * $Date: 2003/11/02 19:15:23 $
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 2002-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;
63
64 import java.sql.ResultSet JavaDoc;
65 import java.sql.SQLException JavaDoc;
66 import java.util.Iterator JavaDoc;
67
68 /**
69  * <p>
70  * Wraps a <code>ResultSet</code> in an <code>Iterator</code>. This is useful
71  * when you want to present a non-database application layer with domain
72  * neutral data.
73  * </p>
74  *
75  * <p>
76  * This implementation requires the <code>ResultSet.isLast()</code> method
77  * to be implemented.
78  * </p>
79  *
80  * @author Henri Yandell
81  * @author David Graham
82  */
83 public class ResultSetIterator implements Iterator JavaDoc {
84
85     /**
86      * The wrapped <code>ResultSet</code>.
87      */
88     private ResultSet JavaDoc rs = null;
89     
90     /**
91      * The processor to use when converting a row into an Object[].
92      */
93     private RowProcessor convert = BasicRowProcessor.instance();
94
95     /**
96      * Constructor for ResultSetIterator.
97      * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>.
98      */
99     public ResultSetIterator(ResultSet JavaDoc rs) {
100         this.rs = rs;
101     }
102     
103     /**
104      * Constructor for ResultSetIterator.
105      * @param rs Wrap this <code>ResultSet</code> in an <code>Iterator</code>.
106      * @param convert The processor to use when converting a row into an
107      * <code>Object[]</code>. Defaults to a
108      * <code>BasicRowProcessor</code>.
109      */
110     public ResultSetIterator(ResultSet JavaDoc rs, RowProcessor convert) {
111         this.rs = rs;
112         this.convert = convert;
113     }
114
115     public boolean hasNext() {
116         try {
117             return !rs.isLast();
118
119         } catch (SQLException JavaDoc e) {
120             // TODO Logging?
121 //e.printStackTrace();
122 return false;
123         }
124     }
125
126     /**
127      * Returns the next row as an <code>Object[]</code>.
128      * @return An <code>Object[]</code> with the same number of elements as
129      * columns in the <code>ResultSet</code>.
130      * @see java.util.Iterator#next()
131      */
132     public Object JavaDoc next() {
133         try {
134             rs.next();
135             return this.convert.toArray(rs);
136
137         } catch (SQLException JavaDoc e) {
138             // TODO Logging?
139 //e.printStackTrace();
140 return null;
141         }
142     }
143
144     /**
145      * Deletes the current row from the <code>ResultSet</code>.
146      * @see java.util.Iterator#remove()
147      */
148     public void remove() {
149         try {
150             this.rs.deleteRow();
151
152         } catch (SQLException JavaDoc e) {
153             // TODO Logging?
154 //e.printStackTrace();
155 }
156     }
157
158 }
159
Popular Tags