xref: /trunk/main/connectivity/source/inc/odbc/ODatabaseMetaDataResultSet.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 
24 #ifndef _CONNECTIVITY_ODBC_ADATABASEMETADATARESULTSET_HXX_
25 #define _CONNECTIVITY_ODBC_ADATABASEMETADATARESULTSET_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 <cppuhelper/compbase7.hxx>
37 #include <comphelper/proparrhlp.hxx>
38 #include "odbc/OStatement.hxx"
39 #include "odbc/ODatabaseMetaData.hxx"
40 #include "odbc/odbcbasedllapi.hxx"
41 #include <comphelper/broadcasthelper.hxx>
42 #include "connectivity/StdTypeDefs.hxx"
43 
44 namespace connectivity
45 {
46     namespace odbc
47     {
48         class ODatabaseMetaDataResultSetMetaData;
49         /*
50         **  java_sql_ResultSet
51         */
52         typedef ::cppu::WeakComponentImplHelper7<   ::com::sun::star::sdbc::XResultSet,
53                                                     ::com::sun::star::sdbc::XRow,
54                                                     ::com::sun::star::sdbc::XResultSetMetaDataSupplier,
55                                                     ::com::sun::star::util::XCancellable,
56                                                     ::com::sun::star::sdbc::XWarningsSupplier,
57                                                     ::com::sun::star::sdbc::XCloseable,
58                                                     ::com::sun::star::sdbc::XColumnLocate> ODatabaseMetaDataResultSet_BASE;
59 
60         class OOO_DLLPUBLIC_ODBCBASE ODatabaseMetaDataResultSet :
61                                     public comphelper::OBaseMutex,
62                                     public  ODatabaseMetaDataResultSet_BASE,
63                                     public  ::cppu::OPropertySetHelper,
64                                     public  ::comphelper::OPropertyArrayUsageHelper<ODatabaseMetaDataResultSet>
65         {
66             ::connectivity::TIntVector                      m_aColMapping; // pos 0 is unused so we don't have to decrement 1 every time
67 
68             ::std::map<sal_Int32, ::connectivity::TInt2IntMap >                 m_aValueRange;
69             ::std::map<sal_Int32, ::connectivity::TString2IntMap >              m_aStrValueRange;
70 
71             ::std::map<sal_Int32, ::connectivity::TInt2StringMap >              m_aIntValueRange;
72             ::std::map<sal_Int32,SWORD>                                         m_aODBCColumnTypes;
73 
74             SQLHANDLE                                                                   m_aStatementHandle;
75             SQLHANDLE                                                                   m_aConnectionHandle;
76             ::com::sun::star::uno::WeakReferenceHelper                                  m_aStatement;
77             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData>        m_xMetaData;
78             SQLUSMALLINT*                               m_pRowStatusArray;
79             OConnection*                                m_pConnection;
80             rtl_TextEncoding                            m_nTextEncoding;
81             sal_Int32                                   m_nRowPos;
82             sal_Int32                                   m_nLastColumnPos;       // used for m_aRow just to know where we are
83             sal_Int32                                   m_nDriverColumnCount;   // column count of the driver which can sometimes be less than the metadata count
84             SQLRETURN                                   m_nCurrentFetchState;
85             sal_Bool                                    m_bWasNull;
86             sal_Bool                                    m_bEOF;                 // after last record
87             sal_Bool                                    m_bFreeHandle;
88 
89             // set the columncount of the driver
90             void checkColumnCount();
91             sal_Int32 getResultSetConcurrency() const;
92             sal_Int32 getResultSetType()        const;
93             sal_Int32 getFetchDirection()       const;
94             sal_Int32 getFetchSize()            const;
95             ::rtl::OUString getCursorName()     const;
96             SWORD                               impl_getColumnType_nothrow(sal_Int32 columnIndex);
97 
98             sal_Int32 mapColumn (sal_Int32  column);
99 
100         protected:
101 
102             // OPropertyArrayUsageHelper
103             virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
104             // OPropertySetHelper
105             virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper();
106 
107             virtual sal_Bool SAL_CALL convertFastPropertyValue(
108                                                                 ::com::sun::star::uno::Any & rConvertedValue,
109                                                                 ::com::sun::star::uno::Any & rOldValue,
110                                 sal_Int32 nHandle,
111                                                                 const ::com::sun::star::uno::Any& rValue );
112             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
113                                     sal_Int32 nHandle,
114                                                                         const ::com::sun::star::uno::Any& rValue
115                                                      );
116             virtual void SAL_CALL getFastPropertyValue(
117                                                                         ::com::sun::star::uno::Any& rValue,
118                                     sal_Int32 nHandle
119                                          ) const;
120             ~ODatabaseMetaDataResultSet();
121         public:
122             // ein Konstruktor, der fuer das Returnen des Objektes benoetigt wird:
123             ODatabaseMetaDataResultSet(OConnection* _pConnection);
124 
125 
getOdbcFunction(sal_Int32 _nIndex) const126             inline oslGenericFunction getOdbcFunction(sal_Int32 _nIndex)  const
127             {
128                 return m_pConnection->getOdbcFunction(_nIndex);
129             }
130             // ::cppu::OComponentHelper
131             virtual void SAL_CALL disposing(void);
132             // XInterface
133             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType );
134             virtual void SAL_CALL acquire() throw();
135             virtual void SAL_CALL release() throw();
136             //XTypeProvider
137             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  );
138             // XPropertySet
139             virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  );
operator *()140             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > operator *()
141             {
142                 return ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >(*(ODatabaseMetaDataResultSet_BASE*)this);
143             }
144             // XResultSet
145             virtual sal_Bool SAL_CALL next(  );
146             virtual sal_Bool SAL_CALL isBeforeFirst(  );
147             virtual sal_Bool SAL_CALL isAfterLast(  );
148             virtual sal_Bool SAL_CALL isFirst(  );
149             virtual sal_Bool SAL_CALL isLast(  );
150             virtual void SAL_CALL beforeFirst(  );
151             virtual void SAL_CALL afterLast(  );
152             virtual sal_Bool SAL_CALL first(  );
153             virtual sal_Bool SAL_CALL last(  );
154             virtual sal_Int32 SAL_CALL getRow(  );
155             virtual sal_Bool SAL_CALL absolute( sal_Int32 row );
156             virtual sal_Bool SAL_CALL relative( sal_Int32 rows );
157             virtual sal_Bool SAL_CALL previous(  );
158             virtual void SAL_CALL refreshRow(  );
159             virtual sal_Bool SAL_CALL rowUpdated(  );
160             virtual sal_Bool SAL_CALL rowInserted(  );
161             virtual sal_Bool SAL_CALL rowDeleted(  );
162             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getStatement(  );
163             // XRow
164             virtual sal_Bool SAL_CALL wasNull(  );
165             virtual ::rtl::OUString SAL_CALL getString( sal_Int32 columnIndex );
166             virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex );
167             virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex );
168             virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex );
169             virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex );
170             virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex );
171             virtual float SAL_CALL getFloat( sal_Int32 columnIndex );
172             virtual double SAL_CALL getDouble( sal_Int32 columnIndex );
173             virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex );
174             virtual ::com::sun::star::util::Date SAL_CALL getDate( sal_Int32 columnIndex );
175             virtual ::com::sun::star::util::Time SAL_CALL getTime( sal_Int32 columnIndex );
176             virtual ::com::sun::star::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex );
177             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex );
178             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex );
179             virtual ::com::sun::star::uno::Any SAL_CALL getObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& typeMap );
180             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex );
181             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex );
182             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex );
183             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex );
184             // XResultSetMetaDataSupplier
185             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  );
186             // XCancellable
187             virtual void SAL_CALL cancel(  );
188             // XCloseable
189             virtual void SAL_CALL close(  );
190             // XWarningsSupplier
191             virtual ::com::sun::star::uno::Any SAL_CALL getWarnings(  );
192             virtual void SAL_CALL clearWarnings(  );
193             // XColumnLocate
194             virtual sal_Int32 SAL_CALL findColumn( const ::rtl::OUString& columnName );
195 
getColumnMapping()196             const ::connectivity::TIntVector& getColumnMapping() { return m_aColMapping; }
197 
198             void openTablesTypes( );
199             void openTypeInfo();
200             void openCatalogs();
201             void openSchemas();
202             void openTables(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schemaPattern,
203                                             const ::rtl::OUString& tableNamePattern, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& types );
204             void openColumnPrivileges(      const ::com::sun::star::uno::Any& catalog,    const ::rtl::OUString& schema,
205                                                                     const ::rtl::OUString& table,   const ::rtl::OUString& columnNamePattern );
206             void openColumns(       const ::com::sun::star::uno::Any& catalog,                            const ::rtl::OUString& schemaPattern,
207                                                     const ::rtl::OUString& tableNamePattern,        const ::rtl::OUString& columnNamePattern );
208             void openProcedureColumns(      const ::com::sun::star::uno::Any& catalog,            const ::rtl::OUString& schemaPattern,
209                                                             const ::rtl::OUString& procedureNamePattern,const ::rtl::OUString& columnNamePattern );
210             void openProcedures(    const ::com::sun::star::uno::Any& catalog,            const ::rtl::OUString& schemaPattern,
211                                                             const ::rtl::OUString& procedureNamePattern);
212             void openVersionColumns(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
213                                                             const ::rtl::OUString& table);
214             void openBestRowIdentifier( const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
215                                                                     const ::rtl::OUString& table,sal_Int32 scope,sal_Bool nullable );
216             void openForeignKeys( const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString* schema,const ::rtl::OUString* table,
217                                                               const ::com::sun::star::uno::Any& catalog2, const ::rtl::OUString* schema2,const ::rtl::OUString* table2);
218             void openExportedKeys(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,const ::rtl::OUString& table);
219             void openImportedKeys(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,const ::rtl::OUString& table);
220             void openPrimaryKeys(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,const ::rtl::OUString& table);
221             void openTablePrivileges(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schemaPattern,
222                                                               const ::rtl::OUString& tableNamePattern);
223             void openSpecialColumns(sal_Bool _bRowVer,const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
224                                                                     const ::rtl::OUString& table,sal_Int32 scope,   sal_Bool nullable );
225             void openIndexInfo( const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
226                                                     const ::rtl::OUString& table,sal_Bool unique,sal_Bool approximate );
227 
228         protected:
229             using OPropertySetHelper::getFastPropertyValue;
230         };
231     }
232 
233 }
234 #endif // _CONNECTIVITY_ADO_ADATABASEMETADATARESULTSET_HXX_
235