/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.ejb.plugins.jaws.jdbc;

import java.lang.reflect.Field;

import java.util.Iterator;
import java.util.ArrayList;
import java.util.Collection;


import java.sql.PreparedStatement;
import java.sql.ResultSet;

import org.jboss.ejb.plugins.jaws.metadata.CMPFieldMetaData;
import org.jboss.ejb.plugins.jaws.metadata.FinderMetaData;
import org.jboss.ejb.plugins.jaws.metadata.JawsEntityMetaData;
import org.jboss.ejb.plugins.jaws.metadata.PkFieldMetaData;

import org.jboss.logging.Logger;

/**
 * Preloads data for all entities in where clause
 *
 * @see <related>
 * @author <a href="mailto:danch@nvisia.com">danch (Dan Christopherson)</a>
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1.7.4.1 $
 * 
 *   <p><b>Revisions:</b>
 *
 *   <p><b>20010621 danch:<b>
 *   <ul>
 *   <li> abstracted the finders further so that this class can be 
 *    used against the findAll and FindBy types of finders as well as the 
 *    defined finders.
 *   </ul>
 *
 *   <p><b>20010812 vincent.harcq@hubmethods.com:</b>
 *   <ul>
 *   <li> Get Rid of debug flag, use log4j instead
 *   </ul>
 *
 */
public class JDBCPreloadFinderCommand
   extends JDBCFinderCommand
{
   /** The finder we delegate to for setParameters and to get our SQL */
   protected JDBCFinderCommand finderDelegate;
   /** The load command we delegate to for our column list */
   protected JDBCLoadEntityCommand loadCommand;

   private Logger log = Logger.getLogger(JDBCPreloadFinderCommand.class);

   // Constructors --------------------------------------------------

   public JDBCPreloadFinderCommand(JDBCCommandFactory factory, String name)
   {
      super(factory, name);
      loadCommand = new JDBCLoadEntityCommand(factory);
   }
   public JDBCPreloadFinderCommand(JDBCCommandFactory factory, FinderMetaData f)
   {
      super(factory, "PreloadFinder " + f.getName());
      loadCommand = new JDBCLoadEntityCommand(factory);
      finderDelegate = new JDBCDefinedFinderCommand(factory, f);
      buildSQL();
   }
   public JDBCPreloadFinderCommand(JDBCCommandFactory factory, JDBCFinderCommand finder) {
      super(factory, "PreloadFinder "+finder.getName());
      loadCommand = new JDBCLoadEntityCommand(factory);
      finderDelegate = finder;
      buildSQL();
   }

   public String getWhereClause() {
      return finderDelegate.getWhereClause();
   }
   public String getFromClause() {
      return finderDelegate.getFromClause();
   }
   public String getOrderByClause() {
      return finderDelegate.getOrderByClause();
   }

   /** Helper method called by the constructors */
   protected void buildSQL() {
      String sql = loadCommand.createSelectClause() + " "
         + finderDelegate.getFromClause() + " "
         + finderDelegate.getWhereClause() + " "
         + finderDelegate.getOrderByClause();
      if (jawsEntity.hasRowLocking())
      {
         sql += " FOR UPDATE";
      }
      setSQL(sql);
   }
   
   protected Object handleResult(ResultSet rs, Object argOrArgs) throws Exception
   {
      Collection result = new ArrayList();
      while (rs.next())
      {
         Object key = createKey(rs);
         result.add(key);
         preloadOneEntity(rs, key);
      }
      return result;
   }
   
   protected void preloadOneEntity(ResultSet rs, Object key) {
      if (log.isDebugEnabled())
         log.debug("PRELOAD: preloading entity "+key);   
      int idx = 1;
      // skip the PK fields at the beginning of the select.
      Iterator keyIt = jawsEntity.getPkFields();
      while (keyIt.hasNext()) {
         keyIt.next();
         idx++;
      }

      int fieldCount = 0;
      Object[] allValues = new Object[jawsEntity.getNumberOfCMPFields()];
      Iterator iter = jawsEntity.getCMPFields();
      try {
         while (iter.hasNext())
         {
            CMPFieldMetaData cmpField = (CMPFieldMetaData)iter.next();
            
            Object value = getResultObject(rs, loadCommand.cmpFieldPositionInSelect[fieldCount], cmpField);
            allValues[fieldCount] = value;
            fieldCount++;
         }
         if (log.isDebugEnabled())
            log.debug("adding to preload data: " + key.toString());
         factory.addPreloadData(key, allValues);
      } catch (Exception sqle) {
         log.warn("SQL Error preloading data for key "+key, sqle);
      }
   }
   
   // protected -----------------------------------------------------
   
   protected Object createKey(ResultSet rs) throws Exception {
   
      if (jawsEntity.hasCompositeKey())
      {
         // Compound key
         try
         {
            Object pk = jawsEntity.getPrimaryKeyClass().newInstance();
            int i = 1;   // parameter index
            Iterator it = jawsEntity.getPkFields();
            
            while (it.hasNext())
            {
               PkFieldMetaData pkFieldMetaData = (PkFieldMetaData)it.next();
               Field pkField = pkFieldMetaData.getPkField();
               String colName = pkFieldMetaData.getColumnName();
               pkField.set(pk, getResultObject(rs, 
                                               i++, 
                                               pkField.getType()));
            }
            return pk;
         } catch (Exception e)
         {
            return null;
         }
      } else
      {
         // Primitive key
         Iterator it = jawsEntity.getPkFields();
         PkFieldMetaData pkFieldMetaData = (PkFieldMetaData)it.next();
         return getResultObject(rs, 1, pkFieldMetaData.getCMPField().getType());
      }
   }
   
   protected void setParameters(PreparedStatement stmt, Object argOrArgs)
      throws Exception
   {
      finderDelegate.setParameters(stmt, argOrArgs);
/*      
      Object[] args = (Object[])argOrArgs;

      TypeMappingMetaData typeMapping = jawsEntity.getJawsApplication().getTypeMapping();
      for (int i = 0; i < defined.getParameterArray().length; i++)
      {
         Object arg = args[defined.getParameterArray()[i]];
         int jdbcType = typeMapping.getJdbcTypeForJavaType(arg.getClass());
         setParameter(stmt,i+1,jdbcType,arg);
      }
*/
   }
}
