connectivity/source/inc/odbc/ODatabaseMetaDataResultSet.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ODatabaseMetaDataResultSet.hxx,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _CONNECTIVITY_ODBC_ADATABASEMETADATARESULTSET_HXX_
  32 #define _CONNECTIVITY_ODBC_ADATABASEMETADATARESULTSET_HXX_
  33
  34 #include <com/sun/star/sdbc/XResultSet.hpp>
  35 #include <com/sun/star/sdbc/XRow.hpp>
  36 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
  37 #include <com/sun/star/sdbc/XCloseable.hpp>
  38 #include <com/sun/star/sdbc/XColumnLocate.hpp>
  39 #include <com/sun/star/util/XCancellable.hpp>
  40 #include <com/sun/star/sdbc/XWarningsSupplier.hpp>
  41 #include <com/sun/star/sdbc/XResultSetUpdate.hpp>
  42 #include <com/sun/star/sdbc/XRowUpdate.hpp>
  43 #include <cppuhelper/compbase7.hxx>
  44 #include <comphelper/proparrhlp.hxx>
  45 #include "odbc/OStatement.hxx"
  46 #include "odbc/ODatabaseMetaData.hxx"
  47 #include "odbc/odbcbasedllapi.hxx"
  48 #include <comphelper/broadcasthelper.hxx>
  49 #include "connectivity/StdTypeDefs.hxx"
  50
  51 namespace connectivity
  52 {
  53     namespace odbc
  54     {
  55         class ODatabaseMetaDataResultSetMetaData;
  56         /*
  57         **      java_sql_ResultSet
  58         */
  59         typedef ::cppu::WeakComponentImplHelper7<       ::com::sun::star::sdbc::XResultSet,
  60                                                     ::com::sun::star::sdbc::XRow,
  61                                                     ::com::sun::star::sdbc::XResultSetMetaDataSupplier,
  62                                                     ::com::sun::star::util::XCancellable,
  63                                                     ::com::sun::star::sdbc::XWarningsSupplier,
  64                                                     ::com::sun::star::sdbc::XCloseable,
  65                                                     ::com::sun::star::sdbc::XColumnLocate> ODatabaseMetaDataResultSet_BASE;
  66
  67         class OOO_DLLPUBLIC_ODBCBASE ODatabaseMetaDataResultSet :
  68                                     public comphelper::OBaseMutex,
  69                                     public      ODatabaseMetaDataResultSet_BASE,
  70                                     public      ::cppu::OPropertySetHelper,
  71                                     public      ::comphelper::OPropertyArrayUsageHelper<ODatabaseMetaDataResultSet>
  72         {
  73             ::connectivity::TIntVector                                          m_aColMapping; // pos 0 is unused so we don't have to decrement 1 everytime
  74
  75             ::std::map<sal_Int32, ::connectivity::TInt2IntMap >                                 m_aValueRange;
  76             ::std::map<sal_Int32, ::connectivity::TString2IntMap >                              m_aStrValueRange;
  77
  78             ::std::map<sal_Int32, ::connectivity::TInt2StringMap >                              m_aIntValueRange;
  79             ::std::map<sal_Int32,SWORD>                                                         m_aODBCColumnTypes;
  80
  81             SQLHANDLE                                                                                                                                   m_aStatementHandle;
  82             SQLHANDLE                                                                                                                                   m_aConnectionHandle;
  83             ::com::sun::star::uno::WeakReferenceHelper                                                                  m_aStatement;
  84             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData>        m_xMetaData;
  85             SQLUSMALLINT*                                                               m_pRowStatusArray;
  86             OConnection*                                                                m_pConnection;
  87             rtl_TextEncoding                                                    m_nTextEncoding;
  88             sal_Int32                                                                   m_nRowPos;
  89             sal_Int32                                                                   m_nLastColumnPos;               // used for m_aRow just to know where we are
  90             sal_Int32                                                                   m_nDriverColumnCount;   // column count of the driver wich can sometimes be less than the metadata count
  91             SQLRETURN                                                                   m_nCurrentFetchState;
  92             sal_Bool                                                                    m_bWasNull;
  93             sal_Bool                                                                    m_bEOF;                                 // after last record
  94             sal_Bool                                                                    m_bFreeHandle;
  95
  96             // set the columncount of the driver
  97             void checkColumnCount();
  98             sal_Int32 getResultSetConcurrency() const throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
  99             sal_Int32 getResultSetType()                const throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 100             sal_Int32 getFetchDirection()               const throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 101             sal_Int32 getFetchSize()                    const throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 102             ::rtl::OUString getCursorName()             const throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 103
 104             sal_Int32 mapColumn (sal_Int32      column);
 105
 106         protected:
 107
 108             // OPropertyArrayUsageHelper
 109             virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
 110             // OPropertySetHelper
 111             virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper();
 112
 113             virtual sal_Bool SAL_CALL convertFastPropertyValue(
 114                                                                 ::com::sun::star::uno::Any & rConvertedValue,
 115                                                                 ::com::sun::star::uno::Any & rOldValue,
 116                                 sal_Int32 nHandle,
 117                                                                 const ::com::sun::star::uno::Any& rValue )
 118                                     throw (::com::sun::star::lang::IllegalArgumentException);
 119             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
 120                                     sal_Int32 nHandle,
 121                                                                         const ::com::sun::star::uno::Any& rValue
 122                                                      )
 123                                                                                                          throw (::com::sun::star::uno::Exception);
 124             virtual void SAL_CALL getFastPropertyValue(
 125                                                                         ::com::sun::star::uno::Any& rValue,
 126                                     sal_Int32 nHandle
 127                                          ) const;
 128             ~ODatabaseMetaDataResultSet();
 129         public:
 130             // ein Konstruktor, der fuer das Returnen des Objektes benoetigt wird:
 131             ODatabaseMetaDataResultSet(OConnection* _pConnection);
 132
 133
 134             inline oslGenericFunction getOdbcFunction(sal_Int32 _nIndex)  const
 135             {
 136                 return m_pConnection->getOdbcFunction(_nIndex);
 137             }
 138             // ::cppu::OComponentHelper
 139             virtual void SAL_CALL disposing(void);
 140             // XInterface
 141             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException);
 142             virtual void SAL_CALL acquire() throw();
 143             virtual void SAL_CALL release() throw();
 144             //XTypeProvider
 145             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  ) throw(::com::sun::star::uno::RuntimeException);
 146             // XPropertySet
 147             virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException);
 148             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > operator *()
 149             {
 150                 return ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >(*(ODatabaseMetaDataResultSet_BASE*)this);
 151             }
 152             // XResultSet
 153             virtual sal_Bool SAL_CALL next(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 154             virtual sal_Bool SAL_CALL isBeforeFirst(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 155             virtual sal_Bool SAL_CALL isAfterLast(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 156             virtual sal_Bool SAL_CALL isFirst(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 157             virtual sal_Bool SAL_CALL isLast(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 158             virtual void SAL_CALL beforeFirst(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 159             virtual void SAL_CALL afterLast(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 160             virtual sal_Bool SAL_CALL first(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 161             virtual sal_Bool SAL_CALL last(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 162             virtual sal_Int32 SAL_CALL getRow(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 163             virtual sal_Bool SAL_CALL absolute( sal_Int32 row ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 164             virtual sal_Bool SAL_CALL relative( sal_Int32 rows ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 165             virtual sal_Bool SAL_CALL previous(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 166             virtual void SAL_CALL refreshRow(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 167             virtual sal_Bool SAL_CALL rowUpdated(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 168             virtual sal_Bool SAL_CALL rowInserted(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 169             virtual sal_Bool SAL_CALL rowDeleted(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 170             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getStatement(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 171             // XRow
 172             virtual sal_Bool SAL_CALL wasNull(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 173             virtual ::rtl::OUString SAL_CALL getString( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 174             virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 175             virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 176             virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 177             virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 178             virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 179             virtual float SAL_CALL getFloat( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 180             virtual double SAL_CALL getDouble( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 181             virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 182             virtual ::com::sun::star::util::Date SAL_CALL getDate( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 183             virtual ::com::sun::star::util::Time SAL_CALL getTime( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 184             virtual ::com::sun::star::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 185             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 186             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 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 ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 188             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 189             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 190             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 191             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 192             // XResultSetMetaDataSupplier
 193             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);
 194             // XCancellable
 195             virtual void SAL_CALL cancel(  ) throw(::com::sun::star::uno::RuntimeException);
 196             // XCloseable
 197             virtual void SAL_CALL close(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 198             // XWarningsSupplier
 199             virtual ::com::sun::star::uno::Any SAL_CALL getWarnings(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 200             virtual void SAL_CALL clearWarnings(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 201             // XColumnLocate
 202             virtual sal_Int32 SAL_CALL findColumn( const ::rtl::OUString& columnName ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 203
 204             const ::connectivity::TIntVector& getColumnMapping() { return m_aColMapping; }
 205
 206             void openTablesTypes( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 207             void openTypeInfo() throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 208             void openCatalogs() throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 209             void openSchemas() throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 210             void openTables(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schemaPattern,
 211                                             const ::rtl::OUString& tableNamePattern, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& types )
 212                                             throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 213             void openColumnPrivileges(      const ::com::sun::star::uno::Any& catalog,    const ::rtl::OUString& schema,
 214                                                                     const ::rtl::OUString& table,   const ::rtl::OUString& columnNamePattern )throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 215             void openColumns(       const ::com::sun::star::uno::Any& catalog,                            const ::rtl::OUString& schemaPattern,
 216                                                     const ::rtl::OUString& tableNamePattern,        const ::rtl::OUString& columnNamePattern )throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 217             void openProcedureColumns(      const ::com::sun::star::uno::Any& catalog,            const ::rtl::OUString& schemaPattern,
 218                                                             const ::rtl::OUString& procedureNamePattern,const ::rtl::OUString& columnNamePattern )throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 219             void openProcedures(    const ::com::sun::star::uno::Any& catalog,            const ::rtl::OUString& schemaPattern,
 220                                                             const ::rtl::OUString& procedureNamePattern)throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 221             void openVersionColumns(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
 222                                                             const ::rtl::OUString& table)throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 223             void openBestRowIdentifier( const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
 224                                                                     const ::rtl::OUString& table,sal_Int32 scope,sal_Bool nullable )throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 225             void openForeignKeys( const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString* schema,const ::rtl::OUString* table,
 226                                                               const ::com::sun::star::uno::Any& catalog2, const ::rtl::OUString* schema2,const ::rtl::OUString* table2)throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 227             void openExportedKeys(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,const ::rtl::OUString& table)throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 228             void openImportedKeys(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,const ::rtl::OUString& table)throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 229             void openPrimaryKeys(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,const ::rtl::OUString& table)throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 230             void openTablePrivileges(const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schemaPattern,
 231                                                               const ::rtl::OUString& tableNamePattern)throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 232             void openSpecialColumns(sal_Bool _bRowVer,const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
 233                                                                     const ::rtl::OUString& table,sal_Int32 scope,   sal_Bool nullable )throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 234             void openIndexInfo( const ::com::sun::star::uno::Any& catalog, const ::rtl::OUString& schema,
 235                                                     const ::rtl::OUString& table,sal_Bool unique,sal_Bool approximate )throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 236
 237         protected:
 238             using OPropertySetHelper::getFastPropertyValue;
 239         };
 240     }
 241
 242 }
 243 #endif // _CONNECTIVITY_ADO_ADATABASEMETADATARESULTSET_HXX_
 244