xmlhelp/source/cxxhelp/provider/resultsetbase.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_XMLHELP_SOURCE_CXXHELP_PROVIDER_RESULTSETBASE_HXX
  20 #define INCLUDED_XMLHELP_SOURCE_CXXHELP_PROVIDER_RESULTSETBASE_HXX
  21
  22 #include <vector>
  23 #include <memory>
  24 #include <cppuhelper/weak.hxx>
  25 #include <comphelper/interfacecontainer2.hxx>
  26 #include <com/sun/star/lang/XComponent.hpp>
  27 #include <com/sun/star/ucb/XContentAccess.hpp>
  28 #include <com/sun/star/sdbc/XCloseable.hpp>
  29 #include <com/sun/star/beans/XPropertySet.hpp>
  30 #include <com/sun/star/sdbc/XResultSet.hpp>
  31 #include <com/sun/star/sdbc/XRow.hpp>
  32 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
  33 #include <com/sun/star/ucb/XContentProvider.hpp>
  34 #include <com/sun/star/ucb/XContentIdentifier.hpp>
  35 #include <com/sun/star/uno/XComponentContext.hpp>
  36 #include <com/sun/star/beans/Property.hpp>
  37
  38
  39 namespace chelp {
  40
  41     class ResultSetBase
  42         : public cppu::OWeakObject,
  43           public css::lang::XComponent,
  44           public css::sdbc::XRow,
  45           public css::sdbc::XResultSet,
  46           public css::sdbc::XCloseable,
  47           public css::sdbc::XResultSetMetaDataSupplier,
  48           public css::beans::XPropertySet,
  49           public css::ucb::XContentAccess
  50     {
  51     public:
  52
  53         ResultSetBase( const css::uno::Reference< css::uno::XComponentContext >&  rxContext,
  54                        const css::uno::Reference< css::ucb::XContentProvider >&  xProvider,
  55                        const css::uno::Sequence< css::beans::Property >& seq );
  56
  57         virtual ~ResultSetBase() override;
  58
  59         // XInterface
  60         virtual css::uno::Any SAL_CALL
  61         queryInterface( const css::uno::Type& aType ) override;
  62
  63         virtual void SAL_CALL
  64         acquire()
  65             throw() override;
  66
  67         virtual void SAL_CALL
  68         release()
  69             throw() override;
  70
  71         // XComponent
  72         virtual void SAL_CALL
  73         dispose() override;
  74
  75         virtual void SAL_CALL
  76         addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
  77
  78         virtual void SAL_CALL
  79         removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
  80
  81
  82         // XRow
  83         virtual sal_Bool SAL_CALL
  84         wasNull() override
  85         {
  86             if( 0<= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
  87                 m_nWasNull = m_aItems[m_nRow]->wasNull();
  88             else
  89                 m_nWasNull = true;
  90             return m_nWasNull;
  91         }
  92
  93         virtual OUString SAL_CALL
  94         getString( sal_Int32 columnIndex ) override
  95         {
  96             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
  97                 return m_aItems[m_nRow]->getString( columnIndex );
  98             else
  99                 return OUString();
 100         }
 101
 102         virtual sal_Bool SAL_CALL
 103         getBoolean( sal_Int32 columnIndex ) override
 104         {
 105             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 106                 return m_aItems[m_nRow]->getBoolean( columnIndex );
 107             else
 108                 return false;
 109         }
 110
 111         virtual sal_Int8 SAL_CALL
 112         getByte( sal_Int32 columnIndex ) override
 113         {
 114             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 115                 return m_aItems[m_nRow]->getByte( columnIndex );
 116             else
 117                 return sal_Int8( 0 );
 118         }
 119
 120         virtual sal_Int16 SAL_CALL
 121         getShort( sal_Int32 columnIndex ) override
 122         {
 123             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 124                 return m_aItems[m_nRow]->getShort( columnIndex );
 125             else
 126                 return sal_Int16( 0 );
 127         }
 128
 129         virtual sal_Int32 SAL_CALL
 130         getInt( sal_Int32 columnIndex ) override
 131         {
 132             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 133                 return m_aItems[m_nRow]->getInt( columnIndex );
 134             else
 135                 return 0;
 136         }
 137
 138         virtual sal_Int64 SAL_CALL
 139         getLong( sal_Int32 columnIndex ) override
 140         {
 141             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 142                 return m_aItems[m_nRow]->getLong( columnIndex );
 143             else
 144                 return sal_Int64( 0 );
 145         }
 146
 147         virtual float SAL_CALL
 148         getFloat( sal_Int32 columnIndex ) override
 149         {
 150             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 151                 return m_aItems[m_nRow]->getFloat( columnIndex );
 152             else
 153                 return float( 0 );
 154         }
 155
 156         virtual double SAL_CALL
 157         getDouble( sal_Int32 columnIndex ) override
 158         {
 159             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 160                 return m_aItems[m_nRow]->getDouble( columnIndex );
 161             else
 162                 return double( 0 );
 163         }
 164
 165         virtual css::uno::Sequence< sal_Int8 > SAL_CALL
 166         getBytes( sal_Int32 columnIndex ) override
 167         {
 168             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 169                 return m_aItems[m_nRow]->getBytes( columnIndex );
 170             else
 171                 return css::uno::Sequence< sal_Int8 >();
 172         }
 173
 174         virtual css::util::Date SAL_CALL
 175         getDate( sal_Int32 columnIndex ) override
 176         {
 177             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 178                 return m_aItems[m_nRow]->getDate( columnIndex );
 179             else
 180                 return css::util::Date();
 181         }
 182
 183         virtual css::util::Time SAL_CALL
 184         getTime( sal_Int32 columnIndex ) override
 185         {
 186             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 187                 return m_aItems[m_nRow]->getTime( columnIndex );
 188             else
 189                 return css::util::Time();
 190         }
 191
 192         virtual css::util::DateTime SAL_CALL
 193         getTimestamp( sal_Int32 columnIndex ) override
 194         {
 195             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 196                 return m_aItems[m_nRow]->getTimestamp( columnIndex );
 197             else
 198                 return css::util::DateTime();
 199         }
 200
 201         virtual css::uno::Reference< css::io::XInputStream > SAL_CALL
 202         getBinaryStream( sal_Int32 columnIndex ) override
 203         {
 204             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 205                 return m_aItems[m_nRow]->getBinaryStream( columnIndex );
 206             else
 207                 return css::uno::Reference< css::io::XInputStream >();
 208         }
 209
 210         virtual css::uno::Reference< css::io::XInputStream > SAL_CALL
 211         getCharacterStream( sal_Int32 columnIndex ) override
 212         {
 213             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 214                 return m_aItems[m_nRow]->getCharacterStream( columnIndex );
 215             else
 216                 return css::uno::Reference< css::io::XInputStream >();
 217         }
 218
 219         virtual css::uno::Any SAL_CALL
 220         getObject( sal_Int32 columnIndex,
 221                    const css::uno::Reference< css::container::XNameAccess >& typeMap ) override
 222         {
 223             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 224                 return m_aItems[m_nRow]->getObject( columnIndex,typeMap );
 225             else
 226                 return css::uno::Any();
 227         }
 228
 229         virtual css::uno::Reference< css::sdbc::XRef > SAL_CALL
 230         getRef( sal_Int32 columnIndex ) override
 231         {
 232             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 233                 return m_aItems[m_nRow]->getRef( columnIndex );
 234             else
 235                 return css::uno::Reference< css::sdbc::XRef >();
 236         }
 237
 238         virtual css::uno::Reference< css::sdbc::XBlob > SAL_CALL
 239         getBlob( sal_Int32 columnIndex ) override
 240         {
 241             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 242                 return m_aItems[m_nRow]->getBlob( columnIndex );
 243             else
 244                 return css::uno::Reference< css::sdbc::XBlob >();
 245         }
 246
 247         virtual css::uno::Reference< css::sdbc::XClob > SAL_CALL
 248         getClob( sal_Int32 columnIndex ) override
 249         {
 250             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 251                 return m_aItems[m_nRow]->getClob( columnIndex );
 252             else
 253                 return css::uno::Reference< css::sdbc::XClob >();
 254         }
 255
 256         virtual css::uno::Reference< css::sdbc::XArray > SAL_CALL
 257         getArray( sal_Int32 columnIndex ) override
 258         {
 259             if( 0 <= m_nRow && sal::static_int_cast<sal_uInt32>( m_nRow ) < m_aItems.size() )
 260                 return m_aItems[m_nRow]->getArray( columnIndex );
 261             else
 262                 return css::uno::Reference< css::sdbc::XArray >();
 263         }
 264
 265
 266         // XResultSet
 267
 268         virtual sal_Bool SAL_CALL
 269         next() override;
 270
 271         virtual sal_Bool SAL_CALL
 272         isBeforeFirst() override;
 273
 274         virtual sal_Bool SAL_CALL
 275         isAfterLast() override;
 276
 277         virtual sal_Bool SAL_CALL
 278         isFirst() override;
 279
 280         virtual sal_Bool SAL_CALL
 281         isLast() override;
 282
 283         virtual void SAL_CALL
 284         beforeFirst() override;
 285
 286         virtual void SAL_CALL
 287         afterLast() override;
 288
 289         virtual sal_Bool SAL_CALL
 290         first() override;
 291
 292         virtual sal_Bool SAL_CALL
 293         last() override;
 294
 295         virtual sal_Int32 SAL_CALL
 296         getRow() override;
 297
 298         virtual sal_Bool SAL_CALL
 299         absolute( sal_Int32 row ) override;
 300
 301         virtual sal_Bool SAL_CALL
 302         relative( sal_Int32 rows ) override;
 303
 304         virtual sal_Bool SAL_CALL
 305         previous() override;
 306
 307         virtual void SAL_CALL
 308         refreshRow() override;
 309
 310         virtual sal_Bool SAL_CALL
 311         rowUpdated() override;
 312
 313         virtual sal_Bool SAL_CALL
 314         rowInserted() override;
 315
 316         virtual sal_Bool SAL_CALL
 317         rowDeleted() override;
 318
 319
 320         virtual  css::uno::Reference<  css::uno::XInterface > SAL_CALL
 321         getStatement() override;
 322
 323         // XCloseable
 324
 325         virtual void SAL_CALL
 326         close() override;
 327
 328         // XContentAccess
 329
 330         virtual OUString SAL_CALL
 331         queryContentIdentifierString() override;
 332
 333         virtual css::uno::Reference< css::ucb::XContentIdentifier > SAL_CALL
 334         queryContentIdentifier() override;
 335
 336         virtual css::uno::Reference< css::ucb::XContent > SAL_CALL
 337         queryContent() override;
 338
 339         // XResultSetMetaDataSupplier
 340         virtual css::uno::Reference< css::sdbc::XResultSetMetaData > SAL_CALL
 341         getMetaData() override;
 342
 343
 344         // XPropertySet
 345         virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL
 346         getPropertySetInfo() override;
 347
 348         virtual void SAL_CALL setPropertyValue(
 349             const OUString& aPropertyName,
 350             const css::uno::Any& aValue ) override;
 351
 352         virtual css::uno::Any SAL_CALL
 353         getPropertyValue(
 354             const OUString& PropertyName ) override;
 355
 356         virtual void SAL_CALL
 357         addPropertyChangeListener(
 358             const OUString& aPropertyName,
 359             const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
 360
 361         virtual void SAL_CALL
 362         removePropertyChangeListener(
 363             const OUString& aPropertyName,
 364             const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
 365
 366         virtual void SAL_CALL
 367         addVetoableChangeListener(
 368             const OUString& PropertyName,
 369             const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 370
 371         virtual void SAL_CALL removeVetoableChangeListener(
 372             const OUString& PropertyName,
 373             const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 374
 375     protected:
 376
 377         css::uno::Reference< css::uno::XComponentContext >  m_xContext;
 378         css::uno::Reference< css::ucb::XContentProvider >  m_xProvider;
 379         sal_Int32                           m_nRow;
 380         bool                                m_nWasNull;
 381
 382         typedef std::vector< css::uno::Reference< css::ucb::XContentIdentifier > > IdentSet;
 383         typedef std::vector< css::uno::Reference< css::sdbc::XRow > >              ItemSet;
 384
 385         IdentSet                            m_aIdents;
 386         ItemSet                             m_aItems;
 387         std::vector<OUString>               m_aPath;
 388
 389         css::uno::Sequence< css::beans::Property >           m_sProperty;
 390
 391         osl::Mutex                          m_aMutex;
 392         std::unique_ptr<comphelper::OInterfaceContainerHelper2>   m_pDisposeEventListeners;
 393
 394         std::unique_ptr<comphelper::OInterfaceContainerHelper2>   m_pRowCountListeners;
 395         std::unique_ptr<comphelper::OInterfaceContainerHelper2>   m_pIsFinalListeners;
 396     };
 397
 398
 399 } // end namespace fileaccess
 400
 401
 402 #endif
 403
 404 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */