connectivity/source/inc/odbc/OPreparedStatement.hxx

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