connectivity/source/inc/odbc/ODatabaseMetaDataResultSet.hxx

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