connectivity/workben/skeleton/SResultSet.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 #ifndef INCLUDED_CONNECTIVITY_WORKBEN_SKELETON_SRESULTSET_HXX
  20 #define INCLUDED_CONNECTIVITY_WORKBEN_SKELETON_SRESULTSET_HXX
  21
  22 #include <com/sun/star/sdbc/XResultSet.hpp>
  23 #include <com/sun/star/sdbc/XRow.hpp>
  24 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
  25 #include <com/sun/star/sdbc/XCloseable.hpp>
  26 #include <com/sun/star/sdbc/XColumnLocate.hpp>
  27 #include <com/sun/star/util/XCancellable.hpp>
  28 #include <com/sun/star/sdbc/XWarningsSupplier.hpp>
  29 #include <com/sun/star/sdbc/XResultSetUpdate.hpp>
  30 #include <com/sun/star/sdbc/XRowUpdate.hpp>
  31 #include <com/sun/star/sdbcx/XRowLocate.hpp>
  32 #include <com/sun/star/sdbcx/XDeleteRows.hpp>
  33 #include <cppuhelper/compbase.hxx>
  34 #include <comphelper/proparrhlp.hxx>
  35 #include "SStatement.hxx"
  36 #include <connectivity/CommonTools.hxx>
  37 #include <connectivity/FValue.hxx>
  38
  39 namespace connectivity
  40 {
  41     namespace skeleton
  42     {
  43
  44         /*
  45         **  java_sql_ResultSet
  46         */
  47         typedef ::cppu::WeakComponentImplHelper<      css::sdbc::XResultSet,
  48                                                       css::sdbc::XRow,
  49                                                       css::sdbc::XResultSetMetaDataSupplier,
  50                                                       css::util::XCancellable,
  51                                                       css::sdbc::XWarningsSupplier,
  52                                                       css::sdbc::XResultSetUpdate,
  53                                                       css::sdbc::XRowUpdate,
  54                                                       css::sdbcx::XRowLocate,
  55                                                       css::sdbcx::XDeleteRows,
  56                                                       css::sdbc::XCloseable,
  57                                                       css::sdbc::XColumnLocate,
  58                                                       css::lang::XServiceInfo> OResultSet_BASE;
  59
  60
  61         typedef sal_Int64 TVoidPtr;
  62         typedef std::allocator< TVoidPtr >    TVoidAlloc;
  63         typedef std::vector<TVoidPtr>         TVoidVector;
  64
  65         class OResultSet :  public  cppu::BaseMutex,
  66                             public  OResultSet_BASE,
  67                             public  ::cppu::OPropertySetHelper,
  68                             public  ::comphelper::OPropertyArrayUsageHelper<OResultSet>
  69         {
  70         protected:
  71             TVoidVector                                 m_aBindVector;
  72             std::vector<sal_Int32>                    m_aLengthVector;
  73             std::vector<sal_Int32>                    m_aColMapping; // pos 0 is unused so we don't have to decrement 1 every time
  74             std::vector< ORowSetValue>                m_aRow; // only used when SQLGetData can't be called in any order
  75             OStatement_Base*                            m_pStatement;
  76             css::uno::WeakReferenceHelper               m_aStatement;
  77             css::uno::Reference< css::sdbc::XResultSetMetaData>        m_xMetaData;
  78             rtl_TextEncoding                            m_nTextEncoding;
  79             sal_Int32                                   m_nRowPos;
  80             sal_Int32                                   m_nLastColumnPos;       // used for m_aRow just to know where we are
  81             sal_Bool                                    m_bWasNull;
  82             sal_Bool                                    m_bBOF;                 // before first record
  83             sal_Bool                                    m_bEOF;                 // after last record
  84             sal_Bool                                    m_bLastRecord;
  85             sal_Bool                                    m_bFreeHandle;
  86             sal_Bool                                    m_bInserting;
  87             sal_Bool                                    m_bFetchData;           // true when SQLGetaData can be called in any order or when fetching data for m_aRow
  88
  89             sal_Bool  isBookmarkable()          const throw(css::sdbc::SQLException, css::uno::RuntimeException);
  90             sal_Int32 getResultSetConcurrency() const throw(css::sdbc::SQLException, css::uno::RuntimeException);
  91             sal_Int32 getResultSetType()        const throw(css::sdbc::SQLException, css::uno::RuntimeException);
  92             sal_Int32 getFetchDirection()       const throw(css::sdbc::SQLException, css::uno::RuntimeException);
  93             sal_Int32 getFetchSize()            const throw(css::sdbc::SQLException, css::uno::RuntimeException);
  94             OUString getCursorName()            const throw(css::sdbc::SQLException, css::uno::RuntimeException);
  95
  96             void setFetchDirection(sal_Int32 _par0) throw(css::sdbc::SQLException, css::uno::RuntimeException);
  97             void setFetchSize(sal_Int32 _par0) throw(css::sdbc::SQLException, css::uno::RuntimeException);
  98
  99
 100             void fillRow(sal_Int32 _nToColumn);
 101             void allocBuffer(sal_Bool _bAllocRow);
 102             void releaseBuffer();
 103
 104
 105             // OPropertyArrayUsageHelper
 106             virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
 107             // OPropertySetHelper
 108             virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper();
 109
 110             virtual sal_Bool SAL_CALL convertFastPropertyValue(
 111                                 css::uno::Any & rConvertedValue,
 112                                 css::uno::Any & rOldValue,
 113                                 sal_Int32 nHandle,
 114                                 const css::uno::Any& rValue )
 115                                     throw (css::lang::IllegalArgumentException);
 116             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
 117                                     sal_Int32 nHandle,
 118                                     const css::uno::Any& rValue
 119                                      )
 120                                      throw (css::uno::Exception);
 121             virtual void SAL_CALL getFastPropertyValue(
 122                                     css::uno::Any& rValue,
 123                                     sal_Int32 nHandle
 124                                          ) const;
 125
 126             // you can't delete objects of this type
 127             virtual ~OResultSet();
 128         public:
 129             DECLARE_SERVICE_INFO();
 130
 131             OResultSet( OStatement_Base* pStmt);
 132
 133
 134             css::uno::Reference< css::uno::XInterface > operator *()
 135             {
 136                 return css::uno::Reference< css::uno::XInterface >(*(OResultSet_BASE*)this);
 137             }
 138
 139             // ::cppu::OComponentHelper
 140             virtual void SAL_CALL disposing();
 141             // XInterface
 142             virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) throw(css::uno::RuntimeException);
 143             virtual void SAL_CALL acquire() throw(css::uno::RuntimeException);
 144             virtual void SAL_CALL release() throw(css::uno::RuntimeException);
 145             //XTypeProvider
 146             virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) throw(css::uno::RuntimeException);
 147             // XPropertySet
 148             virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(css::uno::RuntimeException);
 149             // XResultSet
 150             virtual sal_Bool SAL_CALL next(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 151             virtual sal_Bool SAL_CALL isBeforeFirst(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 152             virtual sal_Bool SAL_CALL isAfterLast(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 153             virtual sal_Bool SAL_CALL isFirst(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 154             virtual sal_Bool SAL_CALL isLast(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 155             virtual void SAL_CALL beforeFirst(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 156             virtual void SAL_CALL afterLast(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 157             virtual sal_Bool SAL_CALL first(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 158             virtual sal_Bool SAL_CALL last(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 159             virtual sal_Int32 SAL_CALL getRow(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 160             virtual sal_Bool SAL_CALL absolute( sal_Int32 row ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 161             virtual sal_Bool SAL_CALL relative( sal_Int32 rows ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 162             virtual sal_Bool SAL_CALL previous(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 163             virtual void SAL_CALL refreshRow(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 164             virtual sal_Bool SAL_CALL rowUpdated(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 165             virtual sal_Bool SAL_CALL rowInserted(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 166             virtual sal_Bool SAL_CALL rowDeleted(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 167             virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getStatement(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 168             // XRow
 169             virtual sal_Bool SAL_CALL wasNull(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 170             virtual OUString SAL_CALL getString( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 171             virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 172             virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 173             virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 174             virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 175             virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 176             virtual float SAL_CALL getFloat( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 177             virtual double SAL_CALL getDouble( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 178             virtual css::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 179             virtual css::util::Date SAL_CALL getDate( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 180             virtual css::util::Time SAL_CALL getTime( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 181             virtual css::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 182             virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 183             virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 184             virtual css::uno::Any SAL_CALL getObject( sal_Int32 columnIndex, const css::uno::Reference< css::container::XNameAccess >& typeMap ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 185             virtual css::uno::Reference< css::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 186             virtual css::uno::Reference< css::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 187             virtual css::uno::Reference< css::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 188             virtual css::uno::Reference< css::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 189             // XResultSetMetaDataSupplier
 190             virtual css::uno::Reference< css::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 191             // XCancellable
 192             virtual void SAL_CALL cancel(  ) throw(css::uno::RuntimeException);
 193             // XCloseable
 194             virtual void SAL_CALL close(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 195             // XWarningsSupplier
 196             virtual css::uno::Any SAL_CALL getWarnings(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 197             virtual void SAL_CALL clearWarnings(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 198             // XResultSetUpdate
 199             virtual void SAL_CALL insertRow(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 200             virtual void SAL_CALL updateRow(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 201             virtual void SAL_CALL deleteRow(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 202             virtual void SAL_CALL cancelRowUpdates(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 203             virtual void SAL_CALL moveToInsertRow(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 204             virtual void SAL_CALL moveToCurrentRow(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 205             // XRowUpdate
 206             virtual void SAL_CALL updateNull( sal_Int32 columnIndex ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 207             virtual void SAL_CALL updateBoolean( sal_Int32 columnIndex, sal_Bool x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 208             virtual void SAL_CALL updateByte( sal_Int32 columnIndex, sal_Int8 x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 209             virtual void SAL_CALL updateShort( sal_Int32 columnIndex, sal_Int16 x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 210             virtual void SAL_CALL updateInt( sal_Int32 columnIndex, sal_Int32 x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 211             virtual void SAL_CALL updateLong( sal_Int32 columnIndex, sal_Int64 x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 212             virtual void SAL_CALL updateFloat( sal_Int32 columnIndex, float x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 213             virtual void SAL_CALL updateDouble( sal_Int32 columnIndex, double x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 214             virtual void SAL_CALL updateString( sal_Int32 columnIndex, const OUString& x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 215             virtual void SAL_CALL updateBytes( sal_Int32 columnIndex, const css::uno::Sequence< sal_Int8 >& x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 216             virtual void SAL_CALL updateDate( sal_Int32 columnIndex, const css::util::Date& x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 217             virtual void SAL_CALL updateTime( sal_Int32 columnIndex, const css::util::Time& x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 218             virtual void SAL_CALL updateTimestamp( sal_Int32 columnIndex, const css::util::DateTime& x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 219             virtual void SAL_CALL updateBinaryStream( sal_Int32 columnIndex, const css::uno::Reference< css::io::XInputStream >& x, sal_Int32 length ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 220             virtual void SAL_CALL updateCharacterStream( sal_Int32 columnIndex, const css::uno::Reference< css::io::XInputStream >& x, sal_Int32 length ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 221             virtual void SAL_CALL updateObject( sal_Int32 columnIndex, const css::uno::Any& x ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 222             virtual void SAL_CALL updateNumericObject( sal_Int32 columnIndex, const css::uno::Any& x, sal_Int32 scale ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 223             // XColumnLocate
 224             virtual sal_Int32 SAL_CALL findColumn( const OUString& columnName ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 225             // XRowLocate
 226             virtual css::uno::Any SAL_CALL getBookmark(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 227             virtual sal_Bool SAL_CALL moveToBookmark( const css::uno::Any& bookmark ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 228             virtual sal_Bool SAL_CALL moveRelativeToBookmark( const css::uno::Any& bookmark, sal_Int32 rows ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 229             virtual sal_Int32 SAL_CALL compareBookmarks( const css::uno::Any& first, const css::uno::Any& second ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 230             virtual sal_Bool SAL_CALL hasOrderedBookmarks(  ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 231             virtual sal_Int32 SAL_CALL hashBookmark( const css::uno::Any& bookmark ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 232             // XDeleteRows
 233             virtual css::uno::Sequence< sal_Int32 > SAL_CALL deleteRows( const css::uno::Sequence< css::uno::Any >& rows ) throw(css::sdbc::SQLException, css::uno::RuntimeException);
 234         };
 235     }
 236 }
 237 #endif // INCLUDED_CONNECTIVITY_WORKBEN_SKELETON_SRESULTSET_HXX
 238
 239 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */