connectivity/source/inc/odbc/OResultSetMetaData.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_CONNECTIVITY_SOURCE_INC_ODBC_ORESULTSETMETADATA_HXX
  21 #define INCLUDED_CONNECTIVITY_SOURCE_INC_ODBC_ORESULTSETMETADATA_HXX
  22
  23 #include <com/sun/star/sdbc/XResultSetMetaData.hpp>
  24 #include <cppuhelper/implbase.hxx>
  25 #include <odbc/OFunctions.hxx>
  26 #include <odbc/odbcbasedllapi.hxx>
  27 #include <vector>
  28 #include <odbc/OConnection.hxx>
  29
  30 namespace connectivity::odbc
  31     {
  32
  33         //************ Class: ResultSetMetaData
  34
  35         typedef ::cppu::WeakImplHelper<        css::sdbc::XResultSetMetaData>   OResultSetMetaData_BASE;
  36
  37         class OOO_DLLPUBLIC_ODBCBASE OResultSetMetaData final :
  38             public  OResultSetMetaData_BASE
  39         {
  40             std::vector<sal_Int32> m_vMapping; // when not every column is needed
  41             std::map<sal_Int32,sal_Int32> m_aColumnTypes;
  42
  43             SQLHANDLE       m_aStatementHandle;
  44             OConnection*    m_pConnection;
  45             sal_Int32       m_nColCount;
  46             bool        m_bUseODBC2Types;
  47
  48             /// @throws css::sdbc::SQLException
  49             /// @throws css::uno::RuntimeException
  50             OUString getCharColAttrib(sal_Int32 column,sal_Int32 ident);
  51             /// @throws css::sdbc::SQLException
  52             /// @throws css::uno::RuntimeException
  53             sal_Int32 getNumColAttrib(sal_Int32 column,sal_Int32 ident);
  54         public:
  55             // A ctor that is needed for returning the object
  56             OResultSetMetaData(OConnection* _pConnection, SQLHANDLE _pStmt )
  57                 :m_aStatementHandle( _pStmt )
  58                 ,m_pConnection(_pConnection)
  59                 ,m_nColCount(-1)
  60                 ,m_bUseODBC2Types(false)
  61             {}
  62             OResultSetMetaData(OConnection* _pConnection, SQLHANDLE _pStmt ,const std::vector<sal_Int32> & _vMapping)
  63                     :m_vMapping(_vMapping)
  64                     ,m_aStatementHandle( _pStmt )
  65                     ,m_pConnection(_pConnection)
  66                     ,m_nColCount(_vMapping.size()-1)
  67                     ,m_bUseODBC2Types(false)
  68             {}
  69             virtual ~OResultSetMetaData() override;
  70
  71
  72             /// @throws css::sdbc::SQLException
  73             /// @throws css::uno::RuntimeException
  74             static SQLLEN getNumColAttrib(OConnection const * _pConnection
  75                                               ,SQLHANDLE _aStatementHandle
  76                                               ,const css::uno::Reference< css::uno::XInterface >& _xInterface
  77                                               ,sal_Int32 _column
  78                                               ,sal_Int32 ident);
  79
  80             /// @throws css::sdbc::SQLException
  81             /// @throws css::uno::RuntimeException
  82             static SQLSMALLINT getColumnODBCType(OConnection const * _pConnection
  83                                               ,SQLHANDLE _aStatementHandle
  84                                               ,const css::uno::Reference< css::uno::XInterface >& _xInterface
  85                                               ,sal_Int32 column);
  86
  87             oslGenericFunction getOdbcFunction(ODBC3SQLFunctionId _nIndex)  const
  88             {
  89                 return m_pConnection->getOdbcFunction(_nIndex);
  90             }
  91
  92             virtual sal_Int32 SAL_CALL getColumnCount(  ) override;
  93             virtual sal_Bool SAL_CALL isAutoIncrement( sal_Int32 column ) override;
  94             virtual sal_Bool SAL_CALL isCaseSensitive( sal_Int32 column ) override;
  95             virtual sal_Bool SAL_CALL isSearchable( sal_Int32 column ) override;
  96             virtual sal_Bool SAL_CALL isCurrency( sal_Int32 column ) override;
  97             virtual sal_Int32 SAL_CALL isNullable( sal_Int32 column ) override;
  98             virtual sal_Bool SAL_CALL isSigned( sal_Int32 column ) override;
  99             virtual sal_Int32 SAL_CALL getColumnDisplaySize( sal_Int32 column ) override;
 100             virtual OUString SAL_CALL getColumnLabel( sal_Int32 column ) override;
 101             virtual OUString SAL_CALL getColumnName( sal_Int32 column ) override;
 102             virtual OUString SAL_CALL getSchemaName( sal_Int32 column ) override;
 103             virtual sal_Int32 SAL_CALL getPrecision( sal_Int32 column ) override;
 104             virtual sal_Int32 SAL_CALL getScale( sal_Int32 column ) override;
 105             virtual OUString SAL_CALL getTableName( sal_Int32 column ) override;
 106             virtual OUString SAL_CALL getCatalogName( sal_Int32 column ) override;
 107             virtual sal_Int32 SAL_CALL getColumnType( sal_Int32 column ) override;
 108             virtual OUString SAL_CALL getColumnTypeName( sal_Int32 column ) override;
 109             virtual sal_Bool SAL_CALL isReadOnly( sal_Int32 column ) override;
 110             virtual sal_Bool SAL_CALL isWritable( sal_Int32 column ) override;
 111             virtual sal_Bool SAL_CALL isDefinitelyWritable( sal_Int32 column ) override;
 112             virtual OUString SAL_CALL getColumnServiceName( sal_Int32 column ) override;
 113         };
 114
 115 }
 116 #endif // INCLUDED_CONNECTIVITY_SOURCE_INC_ODBC_ORESULTSETMETADATA_HXX
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */