commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dgra...@apache.org
Subject cvs commit: jakarta-commons-sandbox/dbutils/src/java/org/apache/commons/dbutils BeanListHandler.java
Date Sat, 18 Oct 2003 01:00:31 GMT
dgraham     2003/10/17 18:00:31

  Added:       dbutils/src/java/org/apache/commons/dbutils
                        BeanListHandler.java
  Log:
  Renamed BeanCollectionHandler to BeanListHandler because ResultSets
  are always sorted in some order.  Clients must be able to depend on 
  the order of beans being the same as the order of rows.
  
  Also, added ability to specify the processor to use when converting
  rows into beans.
  
  Revision  Changes    Path
  1.1                  jakarta-commons-sandbox/dbutils/src/java/org/apache/commons/dbutils/BeanListHandler.java
  
  Index: BeanListHandler.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons-sandbox/dbutils/src/java/org/apache/commons/dbutils/BeanListHandler.java,v
1.1 2003/10/18 01:00:31 dgraham Exp $
   * $Revision: 1.1 $
   * $Date: 2003/10/18 01:00:31 $
   * 
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowledgement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgement may appear in the software itself,
   *    if and wherever such third-party acknowledgements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  package org.apache.commons.dbutils;
  
  import java.sql.ResultSet;
  import java.sql.SQLException;
  
  /**
   * <code>ResultSetHandler</code> implementation that converts the first 
   * <code>ResultSet</code> column into an Object.
   * 
   * @see ResultSetHandler
   * 
   * @author Juozas Baliuka
   * @author David Graham
   */
  public class BeanListHandler implements ResultSetHandler {
  
      /**
       * The Class of beans produced by this handler.
       */
      private Class type = null;
      
      /**
       * The ResultSetConverter implementation to use when converting rows 
       * into beans.
       */
      private ResultSetConverter convert = BasicResultSetConverter.instance();
  
      /** 
       * Creates a new instance of BeanListHandler.
       * 
       * @param type The Class that objects returned from <code>handle()</code>
       * are created from.
       */
      public BeanListHandler(Class type) {
          this.type = type;
      }
      
      /** 
       * Creates a new instance of BeanListHandler.
       * 
       * @param type The Class that objects returned from <code>handle()</code>
       * are created from.
       * @param convert The <code>ResultSetConverter</code> implementation 
       * to use when converting rows into beans.
       */
      public BeanListHandler(Class type, ResultSetConverter convert) {
          this.type = type;
          this.convert = convert;
      }
  
      /**
       * Convert the <code>ResultSet</code> rows into a <code>List</code>
of 
       * beans with the <code>Class</code> given in the constructor.
       * 
       * @return A <code>List</code> of beans (one for each row), never 
       * <code>null</code>.
       * 
       * @throws SQLException
       * @see org.apache.commons.dbutils.ResultSetHandler#handle(java.sql.ResultSet, java.lang.Object[],
java.lang.Object)
       */
      public Object handle(ResultSet rs, Object[] params, Object userObject)
          throws SQLException {
              
          return this.convert.toBeanList(rs, type);
      }
  
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message