odk/examples/DevelopersGuide/Database/DriverSkeleton/SStatement.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  the BSD license.
   6  *
   7  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *  1. Redistributions of source code must retain the above copyright
  14  *     notice, this list of conditions and the following disclaimer.
  15  *  2. Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in the
  17  *     documentation and/or other materials provided with the distribution.
  18  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  19  *     contributors may be used to endorse or promote products derived
  20  *     from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  31  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  32  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  *************************************************************************/
  35
  36 #include <stdio.h>
  37 #include "SStatement.hxx"
  38 #include "SConnection.hxx"
  39 #include "SResultSet.hxx"
  40 #include <osl/thread.h>
  41 #include <com/sun/star/sdbc/ResultSetConcurrency.hpp>
  42 #include <com/sun/star/sdbc/ResultSetType.hpp>
  43 #include <com/sun/star/sdbc/FetchDirection.hpp>
  44 #include <com/sun/star/lang/DisposedException.hpp>
  45 #include <cppuhelper/typeprovider.hxx>
  46 #include <cppuhelper/queryinterface.hxx>
  47 #include "propertyids.hxx"
  48
  49 using namespace connectivity::skeleton;
  50
  51 using namespace com::sun::star::uno;
  52 using namespace com::sun::star::lang;
  53 using namespace com::sun::star::beans;
  54 using namespace com::sun::star::sdbc;
  55 using namespace com::sun::star::sdbcx;
  56 using namespace com::sun::star::container;
  57 using namespace com::sun::star::io;
  58 using namespace com::sun::star::util;
  59
  60 OStatement_Base::OStatement_Base(OConnection* _pConnection )
  61     : OStatement_BASE(m_aMutex),
  62     OPropertySetHelper(OStatement_BASE::rBHelper),
  63     rBHelper(OStatement_BASE::rBHelper),
  64     m_pConnection(_pConnection)
  65 {
  66     m_pConnection->acquire();
  67 }
  68
  69 OStatement_Base::~OStatement_Base()
  70 {
  71 }
  72
  73 void OStatement_Base::disposeResultSet()
  74 {
  75     // free the cursor if alive
  76     Reference< XComponent > xComp(m_xResultSet.get(), UNO_QUERY);
  77     if (xComp.is())
  78         xComp->dispose();
  79     m_xResultSet.clear();
  80 }
  81
  82 void OStatement_BASE2::disposing()
  83 {
  84     ::osl::MutexGuard aGuard(m_aMutex);
  85
  86     disposeResultSet();
  87
  88     if (m_pConnection)
  89         m_pConnection->release();
  90     m_pConnection = NULL;
  91
  92     dispose_ChildImpl();
  93     OStatement_Base::disposing();
  94 }
  95
  96 void SAL_CALL OStatement_BASE2::release() throw()
  97 {
  98     release_ChildImpl();
  99 }
 100
 101 Any SAL_CALL OStatement_Base::queryInterface( const Type & rType ) throw(RuntimeException)
 102 {
 103     Any aRet = OStatement_BASE::queryInterface(rType);
 104     if(!aRet.hasValue())
 105         aRet = OPropertySetHelper::queryInterface(rType);
 106     return aRet;
 107 }
 108
 109 Sequence< Type > SAL_CALL OStatement_Base::getTypes(  ) throw(RuntimeException)
 110 {
 111     ::cppu::OTypeCollection aTypes(
 112         ::cppu::UnoType<XMultiPropertySet>::get(),
 113         ::cppu::UnoType<XFastPropertySet>::get(),
 114         ::cppu::UnoType<XPropertySet>::get());
 115
 116     return concatSequences(aTypes.getTypes(),OStatement_BASE::getTypes());
 117 }
 118
 119
 120 void SAL_CALL OStatement_Base::cancel(  ) throw(RuntimeException)
 121 {
 122     ::osl::MutexGuard aGuard( m_aMutex );
 123     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 124     // cancel the current sql statement
 125 }
 126
 127
 128 void SAL_CALL OStatement_Base::close(  ) throw(SQLException, RuntimeException)
 129 {
 130     {
 131         ::osl::MutexGuard aGuard( m_aMutex );
 132         checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 133
 134     }
 135     dispose();
 136 }
 137
 138
 139 void SAL_CALL OStatement::clearBatch(  ) throw(SQLException, RuntimeException)
 140 {
 141     // if you support batches clear it here
 142 }
 143
 144 sal_Bool SAL_CALL OStatement_Base::execute( const ::rtl::OUString& sql ) throw(SQLException, RuntimeException)
 145 {
 146     ::osl::MutexGuard aGuard( m_aMutex );
 147     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 148
 149     // returns true when a resultset is available
 150     return sal_False;
 151 }
 152
 153
 154 Reference< XResultSet > SAL_CALL OStatement_Base::executeQuery( const ::rtl::OUString& sql ) throw(SQLException, RuntimeException)
 155 {
 156     ::osl::MutexGuard aGuard( m_aMutex );
 157     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 158
 159
 160     Reference< XResultSet > xRS = NULL;
 161     // create a resultset as result of executing the sql statement
 162     // you have to here something :-)
 163     m_xResultSet = xRS; // we need a reference to it for later use
 164     return xRS;
 165 }
 166
 167
 168 Reference< XConnection > SAL_CALL OStatement_Base::getConnection(  ) throw(SQLException, RuntimeException)
 169 {
 170     ::osl::MutexGuard aGuard( m_aMutex );
 171     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 172
 173     // just return our connection here
 174     return (Reference< XConnection >)m_pConnection;
 175 }
 176
 177 sal_Int32 SAL_CALL OStatement_Base::getUpdateCount(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException)
 178 {
 179     return 0;
 180 }
 181
 182
 183 Any SAL_CALL OStatement::queryInterface( const Type & rType ) throw(RuntimeException)
 184 {
 185     Any aRet = ::cppu::queryInterface(rType,static_cast< XBatchExecution*> (this));
 186     if(!aRet.hasValue())
 187         aRet = OStatement_Base::queryInterface(rType);
 188     return aRet;
 189 }
 190
 191
 192 void SAL_CALL OStatement::addBatch( const ::rtl::OUString& sql ) throw(SQLException, RuntimeException)
 193 {
 194     ::osl::MutexGuard aGuard( m_aMutex );
 195     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 196
 197
 198     m_aBatchVector.push_back(sql);
 199 }
 200
 201 Sequence< sal_Int32 > SAL_CALL OStatement::executeBatch(  ) throw(SQLException, RuntimeException)
 202 {
 203     ::osl::MutexGuard aGuard( m_aMutex );
 204     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 205
 206     return Sequence< sal_Int32 >();
 207 }
 208
 209
 210 sal_Int32 SAL_CALL OStatement_Base::executeUpdate( const ::rtl::OUString& sql ) throw(SQLException, RuntimeException)
 211 {
 212     ::osl::MutexGuard aGuard( m_aMutex );
 213     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 214
 215     // the return values gives information about how many rows are affected by executing the sql statement
 216     return 0;
 217
 218 }
 219
 220
 221 Reference< XResultSet > SAL_CALL OStatement_Base::getResultSet(  ) throw(SQLException, RuntimeException)
 222 {
 223     ::osl::MutexGuard aGuard( m_aMutex );
 224     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 225
 226 //  return our save resultset here
 227     return m_xResultSet;
 228 }
 229
 230
 231 sal_Bool SAL_CALL OStatement_Base::getMoreResults(  ) throw(SQLException, RuntimeException)
 232 {
 233     ::osl::MutexGuard aGuard( m_aMutex );
 234     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 235
 236     // if your driver supports more than only one resultset
 237     // and has one more at this moment return true
 238     return sal_False;
 239 }
 240
 241
 242 Any SAL_CALL OStatement_Base::getWarnings(  ) throw(SQLException, RuntimeException)
 243 {
 244     ::osl::MutexGuard aGuard( m_aMutex );
 245     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 246
 247
 248     return makeAny(m_aLastWarning);
 249 }
 250
 251
 252 void SAL_CALL OStatement_Base::clearWarnings(  ) throw(SQLException, RuntimeException)
 253 {
 254     ::osl::MutexGuard aGuard( m_aMutex );
 255     checkDisposed(OStatement_BASE::rBHelper.bDisposed);
 256
 257
 258     m_aLastWarning = SQLWarning();
 259 }
 260
 261 ::cppu::IPropertyArrayHelper* OStatement_Base::createArrayHelper( ) const
 262 {
 263     // this properties are define by the service statement
 264     // they must in alphabetic order
 265     Sequence< Property > aProps(10);
 266     Property* pProperties = aProps.getArray();
 267     sal_Int32 nPos = 0;
 268     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_CURSORNAME),
 269         PROPERTY_ID_CURSORNAME, ::cppu::UnoType<rtl::OUString>::get(), 0);
 270     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_ESCAPEPROCESSING),
 271         PROPERTY_ID_ESCAPEPROCESSING, cppu::UnoType<bool>::get(), 0);
 272     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_FETCHDIRECTION),
 273         PROPERTY_ID_FETCHDIRECTION, ::cppu::UnoType<sal_Int32>::get(), 0);
 274     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_FETCHSIZE),
 275         PROPERTY_ID_FETCHSIZE, ::cppu::UnoType<sal_Int32>::get(), 0);
 276     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_MAXFIELDSIZE),
 277         PROPERTY_ID_MAXFIELDSIZE, ::cppu::UnoType<sal_Int32>::get(), 0);
 278     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_MAXROWS),
 279         PROPERTY_ID_MAXROWS, ::cppu::UnoType<sal_Int32>::get(), 0);
 280     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_QUERYTIMEOUT),
 281         PROPERTY_ID_QUERYTIMEOUT, ::cppu::UnoType<sal_Int32>::get(), 0);
 282     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_RESULTSETCONCURRENCY),
 283         PROPERTY_ID_RESULTSETCONCURRENCY, ::cppu::UnoType<sal_Int32>::get(), 0);
 284     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_RESULTSETTYPE),
 285         PROPERTY_ID_RESULTSETTYPE, ::cppu::UnoType<sal_Int32>::get(), 0);
 286     pProperties[nPos++] = ::com::sun::star::beans::Property(OPropertyMap::getPropMap().getNameByIndex(PROPERTY_ID_USEBOOKMARKS),
 287         PROPERTY_ID_USEBOOKMARKS, cppu::UnoType<bool>::get(), 0);
 288
 289     return new ::cppu::OPropertyArrayHelper(aProps);
 290 }
 291
 292
 293 ::cppu::IPropertyArrayHelper & OStatement_Base::getInfoHelper()
 294 {
 295     return *const_cast<OStatement_Base*>(this)->getArrayHelper();
 296 }
 297
 298 sal_Bool OStatement_Base::convertFastPropertyValue(
 299                             Any & rConvertedValue,
 300                             Any & rOldValue,
 301                             sal_Int32 nHandle,
 302                             const Any& rValue )
 303                                 throw (::com::sun::star::lang::IllegalArgumentException)
 304 {
 305     sal_Bool bConverted = sal_False;
 306     // here we have to try to convert
 307     return bConverted;
 308 }
 309
 310 void OStatement_Base::setFastPropertyValue_NoBroadcast(sal_Int32 nHandle,const Any& rValue) throw (Exception)
 311 {
 312     // set the value to whatever is necessary
 313     switch(nHandle)
 314     {
 315         case PROPERTY_ID_QUERYTIMEOUT:
 316         case PROPERTY_ID_MAXFIELDSIZE:
 317         case PROPERTY_ID_MAXROWS:
 318         case PROPERTY_ID_CURSORNAME:
 319         case PROPERTY_ID_RESULTSETCONCURRENCY:
 320         case PROPERTY_ID_RESULTSETTYPE:
 321         case PROPERTY_ID_FETCHDIRECTION:
 322         case PROPERTY_ID_FETCHSIZE:
 323         case PROPERTY_ID_ESCAPEPROCESSING:
 324         case PROPERTY_ID_USEBOOKMARKS:
 325         default:
 326             ;
 327     }
 328 }
 329
 330 void OStatement_Base::getFastPropertyValue(Any& rValue,sal_Int32 nHandle) const
 331 {
 332     switch(nHandle)
 333     {
 334         case PROPERTY_ID_QUERYTIMEOUT:
 335         case PROPERTY_ID_MAXFIELDSIZE:
 336         case PROPERTY_ID_MAXROWS:
 337         case PROPERTY_ID_CURSORNAME:
 338         case PROPERTY_ID_RESULTSETCONCURRENCY:
 339         case PROPERTY_ID_RESULTSETTYPE:
 340         case PROPERTY_ID_FETCHDIRECTION:
 341         case PROPERTY_ID_FETCHSIZE:
 342         case PROPERTY_ID_ESCAPEPROCESSING:
 343         case PROPERTY_ID_USEBOOKMARKS:
 344         default:
 345             ;
 346     }
 347 }
 348
 349 IMPLEMENT_SERVICE_INFO(OStatement,"com.sun.star.sdbcx.OStatement","com.sun.star.sdbc.Statement");
 350
 351 void SAL_CALL OStatement_Base::acquire() throw()
 352 {
 353     OStatement_BASE::acquire();
 354 }
 355
 356 void SAL_CALL OStatement_Base::release() throw()
 357 {
 358     OStatement_BASE::release();
 359 }
 360
 361 void SAL_CALL OStatement::acquire() throw()
 362 {
 363     OStatement_BASE2::acquire();
 364 }
 365
 366 void SAL_CALL OStatement::release() throw()
 367 {
 368     OStatement_BASE2::release();
 369 }
 370
 371 Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL OStatement_Base::getPropertySetInfo(  ) throw(RuntimeException)
 372 {
 373     return ::cppu::OPropertySetHelper::createPropertySetInfo(getInfoHelper());
 374 }
 375
 376
 377 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */