xref: /trunk/main/odk/examples/DevelopersGuide/Database/DriverSkeleton/SPreparedStatement.hxx (revision 914d351e5f5b84e4342a86d6ab8d4aca7308b9bd)
1*34dd1e25SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*34dd1e25SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*34dd1e25SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*34dd1e25SAndrew Rist  * distributed with this work for additional information
6*34dd1e25SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*34dd1e25SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*34dd1e25SAndrew Rist  * "License"); you may not use this file except in compliance
9*34dd1e25SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*34dd1e25SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*34dd1e25SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*34dd1e25SAndrew Rist  * software distributed under the License is distributed on an
15*34dd1e25SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*34dd1e25SAndrew Rist  * KIND, either express or implied.  See the License for the
17*34dd1e25SAndrew Rist  * specific language governing permissions and limitations
18*34dd1e25SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*34dd1e25SAndrew Rist  *************************************************************/
21*34dd1e25SAndrew Rist 
22*34dd1e25SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef CONNECTIVITY_SPREPAREDSTATEMENT_HXX
25cdf0e10cSrcweir #define CONNECTIVITY_SPREPAREDSTATEMENT_HXX
26cdf0e10cSrcweir #include "SStatement.hxx"
27cdf0e10cSrcweir #include <com/sun/star/sdbc/XPreparedStatement.hpp>
28cdf0e10cSrcweir #include <com/sun/star/sdbc/XParameters.hpp>
29cdf0e10cSrcweir #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
30cdf0e10cSrcweir #include <com/sun/star/sdbc/XPreparedBatchExecution.hpp>
31cdf0e10cSrcweir #include <com/sun/star/io/XInputStream.hpp>
32cdf0e10cSrcweir 
33cdf0e10cSrcweir namespace connectivity
34cdf0e10cSrcweir {
35cdf0e10cSrcweir     namespace skeleton
36cdf0e10cSrcweir     {
37cdf0e10cSrcweir 
38cdf0e10cSrcweir         class OBoundParam;
39cdf0e10cSrcweir         typedef ::cppu::ImplHelper5<    ::com::sun::star::sdbc::XPreparedStatement,
40cdf0e10cSrcweir                                         ::com::sun::star::sdbc::XParameters,
41cdf0e10cSrcweir                                         ::com::sun::star::sdbc::XPreparedBatchExecution,
42cdf0e10cSrcweir                                         ::com::sun::star::sdbc::XResultSetMetaDataSupplier,
43cdf0e10cSrcweir                                         ::com::sun::star::lang::XServiceInfo> OPreparedStatement_BASE;
44cdf0e10cSrcweir 
45cdf0e10cSrcweir         class OPreparedStatement :  public  OStatement_BASE2,
46cdf0e10cSrcweir                                     public  OPreparedStatement_BASE
47cdf0e10cSrcweir         {
48cdf0e10cSrcweir         protected:
49cdf0e10cSrcweir             struct Parameter
50cdf0e10cSrcweir             {
51cdf0e10cSrcweir                 ::com::sun::star::uno::Any  aValue;
52cdf0e10cSrcweir                 sal_Int32                   nDataType;
53cdf0e10cSrcweir 
Parameterconnectivity::skeleton::OPreparedStatement::Parameter54cdf0e10cSrcweir                 Parameter(const ::com::sun::star::uno::Any& rValue,
55cdf0e10cSrcweir                           sal_Int32                         rDataType) : aValue(rValue),nDataType(rDataType)
56cdf0e10cSrcweir                 {
57cdf0e10cSrcweir                 }
58cdf0e10cSrcweir 
59cdf0e10cSrcweir             };
60cdf0e10cSrcweir 
61cdf0e10cSrcweir             ::std::vector< Parameter>       m_aParameters;
62cdf0e10cSrcweir             //====================================================================
63cdf0e10cSrcweir             // Data attributes
64cdf0e10cSrcweir             //====================================================================
65cdf0e10cSrcweir             TTypeInfoVector                 m_aTypeInfo;    // Hashtable containing an entry
66cdf0e10cSrcweir                                                                         //  for each row returned by
67cdf0e10cSrcweir                                                                         //  DatabaseMetaData.getTypeInfo.
68cdf0e10cSrcweir 
69cdf0e10cSrcweir             sal_Int32                       m_nNumParams;       // Number of parameter markers
70cdf0e10cSrcweir                                                                 //  for the prepared statement
71cdf0e10cSrcweir 
72cdf0e10cSrcweir             ::rtl::OUString                                                                 m_sSqlStatement;
73cdf0e10cSrcweir             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData >  m_xMetaData;
74cdf0e10cSrcweir             sal_Bool                                                                        m_bPrepared;
75cdf0e10cSrcweir 
76cdf0e10cSrcweir             void checkParameterIndex(sal_Int32 _parameterIndex);
77cdf0e10cSrcweir 
78cdf0e10cSrcweir         protected:
79cdf0e10cSrcweir             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle,
80cdf0e10cSrcweir                                                                    const ::com::sun::star::uno::Any& rValue)
81cdf0e10cSrcweir                                                                         throw (::com::sun::star::uno::Exception);
82cdf0e10cSrcweir             virtual ~OPreparedStatement();
83cdf0e10cSrcweir         public:
84cdf0e10cSrcweir             DECLARE_SERVICE_INFO();
85cdf0e10cSrcweir             // ein Konstruktor, der fuer das Returnen des Objektes benoetigt wird:
86cdf0e10cSrcweir             OPreparedStatement( OConnection* _pConnection,const TTypeInfoVector& _TypeInfo,const ::rtl::OUString& sql);
87cdf0e10cSrcweir 
88cdf0e10cSrcweir             //XInterface
89cdf0e10cSrcweir             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException);
90cdf0e10cSrcweir             virtual void SAL_CALL acquire() throw();
91cdf0e10cSrcweir             virtual void SAL_CALL release() throw();
92cdf0e10cSrcweir             //XTypeProvider
93cdf0e10cSrcweir             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  ) throw(::com::sun::star::uno::RuntimeException);
94cdf0e10cSrcweir 
95cdf0e10cSrcweir             // XPreparedStatement
96cdf0e10cSrcweir             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);
97cdf0e10cSrcweir             virtual sal_Int32 SAL_CALL executeUpdate(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
98cdf0e10cSrcweir             virtual sal_Bool SAL_CALL execute(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
99cdf0e10cSrcweir             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);
100cdf0e10cSrcweir             // XParameters
101cdf0e10cSrcweir             virtual void SAL_CALL setNull( sal_Int32 parameterIndex, sal_Int32 sqlType ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
102cdf0e10cSrcweir             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);
103cdf0e10cSrcweir             virtual void SAL_CALL setBoolean( sal_Int32 parameterIndex, sal_Bool x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
104cdf0e10cSrcweir             virtual void SAL_CALL setByte( sal_Int32 parameterIndex, sal_Int8 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
105cdf0e10cSrcweir             virtual void SAL_CALL setShort( sal_Int32 parameterIndex, sal_Int16 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
106cdf0e10cSrcweir             virtual void SAL_CALL setInt( sal_Int32 parameterIndex, sal_Int32 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
107cdf0e10cSrcweir             virtual void SAL_CALL setLong( sal_Int32 parameterIndex, sal_Int64 x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
108cdf0e10cSrcweir             virtual void SAL_CALL setFloat( sal_Int32 parameterIndex, float x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
109cdf0e10cSrcweir             virtual void SAL_CALL setDouble( sal_Int32 parameterIndex, double x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
110cdf0e10cSrcweir             virtual void SAL_CALL setString( sal_Int32 parameterIndex, const ::rtl::OUString& x ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
111cdf0e10cSrcweir             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);
112cdf0e10cSrcweir             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);
113cdf0e10cSrcweir             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);
114cdf0e10cSrcweir             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);
115cdf0e10cSrcweir             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);
116cdf0e10cSrcweir             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);
117cdf0e10cSrcweir             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);
118cdf0e10cSrcweir             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);
119cdf0e10cSrcweir             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);
120cdf0e10cSrcweir             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);
121cdf0e10cSrcweir             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);
122cdf0e10cSrcweir             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);
123cdf0e10cSrcweir             virtual void SAL_CALL clearParameters(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
124cdf0e10cSrcweir             // XPreparedBatchExecution
125cdf0e10cSrcweir             virtual void SAL_CALL addBatch(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
126cdf0e10cSrcweir             virtual void SAL_CALL clearBatch(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
127cdf0e10cSrcweir             virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL executeBatch(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
128cdf0e10cSrcweir             // XCloseable
129cdf0e10cSrcweir             virtual void SAL_CALL close(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
130cdf0e10cSrcweir             // XResultSetMetaDataSupplier
131cdf0e10cSrcweir             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);
132cdf0e10cSrcweir         };
133cdf0e10cSrcweir     }
134cdf0e10cSrcweir }
135cdf0e10cSrcweir #endif // CONNECTIVITY_SPREPAREDSTATEMENT_HXX
136