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