connectivity/source/inc/odbc/OPreparedStatement.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: OPreparedStatement.hxx,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _CONNECTIVITY_ODBC_OPREPAREDSTATEMENT_HXX_
  32 #define _CONNECTIVITY_ODBC_OPREPAREDSTATEMENT_HXX_
  33
  34 #include "odbc/odbcbasedllapi.hxx"
  35 #include "odbc/OStatement.hxx"
  36 #include <com/sun/star/sdbc/XPreparedStatement.hpp>
  37 #include <com/sun/star/sdbc/XParameters.hpp>
  38 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
  39 #include <com/sun/star/sdbc/XPreparedBatchExecution.hpp>
  40 #include <com/sun/star/io/XInputStream.hpp>
  41 #include <cppuhelper/implbase5.hxx>
  42
  43 namespace connectivity
  44 {
  45     namespace odbc
  46     {
  47
  48         class OBoundParam;
  49         typedef ::cppu::ImplHelper5<    ::com::sun::star::sdbc::XPreparedStatement,
  50                                         ::com::sun::star::sdbc::XParameters,
  51                                         ::com::sun::star::sdbc::XPreparedBatchExecution,
  52                                         ::com::sun::star::sdbc::XResultSetMetaDataSupplier,
  53                                         ::com::sun::star::lang::XServiceInfo> OPreparedStatement_BASE;
  54
  55         class OOO_DLLPUBLIC_ODBCBASE OPreparedStatement :
  56                                     public      OStatement_BASE2,
  57                                     public  OPreparedStatement_BASE
  58         {
  59         protected:
  60             struct Parameter
  61             {
  62                 ::com::sun::star::uno::Any      aValue;
  63                 sal_Int32                                       nDataType;
  64
  65                 Parameter(const ::com::sun::star::uno::Any&     rValue,
  66                           sal_Int32                                                     rDataType) : aValue(rValue),nDataType(rDataType)
  67                 {
  68                 }
  69
  70             };
  71
  72             ::std::vector< Parameter>                                   m_aParameters;
  73             //====================================================================
  74             // Data attributes
  75             //====================================================================
  76             SQLSMALLINT         numParams;              // Number of parameter markers
  77                                             //  for the prepared statement
  78
  79             OBoundParam*        boundParams;
  80                             // Array of bound parameter
  81                             //  objects.  Each parameter
  82                             //  marker will have a
  83                             //  corresponding object to
  84                             //  hold bind information, and
  85                             //  resulting data.
  86             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData >      m_xMetaData;
  87             sal_Bool                                                                                                                                            m_bPrepared;
  88
  89             void FreeParams();
  90             void putParamData (sal_Int32 index) throw(::com::sun::star::sdbc::SQLException);
  91             void setStream (sal_Int32 ParameterIndex,const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream>& x,
  92                                                         sal_Int32 length,sal_Int32 SQLtype) throw(::com::sun::star::sdbc::SQLException);
  93             sal_Int32 getParamLength (  sal_Int32 index);
  94             sal_Int8* getLengthBuf (sal_Int32 index);
  95             sal_Int8* getDataBuf (sal_Int32 index);
  96             sal_Int8* allocBindBuf (    sal_Int32 index,        sal_Int32 bufLen);
  97             void initBoundParam () throw(::com::sun::star::sdbc::SQLException);
  98             void setParameter(sal_Int32 parameterIndex,sal_Int32 _nType,sal_Int32 _nSize,void* _pData);
  99
 100             sal_Int32 getPrecision ( sal_Int32 sqlType);
 101
 102             sal_Bool isPrepared() const { return m_bPrepared;}
 103             void prepareStatement();
 104             void checkParameterIndex(sal_Int32 _parameterIndex);
 105
 106             /**
 107                 creates the driver specific resultset (factory)
 108             */
 109             virtual OResultSet* createResulSet();
 110
 111         protected:
 112             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle,
 113                                                                    const ::com::sun::star::uno::Any& rValue)
 114                                                                         throw (::com::sun::star::uno::Exception);
 115         public:
 116             DECLARE_SERVICE_INFO();
 117             // ein Konstruktor, der fuer das Returnen des Objektes benoetigt wird:
 118             OPreparedStatement( OConnection* _pConnection,const ::rtl::OUString& sql);
 119
 120             //XInterface
 121             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException);
 122             virtual void SAL_CALL acquire() throw();
 123             virtual void SAL_CALL release() throw();
 124             //XTypeProvider
 125             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  ) throw(::com::sun::star::uno::RuntimeException);
 126
 127             // XPreparedStatement
 128             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet > SAL_CALL executeQuery(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 129             virtual sal_Int32 SAL_CALL executeUpdate(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 130             virtual sal_Bool SAL_CALL execute(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 131             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection > SAL_CALL getConnection(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 132             // XParameters
 133             virtual void SAL_CALL setNull( sal_Int32 parameterIndex, sal_Int32 sqlType ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 134             virtual void SAL_CALL setObjectNull( sal_Int32 parameterIndex, sal_Int32 sqlType, const ::rtl::OUString& typeName ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 135             virtual void SAL_CALL setBoolean( sal_Int32 parameterIndex, sal_Bool x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 136             virtual void SAL_CALL setByte( sal_Int32 parameterIndex, sal_Int8 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 137             virtual void SAL_CALL setShort( sal_Int32 parameterIndex, sal_Int16 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 138             virtual void SAL_CALL setInt( sal_Int32 parameterIndex, sal_Int32 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 139             virtual void SAL_CALL setLong( sal_Int32 parameterIndex, sal_Int64 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 140             virtual void SAL_CALL setFloat( sal_Int32 parameterIndex, float x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 141             virtual void SAL_CALL setDouble( sal_Int32 parameterIndex, double x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 142             virtual void SAL_CALL setString( sal_Int32 parameterIndex, const ::rtl::OUString& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 143             virtual void SAL_CALL setBytes( sal_Int32 parameterIndex, const ::com::sun::star::uno::Sequence< sal_Int8 >& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 144             virtual void SAL_CALL setDate( sal_Int32 parameterIndex, const ::com::sun::star::util::Date& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 145             virtual void SAL_CALL setTime( sal_Int32 parameterIndex, const ::com::sun::star::util::Time& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 146             virtual void SAL_CALL setTimestamp( sal_Int32 parameterIndex, const ::com::sun::star::util::DateTime& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 147             virtual void SAL_CALL setBinaryStream( sal_Int32 parameterIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 148             virtual void SAL_CALL setCharacterStream( sal_Int32 parameterIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 149             virtual void SAL_CALL setObject( sal_Int32 parameterIndex, const ::com::sun::star::uno::Any& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 150             virtual void SAL_CALL setObjectWithInfo( sal_Int32 parameterIndex, const ::com::sun::star::uno::Any& x, sal_Int32 targetSqlType, sal_Int32 scale ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 151             virtual void SAL_CALL setRef( sal_Int32 parameterIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef >& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 152             virtual void SAL_CALL setBlob( sal_Int32 parameterIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob >& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 153             virtual void SAL_CALL setClob( sal_Int32 parameterIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob >& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 154             virtual void SAL_CALL setArray( sal_Int32 parameterIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray >& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 155             virtual void SAL_CALL clearParameters(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 156             // XPreparedBatchExecution
 157             virtual void SAL_CALL addBatch(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 158             virtual void SAL_CALL clearBatch(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 159             virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL executeBatch(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 160             // XCloseable
 161             virtual void SAL_CALL close(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 162             // XResultSetMetaDataSupplier
 163             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 164
 165         public:
 166             using OStatement_Base::executeQuery;
 167             using OStatement_Base::executeUpdate;
 168             using OStatement_Base::execute;
 169         };
 170     }
 171 }
 172 #endif // _CONNECTIVITY_ODBC_OPREPAREDSTATEMENT_HXX_
 173