xref: /trunk/main/connectivity/workben/skeleton/SResultSet.hxx (revision 91144cd0085a7583d2099b982122deb2184ab956)
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 #ifndef CONNECTIVITY_SRESULTSET_HXX
24 #define CONNECTIVITY_SRESULTSET_HXX
25 
26 #include <com/sun/star/sdbc/XResultSet.hpp>
27 #include <com/sun/star/sdbc/XRow.hpp>
28 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
29 #include <com/sun/star/sdbc/XCloseable.hpp>
30 #include <com/sun/star/sdbc/XColumnLocate.hpp>
31 #include <com/sun/star/util/XCancellable.hpp>
32 #include <com/sun/star/sdbc/XWarningsSupplier.hpp>
33 #include <com/sun/star/sdbc/XResultSetUpdate.hpp>
34 #include <com/sun/star/sdbc/XRowUpdate.hpp>
35 #include <com/sun/star/sdbcx/XRowLocate.hpp>
36 #include <com/sun/star/sdbcx/XDeleteRows.hpp>
37 #include <cppuhelper/compbase12.hxx>
38 #include <comphelper/proparrhlp.hxx>
39 #include "SStatement.hxx"
40 #include "connectivity/CommonTools.hxx"
41 #include "connectivity/FValue.hxx"
42 
43 namespace connectivity
44 {
45     namespace skeleton
46     {
47 
48         /*
49         **  java_sql_ResultSet
50         */
51         typedef ::cppu::WeakComponentImplHelper12<      ::com::sun::star::sdbc::XResultSet,
52                                                         ::com::sun::star::sdbc::XRow,
53                                                         ::com::sun::star::sdbc::XResultSetMetaDataSupplier,
54                                                         ::com::sun::star::util::XCancellable,
55                                                         ::com::sun::star::sdbc::XWarningsSupplier,
56                                                         ::com::sun::star::sdbc::XResultSetUpdate,
57                                                         ::com::sun::star::sdbc::XRowUpdate,
58                                                         ::com::sun::star::sdbcx::XRowLocate,
59                                                         ::com::sun::star::sdbcx::XDeleteRows,
60                                                         ::com::sun::star::sdbc::XCloseable,
61                                                         ::com::sun::star::sdbc::XColumnLocate,
62                                                         ::com::sun::star::lang::XServiceInfo> OResultSet_BASE;
63 
64 
65         typedef sal_Int64 TVoidPtr;
66         typedef ::std::allocator< TVoidPtr >    TVoidAlloc;
67         typedef ::std::vector<TVoidPtr>         TVoidVector;
68 
69         class OResultSet :  public  comphelper::OBaseMutex,
70                             public  OResultSet_BASE,
71                             public  ::cppu::OPropertySetHelper,
72                             public  ::comphelper::OPropertyArrayUsageHelper<OResultSet>
73         {
74         protected:
75             TVoidVector                                 m_aBindVector;
76             ::std::vector<sal_Int32>                    m_aLengthVector;
77             ::std::vector<sal_Int32>                    m_aColMapping; // pos 0 is unused so we don't have to decrement 1 every time
78             ::std::vector< ORowSetValue>                m_aRow; // only used when SQLGetData can't be called in any order
79             OStatement_Base*                            m_pStatement;
80             ::com::sun::star::uno::WeakReferenceHelper  m_aStatement;
81             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData>        m_xMetaData;
82             rtl_TextEncoding                            m_nTextEncoding;
83             sal_Int32                                   m_nRowPos;
84             sal_Int32                                   m_nLastColumnPos;       // used for m_aRow just to know where we are
85             sal_Bool                                    m_bWasNull;
86             sal_Bool                                    m_bBOF;                 // before first record
87             sal_Bool                                    m_bEOF;                 // after last record
88             sal_Bool                                    m_bLastRecord;
89             sal_Bool                                    m_bFreeHandle;
90             sal_Bool                                    m_bInserting;
91             sal_Bool                                    m_bFetchData;           // true when SQLGetaData can be called in any order or when fetching data for m_aRow
92 
93             sal_Bool  isBookmarkable()          const;
94             sal_Int32 getResultSetConcurrency() const;
95             sal_Int32 getResultSetType()        const;
96             sal_Int32 getFetchDirection()       const;
97             sal_Int32 getFetchSize()            const;
98             ::rtl::OUString getCursorName()     const;
99 
100             void setFetchDirection(sal_Int32 _par0);
101             void setFetchSize(sal_Int32 _par0);
102 
103 
104             void fillRow(sal_Int32 _nToColumn);
105             void allocBuffer(sal_Bool _bAllocRow);
106             void releaseBuffer();
107 
108 
109 
110             // OPropertyArrayUsageHelper
111             virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
112             // OPropertySetHelper
113             virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper();
114 
115             virtual sal_Bool SAL_CALL convertFastPropertyValue(
116                                 ::com::sun::star::uno::Any & rConvertedValue,
117                                 ::com::sun::star::uno::Any & rOldValue,
118                                 sal_Int32 nHandle,
119                                 const ::com::sun::star::uno::Any& rValue );
120             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
121                                     sal_Int32 nHandle,
122                                     const ::com::sun::star::uno::Any& rValue
123                                      );
124             virtual void SAL_CALL getFastPropertyValue(
125                                     ::com::sun::star::uno::Any& rValue,
126                                     sal_Int32 nHandle
127                                          ) const;
128 
129             // you can't delete objects of this type
130             virtual ~OResultSet();
131         public:
132             DECLARE_SERVICE_INFO();
133 
134             OResultSet( OStatement_Base* pStmt);
135 
136 
operator *()137             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > operator *()
138             {
139                 return ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >(*(OResultSet_BASE*)this);
140             }
141 
142             // ::cppu::OComponentHelper
143             virtual void SAL_CALL disposing(void);
144             // XInterface
145             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType );
146             virtual void SAL_CALL acquire();
147             virtual void SAL_CALL release();
148             //XTypeProvider
149             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  );
150             // XPropertySet
151             virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  );
152             // XResultSet
153             virtual sal_Bool SAL_CALL next(  );
154             virtual sal_Bool SAL_CALL isBeforeFirst(  );
155             virtual sal_Bool SAL_CALL isAfterLast(  );
156             virtual sal_Bool SAL_CALL isFirst(  );
157             virtual sal_Bool SAL_CALL isLast(  );
158             virtual void SAL_CALL beforeFirst(  );
159             virtual void SAL_CALL afterLast(  );
160             virtual sal_Bool SAL_CALL first(  );
161             virtual sal_Bool SAL_CALL last(  );
162             virtual sal_Int32 SAL_CALL getRow(  );
163             virtual sal_Bool SAL_CALL absolute( sal_Int32 row );
164             virtual sal_Bool SAL_CALL relative( sal_Int32 rows );
165             virtual sal_Bool SAL_CALL previous(  );
166             virtual void SAL_CALL refreshRow(  );
167             virtual sal_Bool SAL_CALL rowUpdated(  );
168             virtual sal_Bool SAL_CALL rowInserted(  );
169             virtual sal_Bool SAL_CALL rowDeleted(  );
170             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getStatement(  );
171             // XRow
172             virtual sal_Bool SAL_CALL wasNull(  );
173             virtual ::rtl::OUString SAL_CALL getString( sal_Int32 columnIndex );
174             virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex );
175             virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex );
176             virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex );
177             virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex );
178             virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex );
179             virtual float SAL_CALL getFloat( sal_Int32 columnIndex );
180             virtual double SAL_CALL getDouble( sal_Int32 columnIndex );
181             virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex );
182             virtual ::com::sun::star::util::Date SAL_CALL getDate( sal_Int32 columnIndex );
183             virtual ::com::sun::star::util::Time SAL_CALL getTime( sal_Int32 columnIndex );
184             virtual ::com::sun::star::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex );
185             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex );
186             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex );
187             virtual ::com::sun::star::uno::Any SAL_CALL getObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& typeMap );
188             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex );
189             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex );
190             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex );
191             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex );
192             // XResultSetMetaDataSupplier
193             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  );
194             // XCancellable
195             virtual void SAL_CALL cancel(  );
196             // XCloseable
197             virtual void SAL_CALL close(  );
198             // XWarningsSupplier
199             virtual ::com::sun::star::uno::Any SAL_CALL getWarnings(  );
200             virtual void SAL_CALL clearWarnings(  );
201             // XResultSetUpdate
202             virtual void SAL_CALL insertRow(  );
203             virtual void SAL_CALL updateRow(  );
204             virtual void SAL_CALL deleteRow(  );
205             virtual void SAL_CALL cancelRowUpdates(  );
206             virtual void SAL_CALL moveToInsertRow(  );
207             virtual void SAL_CALL moveToCurrentRow(  );
208             // XRowUpdate
209             virtual void SAL_CALL updateNull( sal_Int32 columnIndex );
210             virtual void SAL_CALL updateBoolean( sal_Int32 columnIndex, sal_Bool x );
211             virtual void SAL_CALL updateByte( sal_Int32 columnIndex, sal_Int8 x );
212             virtual void SAL_CALL updateShort( sal_Int32 columnIndex, sal_Int16 x );
213             virtual void SAL_CALL updateInt( sal_Int32 columnIndex, sal_Int32 x );
214             virtual void SAL_CALL updateLong( sal_Int32 columnIndex, sal_Int64 x );
215             virtual void SAL_CALL updateFloat( sal_Int32 columnIndex, float x );
216             virtual void SAL_CALL updateDouble( sal_Int32 columnIndex, double x );
217             virtual void SAL_CALL updateString( sal_Int32 columnIndex, const ::rtl::OUString& x );
218             virtual void SAL_CALL updateBytes( sal_Int32 columnIndex, const ::com::sun::star::uno::Sequence< sal_Int8 >& x );
219             virtual void SAL_CALL updateDate( sal_Int32 columnIndex, const ::com::sun::star::util::Date& x );
220             virtual void SAL_CALL updateTime( sal_Int32 columnIndex, const ::com::sun::star::util::Time& x );
221             virtual void SAL_CALL updateTimestamp( sal_Int32 columnIndex, const ::com::sun::star::util::DateTime& x );
222             virtual void SAL_CALL updateBinaryStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
223             virtual void SAL_CALL updateCharacterStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
224             virtual void SAL_CALL updateObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x );
225             virtual void SAL_CALL updateNumericObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x, sal_Int32 scale );
226             // XColumnLocate
227             virtual sal_Int32 SAL_CALL findColumn( const ::rtl::OUString& columnName );
228             // XRowLocate
229             virtual ::com::sun::star::uno::Any SAL_CALL getBookmark(  );
230             virtual sal_Bool SAL_CALL moveToBookmark( const ::com::sun::star::uno::Any& bookmark );
231             virtual sal_Bool SAL_CALL moveRelativeToBookmark( const ::com::sun::star::uno::Any& bookmark, sal_Int32 rows );
232             virtual sal_Int32 SAL_CALL compareBookmarks( const ::com::sun::star::uno::Any& first, const ::com::sun::star::uno::Any& second );
233             virtual sal_Bool SAL_CALL hasOrderedBookmarks(  );
234             virtual sal_Int32 SAL_CALL hashBookmark( const ::com::sun::star::uno::Any& bookmark );
235             // XDeleteRows
236             virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL deleteRows( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& rows );
237         };
238     }
239 }
240 #endif // CONNECTIVITY_SRESULTSET_HXX
241