connectivity/source/inc/odbc/OPreparedStatement.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_CONNECTIVITY_SOURCE_INC_ODBC_OPREPAREDSTATEMENT_HXX
  21 #define INCLUDED_CONNECTIVITY_SOURCE_INC_ODBC_OPREPAREDSTATEMENT_HXX
  22
  23 #include <odbc/odbcbasedllapi.hxx>
  24 #include <odbc/OStatement.hxx>
  25 #include <com/sun/star/sdbc/XPreparedStatement.hpp>
  26 #include <com/sun/star/sdbc/XParameters.hpp>
  27 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
  28 #include <com/sun/star/sdbc/XPreparedBatchExecution.hpp>
  29 #include <com/sun/star/io/XInputStream.hpp>
  30 #include <cppuhelper/implbase5.hxx>
  31
  32 namespace connectivity::odbc
  33     {
  34
  35         class OBoundParam;
  36         typedef ::cppu::ImplHelper5<    css::sdbc::XPreparedStatement,
  37                                         css::sdbc::XParameters,
  38                                         css::sdbc::XPreparedBatchExecution,
  39                                         css::sdbc::XResultSetMetaDataSupplier,
  40                                         css::lang::XServiceInfo> OPreparedStatement_BASE;
  41
  42         class OOO_DLLPUBLIC_ODBCBASE OPreparedStatement final :
  43                                     public  OStatement_BASE2,
  44                                     public  OPreparedStatement_BASE
  45         {
  46             static const short invalid_scale = -1;
  47
  48             // Data attributes
  49
  50             SQLSMALLINT     numParams;      // Number of parameter markers for the prepared statement
  51
  52             std::unique_ptr<OBoundParam[]>  boundParams;
  53                             // Array of bound parameter objects. Each parameter marker will have a
  54                             // corresponding object to hold bind information, and resulting data.
  55             css::uno::Reference< css::sdbc::XResultSetMetaData >  m_xMetaData;
  56             bool                                                                        m_bPrepared;
  57
  58             void FreeParams();
  59             /// @throws css::sdbc::SQLException
  60             /// @throws css::uno::RuntimeException
  61             void putParamData (sal_Int32 index);
  62             /// @throws css::sdbc::SQLException
  63             /// @throws css::uno::RuntimeException
  64             void setStream (sal_Int32 ParameterIndex,const css::uno::Reference< css::io::XInputStream>& x,
  65                                                         SQLLEN length,sal_Int32 SQLtype);
  66             SQLLEN* getLengthBuf (sal_Int32 index);
  67             void* allocBindBuf (    sal_Int32 index,    sal_Int32 bufLen);
  68             /// @throws css::sdbc::SQLException
  69             void initBoundParam ();
  70             void setParameterPre(sal_Int32 parameterIndex);
  71             template <typename T> void setScalarParameter(sal_Int32 parameterIndex, sal_Int32 _nType, SQLULEN _nColumnSize, const T i_Value);
  72             template <typename T> void setScalarParameter(sal_Int32 parameterIndex, sal_Int32 _nType, SQLULEN _nColumnSize, sal_Int32 _nScale, const T i_Value);
  73             void setParameter(sal_Int32 parameterIndex, sal_Int32 _nType, SQLULEN _nColumnSize, sal_Int32 _nScale, const void* _pData, SQLULEN _nDataLen, SQLLEN _nDataAllocLen);
  74             // Wrappers for special cases
  75             void setParameter(sal_Int32 parameterIndex, sal_Int32 _nType, sal_Int16 _nScale, const OUString &_sData);
  76             void setParameter(sal_Int32 parameterIndex, sal_Int32 _nType, const css::uno::Sequence< sal_Int8 > &Data);
  77
  78             bool isPrepared() const { return m_bPrepared;}
  79             void prepareStatement();
  80             void checkParameterIndex(sal_Int32 _parameterIndex);
  81
  82             /**
  83                 creates the driver specific resultset (factory)
  84             */
  85             virtual OResultSet* createResulSet() override;
  86
  87             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle,
  88                                                                    const css::uno::Any& rValue) override;
  89         public:
  90             DECLARE_SERVICE_INFO();
  91             // A ctor, needed to return the object
  92             OPreparedStatement( OConnection* _pConnection,const OUString& sql);
  93             virtual ~OPreparedStatement() override;
  94             OPreparedStatement& operator=( OPreparedStatement const & ) = delete; // MSVC2015 workaround
  95             OPreparedStatement( OPreparedStatement const & ) = delete; // MSVC2015 workaround
  96
  97             //XInterface
  98             virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
  99             virtual void SAL_CALL acquire() throw() override;
 100             virtual void SAL_CALL release() throw() override;
 101             //XTypeProvider
 102             virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) override;
 103
 104             // XPreparedStatement
 105             virtual css::uno::Reference< css::sdbc::XResultSet > SAL_CALL executeQuery(  ) override;
 106             virtual sal_Int32 SAL_CALL executeUpdate(  ) override;
 107             virtual sal_Bool SAL_CALL execute(  ) override;
 108             virtual css::uno::Reference< css::sdbc::XConnection > SAL_CALL getConnection(  ) override;
 109             // XParameters
 110             virtual void SAL_CALL setNull( sal_Int32 parameterIndex, sal_Int32 sqlType ) override;
 111             virtual void SAL_CALL setObjectNull( sal_Int32 parameterIndex, sal_Int32 sqlType, const OUString& typeName ) override;
 112             virtual void SAL_CALL setBoolean( sal_Int32 parameterIndex, sal_Bool x ) override;
 113             virtual void SAL_CALL setByte( sal_Int32 parameterIndex, sal_Int8 x ) override;
 114             virtual void SAL_CALL setShort( sal_Int32 parameterIndex, sal_Int16 x ) override;
 115             virtual void SAL_CALL setInt( sal_Int32 parameterIndex, sal_Int32 x ) override;
 116             virtual void SAL_CALL setLong( sal_Int32 parameterIndex, sal_Int64 x ) override;
 117             virtual void SAL_CALL setFloat( sal_Int32 parameterIndex, float x ) override;
 118             virtual void SAL_CALL setDouble( sal_Int32 parameterIndex, double x ) override;
 119             virtual void SAL_CALL setString( sal_Int32 parameterIndex, const OUString& x ) override;
 120             virtual void SAL_CALL setBytes( sal_Int32 parameterIndex, const css::uno::Sequence< sal_Int8 >& x ) override;
 121             virtual void SAL_CALL setDate( sal_Int32 parameterIndex, const css::util::Date& x ) override;
 122             virtual void SAL_CALL setTime( sal_Int32 parameterIndex, const css::util::Time& x ) override;
 123             virtual void SAL_CALL setTimestamp( sal_Int32 parameterIndex, const css::util::DateTime& x ) override;
 124             virtual void SAL_CALL setBinaryStream( sal_Int32 parameterIndex, const css::uno::Reference< css::io::XInputStream >& x, sal_Int32 length ) override;
 125             virtual void SAL_CALL setCharacterStream( sal_Int32 parameterIndex, const css::uno::Reference< css::io::XInputStream >& x, sal_Int32 length ) override;
 126             virtual void SAL_CALL setObject( sal_Int32 parameterIndex, const css::uno::Any& x ) override;
 127             virtual void SAL_CALL setObjectWithInfo( sal_Int32 parameterIndex, const css::uno::Any& x, sal_Int32 targetSqlType, sal_Int32 scale ) override;
 128             virtual void SAL_CALL setRef( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XRef >& x ) override;
 129             virtual void SAL_CALL setBlob( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XBlob >& x ) override;
 130             virtual void SAL_CALL setClob( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XClob >& x ) override;
 131             virtual void SAL_CALL setArray( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XArray >& x ) override;
 132             virtual void SAL_CALL clearParameters(  ) override;
 133             // XPreparedBatchExecution
 134             virtual void SAL_CALL addBatch(  ) override;
 135             virtual void SAL_CALL clearBatch(  ) override;
 136             virtual css::uno::Sequence< sal_Int32 > SAL_CALL executeBatch(  ) override;
 137             // XCloseable
 138             virtual void SAL_CALL close(  ) override;
 139             // XResultSetMetaDataSupplier
 140             virtual css::uno::Reference< css::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  ) override;
 141
 142         public:
 143             using OStatement_Base::executeQuery;
 144             using OStatement_Base::executeUpdate;
 145             using OStatement_Base::execute;
 146         };
 147
 148 }
 149 #endif // INCLUDED_CONNECTIVITY_SOURCE_INC_ODBC_OPREPAREDSTATEMENT_HXX
 150
 151 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */