/*
   XBN Java:  Generically useful, non-GUI Java code.
   http://sourceforge.net/projects/xbnjava

   Copyright (C) 1997-2003, Jeff Epstein
   All rights reserved.

   Modifications: No

   Redistribution in binary form, with or without modifications, are permitted provided that the following conditions are met:

      * 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.
      * If modifications are made to source code then this license should indicate that fact in the "Modifications" section above.
      * Neither the author, nor the contributors may be used to endorse or promote products derived from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.

   [NOTE:  This license contains NO advertising clause.]
 */
package xbn.db;
   import xbn.XBNObject;
   import java.sql.SQLException;
   import java.sql.Statement;

/**
   <P>A convenience class to manage a Statement, and the associated DBConnDirect and sql text.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/db/DBConnStatement.java">DBConnStatement.java</A>.</I></CODE></P>

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public abstract class DBConnStatement extends XBNObject  {
   private DBConnDirect dbConn = null;
   private String sSql = null;
   private int iResultSetType = -1;
   private int iResultSetConcurrency = -1;
   private boolean bUseExtraStatementParams = false;

   /**
      <P>Create a DBConnStatement.</P>

      @param  db_connDirect  The database connection.  May not be null.
      @param  s_sql  The sql statement.  May not be null or zero characters in length.
    **/
   public DBConnStatement(DBConnDirect db_connDirect, String s_sql)  {
      this(db_connDirect, s_sql, -1, -1, false);
   }

   /**
      <P>Create a DBConnStatement.</P>

      @param  db_connDirect  The database connection.  May not be null.
      @param  s_sql  The sql statement.  May not be null or zero characters in length.
      @param  i_resultSetType  See <A HREF="~JD~conn~EJD~">Connection</A>.<A HREF="~JD~conn#createStatement(i,i)~EJD~">createStatement</A> for information.
      @param  i_resultSetConcurrency  See Connection.createStatement for information.
    **/
   public DBConnStatement(DBConnDirect db_connDirect, String s_sql, int i_resultSetType, int i_resultSetConcurrency)  {
      this(db_connDirect, s_sql, i_resultSetType, i_resultSetConcurrency, true);
   }

   private DBConnStatement(DBConnDirect db_connDirect, String s_sql, int i_resultSetType, int i_resultSetConcurrency, boolean b_useExtraStatementParams)  {
      throwAXIfNull(db_connDirect, "db_connDirect", sCNSTR);
      throwAXIfBadStr(s_sql, "s_sql", sCNSTR);

      dbConn = db_connDirect;
      sSql = s_sql;
      iResultSetType = i_resultSetType;
      iResultSetConcurrency = i_resultSetConcurrency;
      bUseExtraStatementParams = b_useExtraStatementParams;
   }

   /**
      <P>Actually create and get the statement.</P>
    **/
   public abstract Statement getStatement();

   /**
      <P>Get the DBConnDirect for direct manipulation.</P>

      @return  <B>db_connDirect</B> exactly as provided to the <A HREF="~JD~dbcs(dbcd,s)~EJD~">constructor</A>.
    **/
   public final DBConnDirect getDBConnDirect()  {
      return dbConn;
   }


   /**
      <P>Get the sql statement.</P>

      @return  <B>s_sql</B> exactly as provided to the <A HREF="~JD~dbcs(dbcd,s)~EJD~">constructor</A>.
    **/
   public final String getSql()  {
      return sSql;
   }

   /**
      <P>Get the ResultSet type.</P>

      @return  <B>i_resultSetType</B> exactly as provided to the <A HREF="~JD~dbcs(dbcd,s,i,i)~EJD~">constructor</A>.
      @exception  AssertException  If the <A HREF="~JD~dbcs(dbcd,s)~EJD~">two-parameter constructor</A> was used, meaning the result set type setting was never provided.
    **/
   public final int getRSType()  {
      if(!wereExtraRSSettingsProvided())  {
         throwAX("getRSType:  wereExtraRSSettingsProvided() is false.  No RSType setting was provided.");
      }
      return iResultSetType;
   }

   /**
      <P>Get the ResultSet concurrency.</P>

      @return  <B>i_resultSetConcurrency</B> exactly as provided to the <A HREF="~JD~dbcs(dbcd,s,i,i)~EJD~">constructor</A>.
      @exception  AssertException  If the <A HREF="~JD~dbcs(dbcd,s)~EJD~">two-parameter constructor</A> was used, meaning the result set concurrency setting was never provided.
    **/
   public final int getRSConcurrency()  {
      if(!wereExtraRSSettingsProvided())  {
         throwAX("getRSConcurrency:  wereExtraRSSettingsProvided() is false.  No RSConcurrency setting was provided.");
      }
      return iResultSetConcurrency;
   }

   /**
      <P>Were the extra ResultSet settings provided?</P>

      @return <B>true</B>  If the <A HREF="~JD~dbcs(dbcd,s,i,i)~EJD~">four-parameter contructor</A> was used.
      <BR><B>false</B>  If the <A HREF="~JD~dbcs(dbcd,s)~EJD~">two-parameter constructor</A> was used.
    **/
   public final boolean wereExtraRSSettingsProvided()  {
      return bUseExtraStatementParams;
   }

   protected final void crashAtStatementCreate(SQLException sql_x, NullPointerException np_x) throws SQLException  {
      if(sql_x != null)  {
         getDBConnDirect().throwSQLX("constructor:  " + sql_x.toString());
      }

      if(np_x != null)  {
         if(getDBConnDirect().getConnection() == null)  {
            getDBConnDirect().throwAXDbg("constructor:  getDBConnDirect().getConnection() is null.");
         }

         throwAX("constructor:  Unknown error:  " + np_x.toString());
      }
   }

   protected final void throwSQLX(String s_funcMsg) throws SQLException  {
      getDBConnDirect().throwSQLX(this.getClass().getName() + "." + s_funcMsg);
   }
}