connectivity/source/drivers/odbcbase/OResultSetMetaData.cxx

   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: OResultSetMetaData.cxx,v $
  10  * $Revision: 1.21 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_connectivity.hxx"
  33 #include "odbc/OResultSetMetaData.hxx"
  34 #include "odbc/OTools.hxx"
  35 #include <rtl/logfile.hxx>
  36
  37 using namespace connectivity::odbc;
  38 using namespace com::sun::star::uno;
  39 using namespace com::sun::star::lang;
  40 using namespace com::sun::star::sdbc;
  41
  42 // -------------------------------------------------------------------------
  43 OResultSetMetaData::~OResultSetMetaData()
  44 {
  45 }
  46 // -------------------------------------------------------------------------
  47 ::rtl::OUString OResultSetMetaData::getCharColAttrib(sal_Int32 _column,sal_Int32 ident) throw(SQLException, RuntimeException)
  48 {
  49     sal_Int32 column = _column;
  50     if(_column <(sal_Int32) m_vMapping.size()) // use mapping
  51         column = m_vMapping[_column];
  52
  53     SQLSMALLINT BUFFER_LEN = 128;
  54     char *pName = new char[BUFFER_LEN+1];
  55     SQLSMALLINT nRealLen=0;
  56     SQLRETURN nRet = N3SQLColAttribute(m_aStatementHandle,
  57                                     (SQLUSMALLINT)column,
  58                                     (SQLUSMALLINT)ident,
  59                                     (SQLPOINTER)pName,
  60                                     BUFFER_LEN,
  61                                     &nRealLen,
  62                                     NULL
  63                                     );
  64     ::rtl::OUString sValue;
  65     if ( nRet == SQL_SUCCESS )
  66         sValue = ::rtl::OUString(pName,nRealLen,m_pConnection->getTextEncoding());
  67     delete [] pName;
  68     OTools::ThrowException(m_pConnection,nRet,m_aStatementHandle,SQL_HANDLE_STMT,*this);
  69     if(nRealLen > BUFFER_LEN)
  70     {
  71         pName = new char[nRealLen+1];
  72         nRet = N3SQLColAttribute(m_aStatementHandle,
  73                                     (SQLUSMALLINT)column,
  74                                     (SQLUSMALLINT)ident,
  75                                     (SQLPOINTER)pName,
  76                                     nRealLen,
  77                                     &nRealLen,
  78                                     NULL
  79                                     );
  80         if ( nRet == SQL_SUCCESS )
  81             sValue = ::rtl::OUString(pName,nRealLen,m_pConnection->getTextEncoding());
  82         delete [] pName;
  83         OTools::ThrowException(m_pConnection,nRet,m_aStatementHandle,SQL_HANDLE_STMT,*this);
  84     }
  85
  86     return  sValue;
  87 }
  88 // -------------------------------------------------------------------------
  89 SQLLEN OResultSetMetaData::getNumColAttrib(OConnection* _pConnection
  90                                               ,SQLHANDLE _aStatementHandle
  91                                               ,const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _xInterface
  92                                               ,sal_Int32 _column
  93                                               ,sal_Int32 _ident) throw(SQLException, RuntimeException)
  94 {
  95     SQLLEN nValue=0;
  96     OTools::ThrowException(_pConnection,(*(T3SQLColAttribute)_pConnection->getOdbcFunction(ODBC3SQLColAttribute))(_aStatementHandle,
  97                                          (SQLUSMALLINT)_column,
  98                                          (SQLUSMALLINT)_ident,
  99                                          NULL,
 100                                          0,
 101                                          NULL,
 102                                          &nValue),_aStatementHandle,SQL_HANDLE_STMT,_xInterface);
 103     return nValue;
 104 }
 105 // -------------------------------------------------------------------------
 106 sal_Int32 OResultSetMetaData::getNumColAttrib(sal_Int32 _column,sal_Int32 ident) throw(SQLException, RuntimeException)
 107 {
 108     sal_Int32 column = _column;
 109     if(_column < (sal_Int32)m_vMapping.size()) // use mapping
 110         column = m_vMapping[_column];
 111
 112     return getNumColAttrib(m_pConnection,m_aStatementHandle,*this,column,ident);
 113 }
 114 // -------------------------------------------------------------------------
 115 sal_Int32 SAL_CALL OResultSetMetaData::getColumnDisplaySize( sal_Int32 column ) throw(SQLException, RuntimeException)
 116 {
 117     return getNumColAttrib(column,SQL_DESC_DISPLAY_SIZE);
 118 }
 119 // -------------------------------------------------------------------------
 120 SQLSMALLINT OResultSetMetaData::getColumnODBCType(OConnection* _pConnection
 121                                               ,SQLHANDLE _aStatementHandle
 122                                               ,const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _xInterface
 123                                               ,sal_Int32 column)
 124                                                throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException)
 125 {
 126     SQLSMALLINT nType = 0;
 127     try
 128     {
 129         nType = (SQLSMALLINT)getNumColAttrib(_pConnection,_aStatementHandle,_xInterface,column,SQL_DESC_CONCISE_TYPE);
 130         if(nType == SQL_UNKNOWN_TYPE)
 131             nType = (SQLSMALLINT)getNumColAttrib(_pConnection,_aStatementHandle,_xInterface,column, SQL_DESC_TYPE);
 132     }
 133     catch(SQLException& ) // in this case we have an odbc 2.0 driver
 134     {
 135         nType = (SQLSMALLINT)getNumColAttrib(_pConnection,_aStatementHandle,_xInterface,column,SQL_DESC_CONCISE_TYPE );
 136     }
 137
 138     return nType;
 139 }
 140 // -----------------------------------------------------------------------------
 141 sal_Int32 SAL_CALL OResultSetMetaData::getColumnType( sal_Int32 column ) throw(SQLException, RuntimeException)
 142 {
 143     ::std::map<sal_Int32,sal_Int32>::iterator aFind = m_aColumnTypes.find(column);
 144     if ( aFind == m_aColumnTypes.end() )
 145     {
 146         sal_Int32 nType = 0;
 147         if(!m_bUseODBC2Types)
 148         {
 149             try
 150             {
 151                 nType = getNumColAttrib(column,SQL_DESC_CONCISE_TYPE);
 152                 if(nType == SQL_UNKNOWN_TYPE)
 153                     nType = getNumColAttrib(column, SQL_DESC_TYPE);
 154                 nType = OTools::MapOdbcType2Jdbc(nType);
 155             }
 156             catch(SQLException& ) // in this case we have an odbc 2.0 driver
 157             {
 158                 m_bUseODBC2Types = sal_True;
 159                 nType = OTools::MapOdbcType2Jdbc(getNumColAttrib(column,SQL_DESC_CONCISE_TYPE ));
 160             }
 161         }
 162         else
 163             nType = OTools::MapOdbcType2Jdbc(getNumColAttrib(column,SQL_DESC_CONCISE_TYPE ));
 164         aFind = m_aColumnTypes.insert(::std::map<sal_Int32,sal_Int32>::value_type(column,nType)).first;
 165     }
 166
 167
 168     return aFind->second;
 169 }
 170 // -------------------------------------------------------------------------
 171
 172 sal_Int32 SAL_CALL OResultSetMetaData::getColumnCount(  ) throw(SQLException, RuntimeException)
 173 {
 174     if(m_nColCount != -1)
 175         return m_nColCount;
 176     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::getColumnCount" );
 177     sal_Int16 nNumResultCols=0;
 178     OTools::ThrowException(m_pConnection,N3SQLNumResultCols(m_aStatementHandle,&nNumResultCols),m_aStatementHandle,SQL_HANDLE_STMT,*this);
 179     return m_nColCount = nNumResultCols;
 180 }
 181 // -------------------------------------------------------------------------
 182
 183 sal_Bool SAL_CALL OResultSetMetaData::isCaseSensitive( sal_Int32 column ) throw(SQLException, RuntimeException)
 184 {
 185     return getNumColAttrib(column,SQL_DESC_CASE_SENSITIVE) == SQL_TRUE;
 186 }
 187 // -------------------------------------------------------------------------
 188
 189 ::rtl::OUString SAL_CALL OResultSetMetaData::getSchemaName( sal_Int32 column ) throw(SQLException, RuntimeException)
 190 {
 191     return getCharColAttrib(column,SQL_DESC_SCHEMA_NAME);
 192 }
 193 // -------------------------------------------------------------------------
 194
 195 ::rtl::OUString SAL_CALL OResultSetMetaData::getColumnName( sal_Int32 column ) throw(SQLException, RuntimeException)
 196 {
 197     return getCharColAttrib(column,SQL_DESC_NAME);
 198 }
 199 // -------------------------------------------------------------------------
 200 ::rtl::OUString SAL_CALL OResultSetMetaData::getTableName( sal_Int32 column ) throw(SQLException, RuntimeException)
 201 {
 202     return getCharColAttrib(column,SQL_DESC_TABLE_NAME);
 203 }
 204 // -------------------------------------------------------------------------
 205 ::rtl::OUString SAL_CALL OResultSetMetaData::getCatalogName( sal_Int32 column ) throw(SQLException, RuntimeException)
 206 {
 207     return getCharColAttrib(column,SQL_DESC_CATALOG_NAME);
 208 }
 209 // -------------------------------------------------------------------------
 210 ::rtl::OUString SAL_CALL OResultSetMetaData::getColumnTypeName( sal_Int32 column ) throw(SQLException, RuntimeException)
 211 {
 212     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::getColumnTypeName" );
 213     return getCharColAttrib(column,SQL_DESC_TYPE_NAME);
 214 }
 215 // -------------------------------------------------------------------------
 216 ::rtl::OUString SAL_CALL OResultSetMetaData::getColumnLabel( sal_Int32 column ) throw(SQLException, RuntimeException)
 217 {
 218     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::getColumnLabel" );
 219     return getCharColAttrib(column,SQL_DESC_LABEL);
 220 }
 221 // -------------------------------------------------------------------------
 222 ::rtl::OUString SAL_CALL OResultSetMetaData::getColumnServiceName( sal_Int32 /*column*/ ) throw(SQLException, RuntimeException)
 223 {
 224     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::getColumnServiceName" );
 225     return ::rtl::OUString();
 226 }
 227 // -------------------------------------------------------------------------
 228
 229 sal_Bool SAL_CALL OResultSetMetaData::isCurrency( sal_Int32 column ) throw(SQLException, RuntimeException)
 230 {
 231     return getNumColAttrib(column,SQL_DESC_FIXED_PREC_SCALE) == SQL_TRUE;
 232 }
 233 // -------------------------------------------------------------------------
 234
 235 sal_Bool SAL_CALL OResultSetMetaData::isAutoIncrement( sal_Int32 column ) throw(SQLException, RuntimeException)
 236 {
 237     return getNumColAttrib(column,SQL_DESC_AUTO_UNIQUE_VALUE) == SQL_TRUE;
 238 }
 239 // -------------------------------------------------------------------------
 240
 241
 242 sal_Bool SAL_CALL OResultSetMetaData::isSigned( sal_Int32 column ) throw(SQLException, RuntimeException)
 243 {
 244     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::isSigned" );
 245     return getNumColAttrib(column,SQL_DESC_UNSIGNED) == SQL_FALSE;
 246 }
 247 // -------------------------------------------------------------------------
 248 sal_Int32 SAL_CALL OResultSetMetaData::getPrecision( sal_Int32 column ) throw(SQLException, RuntimeException)
 249 {
 250     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::getPrecision" );
 251     sal_Int32 nType = 0;
 252     try
 253     {
 254         nType = getNumColAttrib(column,SQL_DESC_PRECISION);
 255     }
 256     catch(const SQLException& ) // in this case we have an odbc 2.0 driver
 257     {
 258         m_bUseODBC2Types = sal_True;
 259         nType = getNumColAttrib(column,SQL_COLUMN_PRECISION );
 260     }
 261     return nType;
 262 }
 263 // -----------------------------------------------------------------------------
 264 sal_Int32 SAL_CALL OResultSetMetaData::getScale( sal_Int32 column ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException)
 265 {
 266     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::getScale" );
 267     sal_Int32 nType = 0;
 268     try
 269     {
 270         nType = getNumColAttrib(column,SQL_DESC_SCALE);
 271     }
 272     catch(const SQLException& ) // in this case we have an odbc 2.0 driver
 273     {
 274         m_bUseODBC2Types = sal_True;
 275         nType = getNumColAttrib(column,SQL_COLUMN_SCALE );
 276     }
 277     return nType;
 278 }
 279 // -------------------------------------------------------------------------
 280
 281 sal_Int32 SAL_CALL OResultSetMetaData::isNullable( sal_Int32 column ) throw(SQLException, RuntimeException)
 282 {
 283     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::isNullable" );
 284     return getNumColAttrib(column,SQL_DESC_NULLABLE);
 285 }
 286 // -------------------------------------------------------------------------
 287
 288 sal_Bool SAL_CALL OResultSetMetaData::isSearchable( sal_Int32 column ) throw(SQLException, RuntimeException)
 289 {
 290     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::isSearchable" );
 291     return getNumColAttrib(column,SQL_DESC_SEARCHABLE) != SQL_PRED_NONE;
 292 }
 293 // -------------------------------------------------------------------------
 294
 295 sal_Bool SAL_CALL OResultSetMetaData::isReadOnly( sal_Int32 column ) throw(SQLException, RuntimeException)
 296 {
 297     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::isReadOnly" );
 298     return getNumColAttrib(column,SQL_DESC_UPDATABLE) == SQL_ATTR_READONLY;
 299 }
 300 // -------------------------------------------------------------------------
 301
 302 sal_Bool SAL_CALL OResultSetMetaData::isDefinitelyWritable( sal_Int32 column ) throw(SQLException, RuntimeException)
 303 {
 304     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::isDefinitelyWritable" );
 305     return getNumColAttrib(column,SQL_DESC_UPDATABLE) == SQL_ATTR_WRITE;
 306 ;
 307 }
 308 // -------------------------------------------------------------------------
 309 sal_Bool SAL_CALL OResultSetMetaData::isWritable( sal_Int32 column ) throw(SQLException, RuntimeException)
 310 {
 311     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "odbc", "Ocke.Janssen@sun.com", "OResultSetMetaData::isWritable" );
 312     return getNumColAttrib(column,SQL_DESC_UPDATABLE) == SQL_ATTR_WRITE;
 313 }
 314 // -------------------------------------------------------------------------
 315