xref: /trunk/main/odk/examples/DevelopersGuide/Database/DriverSkeleton/SResultSet.hxx (revision 9d37da743abb7db0a497688391f6e55a19f27c44)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef CONNECTIVITY_SRESULTSET_HXX
25 #define CONNECTIVITY_SRESULTSET_HXX
26 
27 #include <com/sun/star/sdbc/XResultSet.hpp>
28 #include <com/sun/star/sdbc/XRow.hpp>
29 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
30 #include <com/sun/star/sdbc/XCloseable.hpp>
31 #include <com/sun/star/sdbc/XColumnLocate.hpp>
32 #include <com/sun/star/util/XCancellable.hpp>
33 #include <com/sun/star/sdbc/XWarningsSupplier.hpp>
34 #include <com/sun/star/sdbc/XResultSetUpdate.hpp>
35 #include <com/sun/star/sdbc/XRowUpdate.hpp>
36 #include <com/sun/star/sdbcx/XRowLocate.hpp>
37 #include <com/sun/star/sdbcx/XDeleteRows.hpp>
38 #include <cppuhelper/compbase12.hxx>
39 #include "SStatement.hxx"
40 #include "OSubComponent.hxx"
41 
42 namespace connectivity
43 {
44     namespace skeleton
45     {
46 
47         /*
48         **  OResultSet
49         */
50         typedef ::cppu::WeakComponentImplHelper12<      ::com::sun::star::sdbc::XResultSet,
51                                                         ::com::sun::star::sdbc::XRow,
52                                                         ::com::sun::star::sdbc::XResultSetMetaDataSupplier,
53                                                         ::com::sun::star::util::XCancellable,
54                                                         ::com::sun::star::sdbc::XWarningsSupplier,
55                                                         ::com::sun::star::sdbc::XResultSetUpdate,
56                                                         ::com::sun::star::sdbc::XRowUpdate,
57                                                         ::com::sun::star::sdbcx::XRowLocate,
58                                                         ::com::sun::star::sdbcx::XDeleteRows,
59                                                         ::com::sun::star::sdbc::XCloseable,
60                                                         ::com::sun::star::sdbc::XColumnLocate,
61                                                         ::com::sun::star::lang::XServiceInfo> OResultSet_BASE;
62 
63         class OResultSet :  public  OBase_Mutex,
64                             public  OResultSet_BASE,
65                             public  ::cppu::OPropertySetHelper,
66                             public  OPropertyArrayUsageHelper<OResultSet>
67         {
68         protected:
69             OStatement_Base*                            m_pStatement;
70             ::com::sun::star::uno::WeakReferenceHelper  m_aStatement;
71             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData>        m_xMetaData;
72             rtl_TextEncoding                            m_nTextEncoding;
73             sal_Bool                                    m_bWasNull;
74 
75             // OPropertyArrayUsageHelper
76             virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
77             // OPropertySetHelper
78             virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper();
79 
80             virtual sal_Bool SAL_CALL convertFastPropertyValue(
81                                 ::com::sun::star::uno::Any & rConvertedValue,
82                                 ::com::sun::star::uno::Any & rOldValue,
83                                 sal_Int32 nHandle,
84                                 const ::com::sun::star::uno::Any& rValue );
85             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
86                                     sal_Int32 nHandle,
87                                     const ::com::sun::star::uno::Any& rValue
88                                      );
89             virtual void SAL_CALL getFastPropertyValue(
90                                     ::com::sun::star::uno::Any& rValue,
91                                     sal_Int32 nHandle
92                                          ) const;
93 
94             // you can't delete objects of this type
95             virtual ~OResultSet();
96         public:
97             DECLARE_SERVICE_INFO();
98 
99             OResultSet( OStatement_Base* pStmt);
100 
101 
102             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > operator *()
103             {
104                 return ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >(*(OResultSet_BASE*)this);
105             }
106 
107             // ::cppu::OComponentHelper
108             virtual void SAL_CALL disposing(void);
109             // XInterface
110             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType );
111             virtual void SAL_CALL acquire() throw();
112             virtual void SAL_CALL release() throw();
113             //XTypeProvider
114             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  );
115             // XPropertySet
116             virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  );
117             // XResultSet
118             virtual sal_Bool SAL_CALL next(  );
119             virtual sal_Bool SAL_CALL isBeforeFirst(  );
120             virtual sal_Bool SAL_CALL isAfterLast(  );
121             virtual sal_Bool SAL_CALL isFirst(  );
122             virtual sal_Bool SAL_CALL isLast(  );
123             virtual void SAL_CALL beforeFirst(  );
124             virtual void SAL_CALL afterLast(  );
125             virtual sal_Bool SAL_CALL first(  );
126             virtual sal_Bool SAL_CALL last(  );
127             virtual sal_Int32 SAL_CALL getRow(  );
128             virtual sal_Bool SAL_CALL absolute( sal_Int32 row );
129             virtual sal_Bool SAL_CALL relative( sal_Int32 rows );
130             virtual sal_Bool SAL_CALL previous(  );
131             virtual void SAL_CALL refreshRow(  );
132             virtual sal_Bool SAL_CALL rowUpdated(  );
133             virtual sal_Bool SAL_CALL rowInserted(  );
134             virtual sal_Bool SAL_CALL rowDeleted(  );
135             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getStatement(  );
136             // XRow
137             virtual sal_Bool SAL_CALL wasNull(  );
138             virtual ::rtl::OUString SAL_CALL getString( sal_Int32 columnIndex );
139             virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex );
140             virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex );
141             virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex );
142             virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex );
143             virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex );
144             virtual float SAL_CALL getFloat( sal_Int32 columnIndex );
145             virtual double SAL_CALL getDouble( sal_Int32 columnIndex );
146             virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex );
147             virtual ::com::sun::star::util::Date SAL_CALL getDate( sal_Int32 columnIndex );
148             virtual ::com::sun::star::util::Time SAL_CALL getTime( sal_Int32 columnIndex );
149             virtual ::com::sun::star::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex );
150             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex );
151             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex );
152             virtual ::com::sun::star::uno::Any SAL_CALL getObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& typeMap );
153             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex );
154             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex );
155             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex );
156             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex );
157             // XResultSetMetaDataSupplier
158             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  );
159             // XCancellable
160             virtual void SAL_CALL cancel(  );
161             // XCloseable
162             virtual void SAL_CALL close(  );
163             // XWarningsSupplier
164             virtual ::com::sun::star::uno::Any SAL_CALL getWarnings(  );
165             virtual void SAL_CALL clearWarnings(  );
166             // XResultSetUpdate
167             virtual void SAL_CALL insertRow(  );
168             virtual void SAL_CALL updateRow(  );
169             virtual void SAL_CALL deleteRow(  );
170             virtual void SAL_CALL cancelRowUpdates(  );
171             virtual void SAL_CALL moveToInsertRow(  );
172             virtual void SAL_CALL moveToCurrentRow(  );
173             // XRowUpdate
174             virtual void SAL_CALL updateNull( sal_Int32 columnIndex );
175             virtual void SAL_CALL updateBoolean( sal_Int32 columnIndex, sal_Bool x );
176             virtual void SAL_CALL updateByte( sal_Int32 columnIndex, sal_Int8 x );
177             virtual void SAL_CALL updateShort( sal_Int32 columnIndex, sal_Int16 x );
178             virtual void SAL_CALL updateInt( sal_Int32 columnIndex, sal_Int32 x );
179             virtual void SAL_CALL updateLong( sal_Int32 columnIndex, sal_Int64 x );
180             virtual void SAL_CALL updateFloat( sal_Int32 columnIndex, float x );
181             virtual void SAL_CALL updateDouble( sal_Int32 columnIndex, double x );
182             virtual void SAL_CALL updateString( sal_Int32 columnIndex, const ::rtl::OUString& x );
183             virtual void SAL_CALL updateBytes( sal_Int32 columnIndex, const ::com::sun::star::uno::Sequence< sal_Int8 >& x );
184             virtual void SAL_CALL updateDate( sal_Int32 columnIndex, const ::com::sun::star::util::Date& x );
185             virtual void SAL_CALL updateTime( sal_Int32 columnIndex, const ::com::sun::star::util::Time& x );
186             virtual void SAL_CALL updateTimestamp( sal_Int32 columnIndex, const ::com::sun::star::util::DateTime& x );
187             virtual void SAL_CALL updateBinaryStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
188             virtual void SAL_CALL updateCharacterStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
189             virtual void SAL_CALL updateObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x );
190             virtual void SAL_CALL updateNumericObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x, sal_Int32 scale );
191             // XColumnLocate
192             virtual sal_Int32 SAL_CALL findColumn( const ::rtl::OUString& columnName );
193             // XRowLocate
194             virtual ::com::sun::star::uno::Any SAL_CALL getBookmark(  );
195             virtual sal_Bool SAL_CALL moveToBookmark( const ::com::sun::star::uno::Any& bookmark );
196             virtual sal_Bool SAL_CALL moveRelativeToBookmark( const ::com::sun::star::uno::Any& bookmark, sal_Int32 rows );
197             virtual sal_Int32 SAL_CALL compareBookmarks( const ::com::sun::star::uno::Any& first, const ::com::sun::star::uno::Any& second );
198             virtual sal_Bool SAL_CALL hasOrderedBookmarks(  );
199             virtual sal_Int32 SAL_CALL hashBookmark( const ::com::sun::star::uno::Any& bookmark );
200             // XDeleteRows
201             virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL deleteRows( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& rows );
202         };
203     }
204 }
205 #endif // CONNECTIVITY_SRESULTSET_HXX
206