RowProcessor


1   /*
2    * $Header: /home/cvs/jakarta-commons/dbutils/src/java/org/apache/commons/dbutils/RowProcessor.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) 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  ;
65  import java.sql.SQLException  ;
66  import java.util.List  ;
67  import java.util.Map  ;
68  
69  /**
70   * <code>RowProcessor</code> implementations convert 
71   * <code>ResultSet</code> rows into various other objects.  Implementations
72   * can extend <code>BasicRowProcessor</code> to protect themselves
73   * from changes to this interface. 
74   * 
75   * @see BasicRowProcessor
76   * @author David Graham
77   */
78  public interface RowProcessor {
79  
80      /**
81       * Create an <code>Object[]</code> from the column values in one 
82       * <code>ResultSet</code> row.  The <code>ResultSet</code> should be 
83       * positioned on a valid row before passing it to this method.  
84       * Implementations of this method must not alter the row position of 
85       * the <code>ResultSet</code>. 
86       */
87      public Object  [] toArray(ResultSet   rs) throws SQLException  ;
88  
89      /**
90       * Create a JavaBean from the column values in one <code>ResultSet</code> 
91       * row.  The <code>ResultSet</code> should be positioned on a valid row before
92       * passing it to this method.  Implementations of this method must not
93       * alter the row position of the <code>ResultSet</code>.
94       */
95      public Object   toBean(ResultSet   rs, Class   type) throws SQLException  ;
96  
97      /**
98       * Create a <code>List</code> of JavaBeans from the column values in all 
99       * <code>ResultSet</code> rows.  <code>ResultSet.next()</code> should 
100      * <strong>not</strong> be called before passing it to this method.
101      * 
102      * @return A <code>List</code> of beans with the given type in the order 
103      * they were returned by the <code>ResultSet</code>.
104      */
105     public List   toBeanList(ResultSet   rs, Class   type) throws SQLException  ;
106 
107     /**
108      * Create a <code>Map</code> from the column values in one 
109      * <code>ResultSet</code> row.  The <code>ResultSet</code> should be 
110      * positioned on a valid row before
111      * passing it to this method.  Implementations of this method must not
112      * alter the row position of the <code>ResultSet</code>.
113      */
114     public Map   toMap(ResultSet   rs) throws SQLException  ;
115 
116 }
117
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags