/***
    * License Agreement.
    * 
    * JSPA (POJO-SP)
    * 
    * Copyright (C) 2009 HRX Pty Ltd
    * 
    * This file is part of JSPA.
    * 
   * JSPA is free software: you can redistribute it and/or modify it under the
   * terms of the GNU Lesser General Public License version 3 as published by the
   * Free Software Foundation.
   * 
   * JSPA 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 Lesser General Public License for more details.
   * 
   * You should have received a copy of the GNU Lesser General Public License
   * along with JSPA. If not, see <http://www.gnu.org/licenses/>.
   */
  package com.hrx.rasp.util.dao;
  
  import org.apache.log4j.Logger;
  
  /***
   * @author dan.stoica <dan.stoica@acslink.net.au>
   * 
   */
  /***
   * the CallBuilder class is responsible for building the pl/sql commands to be
   * sent to the db
   * 
   */
  public final class ExpressionBuilder
  {
  
  	private final static Logger log = Logger.getLogger(ExpressionBuilder.class);
  
  	/***
  	 * Description for getFind method
  	 * 
  	 * @param storedProc
  	 *            the name of the stored procedure
  	 * @param argx
  	 *            the number of arguments for the find operation
  	 * @return java.lang.String
  	 */
  	public static String getFind(String storedProc, int argc)
  	{
  		/*
  		 * Stored proc signature - PROCEDURE doSelect(ReturnCode OUT NUMBER,
  		 * ReturnText OUT VARCHAR2, arg1 IN TYPE, arg2 IN TYPE, arg3 OUT TYPE,
  		 * ...); JDBC call syntax - {call PROCEDURE(?, ...)}
  		 */
  		String call = buildCall(storedProc, false, 2, argc);
  
  		return call;
  	}
  
  	/***
  	 * Description for getSelect method
  	 * 
  	 * @param storedProc
  	 *            the name of the stored procedure
  	 * @param argc
  	 *            the number of arguments
  	 * @return java.lang.String
  	 */
  	public static String getSelect(String _storedProc, int argc)
  	{
  		/*
  		 * Stored proc signature - FUNCTION doSelect(ReturnCode OUT NUMBER,
  		 * ReturnText OUT VARCHAR, arg1 IN TYPE, arg2 IN TYPE, ...) RETURN
  		 * REF_CURSOR; JDBC call syntax - {?=call FUNCTION(?, ...)}
  		 */
  		String call = buildCall(_storedProc, true, 2, argc);
  
  		return call;
  	}
  
  	/***
  	 * Description for getInsert method
  	 * 
  	 * @param _storedProc
  	 *            the stored procedure to be called
  	 * @param inParameters,
  	 *            used as IN arguments for the insert statement
  	 * @param pkParameters,
  	 *            used as OUT arguments for the insert statement
  	 * @return String
  	 */
  	public static String getInsert(final String storedProc, int params)
  	{
  		/*
  		 * Stored proc signature - PROCEDURE doInsert(ReturnCode OUT NUMBER,
  		 * ReturnText OUT Varchar2, pk1 IN OUT, pk2 IN OUT, arg1 In TYPE, arg2
  		 * IN TYPE, ...); JDBC call syntax - {call PROCEDURE(?, ?...)}
  		 */
  		return buildCall(storedProc, false, 2, params);
 	}
 
 	/***
 	 * Description for getUpdate method
 	 * 
 	 * @param storedProc
 	 *            String
 	 * @param inParameters
 	 *            Object[]
 	 * @return java.lang.String
 	 */
 	public static String getUpdate(final String storedProc, int inParameters)
 	{
 		/*
 		 * Stored proc signature - PROCEDURE doUpdate(ReturnCode OUT NUMBER,
 		 * ReturnText OUT Varchar2, arg1 In TYPE, arg2 IN TYPE, ...); JDBC call
 		 * syntax - {call PROCEDURE(?, ?...)}
 		 */
 		return buildCall(storedProc, false, 2, inParameters);
 	}
 
 	public static String getFunctionCall(final String function, int argc)
 	{
 		/*
 		 * Stored procedure signature - FUNCTION doFunction(arg1 In TYPE, arg2
 		 * INTYPE, .....) RETURN TYPE AS JDBC call syntax - {? = call
 		 * FUNCTION(?, ?...)}
 		 * 
 		 * The first parameter is the return
 		 */
 		return buildCall(function, argc - 1, true);
 	}
 
 	public static String getStoredProcedureCall(String storedProc, int argc)
 	{
 		/*
 		 * Generic stored procedure call Stored procedure signature - PROCEDURE
 		 * doProcedure(arg1 ANY TYPE, arg2 ANY TYPE, ... argN ANY TYPE.....)
 		 * RETURN TYPE AS JDBC call syntax - {call PROCEDURE(?, ?...)}
 		 * 
 		 */
 		return buildCall(storedProc, argc, false);
 	}
 
 	/***
 	 * Description for buildCall method
 	 * 
 	 * @param storedProc
 	 *            The stored proc name
 	 * @param parametersIN
 	 *            The IN arguments of the stored proc
 	 * @param parametersOUT
 	 *            The OUT arguments of the stored proc
 	 * @param isFunction
 	 *            Is the call a function or a procedure
 	 * @return java.lang.String
 	 */
 	protected static String buildCall(String storedProc, boolean isFunction, int... args)
 	{
 		int count = 0;
 		for (int arg : args)
 		{
 			count = count + Math.max(0, arg);
 		}
 		return buildCall(storedProc, count, isFunction);
 	}
 
 	/***
 	 * Description for buildCall method
 	 * 
 	 * @param storedProc
 	 *            The stored proc name
 	 * @param args
 	 *            The number of arguments of the stored proc
 	 * @param isFunction
 	 *            Is the call a function or a procedure
 	 * @return java.lang.String
 	 */
 	protected static String buildCall(String storedProc, int argc, boolean isFunction)
 	{
 		StringBuffer buffer = new StringBuffer();
 
 		buffer.append("{");
 
 		if (isFunction) buffer.append("? = ");
 
 		buffer.append("call ");
 		buffer.append(storedProc);
 		buffer.append("(");
 
 		if (argc > 0)
 		{
 			for (int i = 0; i < argc; ++i)
 			{
 				buffer.append("?");
 
 				if (i < argc - 1) buffer.append(", ");
 			}
 		}
 
 		buffer.append(")}");
 
 		String call = buffer.toString();
 
 		if (log.isDebugEnabled())
 		{
 			log.debug("DAO: JDBC Statement is: " + call);
 		}
 		return call;
 	}
 }