connectivity/source/drivers/firebird/PreparedStatement.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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 #pragma once
  21
  22 #include "StatementCommonBase.hxx"
  23
  24 #include <cppuhelper/implbase5.hxx>
  25
  26 #include <com/sun/star/sdbc/XPreparedStatement.hpp>
  27 #include <com/sun/star/sdbc/XParameters.hpp>
  28 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
  29 #include <com/sun/star/sdbc/XPreparedBatchExecution.hpp>
  30 #include <com/sun/star/io/XInputStream.hpp>
  31
  32 #include <ibase.h>
  33
  34 namespace connectivity::firebird
  35     {
  36
  37         class OBoundParam;
  38         typedef ::cppu::ImplHelper5<    css::sdbc::XPreparedStatement,
  39                                         css::sdbc::XParameters,
  40                                         css::sdbc::XPreparedBatchExecution,
  41                                         css::sdbc::XResultSetMetaDataSupplier,
  42                                         css::lang::XServiceInfo> OPreparedStatement_Base;
  43
  44         class OPreparedStatement :  public  OStatementCommonBase,
  45                                     public  OPreparedStatement_Base
  46         {
  47         protected:
  48             OUString                                              m_sSqlStatement;
  49             css::uno::Reference< css::sdbc::XResultSetMetaData >  m_xMetaData;
  50
  51             XSQLDA*         m_pOutSqlda;
  52             XSQLDA*         m_pInSqlda;
  53             /// @throws css::sdbc::SQLException
  54             /// @throws css::uno::RuntimeException
  55             void checkParameterIndex(sal_Int32 nParameterIndex);
  56
  57             /**
  58              * Set a numeric value in the input SQLDA. If the destination
  59              * parameter is not of nType then an Exception will be thrown.
  60              *
  61              * @throws css::sdbc::SQLException
  62              * @throws css::uno::RuntimeException
  63              */
  64             template <typename T> void setValue(sal_Int32 nIndex, const T& nValue, ISC_SHORT nType);
  65             void setParameterNull(sal_Int32 nParameterIndex, bool bSetNull = true);
  66
  67             /// @throws css::sdbc::SQLException
  68             /// @throws css::uno::RuntimeException
  69             void ensurePrepared();
  70             /**
  71              * Assumes that all necessary mutexes have been taken.
  72              */
  73             void openBlobForWriting(isc_blob_handle& rBlobHandle, ISC_QUAD& rBlobId);
  74             /**
  75              * Assumes that all necessary mutexes have been taken.
  76              */
  77             void closeBlobAfterWriting(isc_blob_handle& rBlobHandle);
  78             void setClob(sal_Int32 nParamIndex, const OUString& rStr);
  79
  80         protected:
  81             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle,
  82                                                                    const css::uno::Any& rValue) override;
  83             virtual ~OPreparedStatement() override;
  84         public:
  85             DECLARE_SERVICE_INFO();
  86             // a constructor, which is required for returning objects:
  87             OPreparedStatement( Connection* _pConnection,
  88                                 const OUString& sql);
  89
  90             //XInterface
  91             virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
  92             virtual void SAL_CALL acquire() noexcept override;
  93             virtual void SAL_CALL release() noexcept override;
  94             //XTypeProvider
  95             virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) override;
  96
  97             // XPreparedStatement
  98             virtual css::uno::Reference< css::sdbc::XResultSet > SAL_CALL
  99                 executeQuery() override;
 100             virtual sal_Int32 SAL_CALL
 101                 executeUpdate() override;
 102             virtual sal_Bool SAL_CALL
 103                 execute() override;
 104             virtual css::uno::Reference< css::sdbc::XConnection > SAL_CALL
 105                 getConnection() override;
 106
 107             // XParameters
 108             virtual void SAL_CALL setNull(sal_Int32 nIndex, sal_Int32 nValue) override;
 109             virtual void SAL_CALL setObjectNull(sal_Int32 parameterIndex, sal_Int32 sqlType, const OUString& typeName ) override;
 110             virtual void SAL_CALL setBoolean( sal_Int32 nIndex, sal_Bool nValue) override;
 111             virtual void SAL_CALL setByte(sal_Int32 nIndex, sal_Int8 nValue) override;
 112             virtual void SAL_CALL setShort(sal_Int32 nIndex, sal_Int16 nValue) override;
 113             virtual void SAL_CALL setInt(sal_Int32 nIndex, sal_Int32 nValue) override;
 114             virtual void SAL_CALL setLong(sal_Int32 nIndex, sal_Int64 nValue) override;
 115             virtual void SAL_CALL setFloat( sal_Int32 parameterIndex, float x ) override;
 116             virtual void SAL_CALL setDouble( sal_Int32 parameterIndex, double x ) override;
 117             virtual void SAL_CALL setString( sal_Int32 parameterIndex, const OUString& x ) override;
 118             virtual void SAL_CALL setBytes( sal_Int32 parameterIndex, const css::uno::Sequence< sal_Int8 >& x ) override;
 119             virtual void SAL_CALL setDate( sal_Int32 parameterIndex, const css::util::Date& x ) override;
 120             virtual void SAL_CALL setTime( sal_Int32 parameterIndex, const css::util::Time& x ) override;
 121             virtual void SAL_CALL setTimestamp( sal_Int32 parameterIndex, const css::util::DateTime& x ) override;
 122             virtual void SAL_CALL setBinaryStream( sal_Int32 parameterIndex, const css::uno::Reference< css::io::XInputStream >& x, sal_Int32 length ) override;
 123             virtual void SAL_CALL setCharacterStream( sal_Int32 parameterIndex, const css::uno::Reference< css::io::XInputStream >& x, sal_Int32 length ) override;
 124             virtual void SAL_CALL setObject( sal_Int32 parameterIndex, const css::uno::Any& x ) override;
 125             virtual void SAL_CALL setObjectWithInfo( sal_Int32 parameterIndex, const css::uno::Any& x, sal_Int32 targetSqlType, sal_Int32 scale ) override;
 126             virtual void SAL_CALL setRef( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XRef >& x ) override;
 127             virtual void SAL_CALL setBlob( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XBlob >& x ) override;
 128             virtual void SAL_CALL setClob( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XClob >& x ) override;
 129             virtual void SAL_CALL setArray( sal_Int32 parameterIndex, const css::uno::Reference< css::sdbc::XArray >& x ) override;
 130             virtual void SAL_CALL clearParameters(  ) override;
 131
 132             // XPreparedBatchExecution -- UNSUPPORTED by firebird
 133             virtual void SAL_CALL
 134                 addBatch() override;
 135             virtual void SAL_CALL
 136                 clearBatch() override;
 137             virtual css::uno::Sequence< sal_Int32 > SAL_CALL
 138                 executeBatch() override;
 139
 140             // XCloseable
 141             virtual void SAL_CALL close() override;
 142             // OComponentHelper
 143             virtual void SAL_CALL disposing() override;
 144
 145             // XResultSetMetaDataSupplier
 146             virtual css::uno::Reference< css::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  ) override;
 147
 148         };
 149
 150 }
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */