Return-Path: 
 <cocoon-cvs-return-7766-apmail-xml-cocoon-cvs-archive=xml.apache.org@xml.apache.org>
Delivered-To: apmail-xml-cocoon-cvs-archive@xml.apache.org
Received: (qmail 83416 invoked by uid 500); 2 Jul 2002 08:17:48 -0000
Mailing-List: contact cocoon-cvs-help@xml.apache.org; run by ezmlm
Precedence: bulk
Reply-To: cocoon-dev@xml.apache.org
list-help: <mailto:cocoon-cvs-help@xml.apache.org>
list-unsubscribe: <mailto:cocoon-cvs-unsubscribe@xml.apache.org>
list-post: <mailto:cocoon-cvs@xml.apache.org>
Delivered-To: mailing list cocoon-cvs@xml.apache.org
Received: (qmail 83407 invoked by uid 500); 2 Jul 2002 08:17:48 -0000
Delivered-To: apmail-xml-cocoon2-cvs@apache.org
Date: 2 Jul 2002 08:17:47 -0000
Message-ID: <20020702081747.99361.qmail@icarus.apache.org>
From: haul@apache.org
To: xml-cocoon2-cvs@apache.org
Subject: cvs commit: xml-cocoon2/src/java/org/apache/cocoon/acting/modular
 DatabaseQueryAction.java
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

haul        2002/07/02 01:17:46

  Added:       src/java/org/apache/cocoon/acting/modular
                        DatabaseQueryAction.java
  Log:
    <action dev="CH" type="add">
     New DatabaseAction: DatabaseQueryAction. It works like the other modular
     DatabaseActions but does not auto-generate the query. The query has to be
     provided conforming to PreparedStatement syntax. Unlike the name might
     suggest, it can be a select, update, or delete query.
    </action>
  
  Revision  Changes    Path
  1.1                  xml-cocoon2/src/java/org/apache/cocoon/acting/modular/DatabaseQueryAction.java
  
  Index: DatabaseQueryAction.java
  ===================================================================
  /*
  
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
  
   Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modifica-
   tion, 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  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
  
   4. The names "Apache Cocoon" 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 name,  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 (INCLU-
   DING, 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 and was  originally created by
   Stefano Mazzocchi  <stefano@apache.org>. For more  information on the Apache
   Software Foundation, please see <http://www.apache.org/>.
  
  */
  
  package org.apache.cocoon.acting.modular;
  
  import java.util.Map;
  import java.sql.Connection;
  import java.sql.Clob;
  import java.sql.PreparedStatement;
  import java.sql.ResultSet;
  import java.sql.SQLException;
  import java.sql.Struct;
  import java.sql.Types;
  
  import java.io.InputStream;
  import java.io.BufferedInputStream;
  
  import org.apache.cocoon.util.HashMap;
  
  import org.apache.avalon.framework.component.ComponentException;
  import org.apache.avalon.framework.configuration.Configuration;
  import org.apache.avalon.framework.configuration.ConfigurationException;
  
  import org.apache.cocoon.util.JDBCTypeConversions;
  
  /**
   * Executes an arbitrary query. The query is associated with a table
   * and selected through the others mode. All keys and values are set
   * in order of appearance, starting with keys, thus the query needs to
   * have as many placeholders for prepared statement parameters. If it
   * is an update query, the number of affected rows is returned to the
   * sitemap.
   *
   *<pre>
   * &lt;table name="example"&gt;
   *   &lt;queries&gt;
   *      &lt;query mode="one"&gt;update example set count=count+1 where id=?&lt;/query&gt;
   *      &lt;query mode="two"&gt;select count, name from example where id=?&lt;/query&gt;
   *   &lt;/queries&gt;
   *   &lt;keys&gt;
   *     &lt;key name="id"/&gt;
   *   &lt;/keys&gt;
   *   &lt;values/&gt;
   * &lt;/table&gt;
   *</pre>
   *
   * @author <a href="mailto:haul@apache.org">Christian Haul</a>
   * @version CVS $Id: DatabaseQueryAction.java,v 1.1 2002/07/02 08:17:46 haul Exp $
   */
  public class DatabaseQueryAction extends DatabaseAction {
  
      /**
       * determine which mode to use as default mode
       * here: SELECT
       * highly specific to operation INSERT / UPDATE / DELETE / SELECT
       */
      protected String selectMode ( boolean isAutoIncrement, Map modes ) {
          
          return (String) modes.get( MODE_OTHERS );
      }
  
      /**
       * determine whether autoincrement columns should be honoured by
       * this operation. This is usually snsible only for INSERTs.
       */
      protected boolean honourAutoIncrement() { return false; }
  
  
      /**
       * Get the String representation of the PreparedStatement.  This is
       * mapped to the Configuration object itself, so if it doesn't exist,
       * it will be created.
       *
       * @param table the table's configuration object
       * @return the insert query as a string
       */
      protected CacheHelper getQuery( Configuration table, Map modeTypes, Map defaultModeNames )
          throws ConfigurationException, ComponentException {
  
          LookUpKey lookUpKey = new LookUpKey( table, modeTypes );
          CacheHelper queryData = null;
          synchronized( this.cachedQueryData ) {
              queryData = (CacheHelper) this.cachedQueryData.get( lookUpKey );
              if (queryData == null) {
                  Configuration[] queries = table.getChild("queries").getChildren("query");
                  Configuration[] keys = table.getChild("keys").getChildren("key");
                  Configuration[] values = table.getChild("values").getChildren("value");
  
                  queryData = new CacheHelper( keys.length, keys.length + values.length );
                  fillModes( keys  , true , defaultModeNames, modeTypes, queryData );
                  fillModes( values, false, defaultModeNames, modeTypes, queryData );
                  
                  boolean found = false;
                  String queryModeName = "";
                  for (int i=0; i<queries.length; i++) {
                      queryModeName = queries[i].getAttribute("mode",null);
                      if ( queryModeName.equals((String)modeTypes.get(MODE_OTHERS)) || "all".equals(queryModeName)) {
                          queryData.queryString = queries[i].getValue();
                          found = true;
                          break;
                      }
                  }
  
                  if (!found) {
                      throw new ConfigurationException("Could not find query mode " +
                                                       modeTypes.get(MODE_OTHERS) + 
                                                       " for table " + table.getAttribute("name",null));
                  }
  
                  this.cachedQueryData.put( lookUpKey, queryData );
              }
          }
  
          return queryData;
      }
  
  
      /**
       * Fetch all values for all columns that are needed to do the database operation.
       */
      protected Object[][] getColumnValues( Configuration tableConf, CacheHelper queryData, Map objectModel )
          throws ConfigurationException, ComponentException {
  
          Object[][] columnValues = new Object[ queryData.columns.length ][];
          for ( int i = 0; i < queryData.columns.length; i++ ){
              columnValues[i] = this.getColumnValue( tableConf, queryData.columns[i], objectModel );
          }
          return columnValues;
      }
  
  
      /**
       * set all necessary ?s and execute the query
       */
      protected int processRow ( Map objectModel, Connection conn, PreparedStatement statement, String outputMode,
                                 Configuration table, CacheHelper queryData, Object[][] columnValues, 
                                 int rowIndex, Map results )
          throws SQLException, ConfigurationException, Exception {
  
          int currentIndex = 1;
  
          // ordering is different for SELECT just needs keys
          for (int i = 0; i < queryData.columns.length; i++) {
              Column col = queryData.columns[i];
              if ( col.isKey ) {
                  this.setColumn(objectModel, outputMode, results, table, col.columnConf, rowIndex,
                                 columnValues[ i ][ ( col.isSet ? rowIndex : 0 ) ], statement, currentIndex );
                  currentIndex++;
              }
          }
          boolean hasResult = statement.execute();
          if (!hasResult) {
              return statement.getUpdateCount();
          } else {
              // retrieve values
              ResultSet resultset = statement.getResultSet();
              rowIndex = 0;
              while ( resultset.next() ){
                  //if ( ! ( rowIndex == -1 && resultset.isLast() ) ) {
                  rowIndex++;
                  //}
                  for (int i = 0; i < queryData.columns.length; i++) {
                      if ( !queryData.columns[i].isKey ) {
                          Object value = JDBCTypeConversions.getColumn( resultset, queryData.columns[i].columnConf );
                          this.setOutput(objectModel, outputMode, results, table, queryData.columns[i].columnConf, rowIndex, value);
                      }
                  }
              }
              return rowIndex;
          }
      }
  
  
  }
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org