ucbhelper/source/provider/resultsethelper.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: resultsethelper.cxx,v $
  10  * $Revision: 1.7 $
  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_ucbhelper.hxx"
  33
  34 /**************************************************************************
  35                                 TODO
  36  **************************************************************************
  37
  38  - This implementation is far away from completion. It has no interface
  39    for changes notifications etc.
  40
  41  *************************************************************************/
  42 #include <com/sun/star/ucb/ListActionType.hpp>
  43 #include <com/sun/star/ucb/WelcomeDynamicResultSetStruct.hpp>
  44 #include <com/sun/star/ucb/XCachedDynamicResultSetStubFactory.hpp>
  45 #include <com/sun/star/ucb/XSourceInitialization.hpp>
  46 #include <cppuhelper/interfacecontainer.hxx>
  47 #include <ucbhelper/resultsethelper.hxx>
  48
  49 #include "osl/diagnose.h"
  50
  51 using namespace com::sun::star;
  52
  53 //=========================================================================
  54 //=========================================================================
  55 //
  56 // ResultSetImplHelper Implementation.
  57 //
  58 //=========================================================================
  59 //=========================================================================
  60
  61 namespace ucbhelper {
  62
  63 //=========================================================================
  64 ResultSetImplHelper::ResultSetImplHelper(
  65     const uno::Reference< lang::XMultiServiceFactory >& rxSMgr )
  66 : m_pDisposeEventListeners( 0 ),
  67   m_bStatic( sal_False ),
  68   m_bInitDone( sal_False ),
  69   m_xSMgr( rxSMgr )
  70 {
  71 }
  72
  73 //=========================================================================
  74 ResultSetImplHelper::ResultSetImplHelper(
  75     const uno::Reference< lang::XMultiServiceFactory >& rxSMgr,
  76     const com::sun::star::ucb::OpenCommandArgument2& rCommand )
  77 : m_pDisposeEventListeners( 0 ),
  78   m_bStatic( sal_False ),
  79   m_bInitDone( sal_False ),
  80   m_aCommand( rCommand ),
  81   m_xSMgr( rxSMgr )
  82 {
  83 }
  84
  85 //=========================================================================
  86 // virtual
  87 ResultSetImplHelper::~ResultSetImplHelper()
  88 {
  89     delete m_pDisposeEventListeners;
  90 }
  91
  92 //=========================================================================
  93 //
  94 // XInterface methods.
  95 //
  96 //=========================================================================
  97
  98 XINTERFACE_IMPL_4( ResultSetImplHelper,
  99                    lang::XTypeProvider,
 100                    lang::XServiceInfo,
 101                    lang::XComponent, /* base of XDynamicResultSet */
 102                    com::sun::star::ucb::XDynamicResultSet );
 103
 104 //=========================================================================
 105 //
 106 // XTypeProvider methods.
 107 //
 108 //=========================================================================
 109
 110 XTYPEPROVIDER_IMPL_3( ResultSetImplHelper,
 111                       lang::XTypeProvider,
 112                          lang::XServiceInfo,
 113                       com::sun::star::ucb::XDynamicResultSet );
 114
 115 //=========================================================================
 116 //
 117 // XServiceInfo methods.
 118 //
 119 //=========================================================================
 120
 121 XSERVICEINFO_NOFACTORY_IMPL_1( ResultSetImplHelper,
 122                                rtl::OUString::createFromAscii(
 123                                    "ResultSetImplHelper" ),
 124                                rtl::OUString::createFromAscii(
 125                                    DYNAMICRESULTSET_SERVICE_NAME ) );
 126
 127 //=========================================================================
 128 //
 129 // XComponent methods.
 130 //
 131 //=========================================================================
 132
 133 // virtual
 134 void SAL_CALL ResultSetImplHelper::dispose()
 135     throw( uno::RuntimeException )
 136 {
 137     osl::MutexGuard aGuard( m_aMutex );
 138
 139     if ( m_pDisposeEventListeners && m_pDisposeEventListeners->getLength() )
 140     {
 141         lang::EventObject aEvt;
 142         aEvt.Source = static_cast< lang::XComponent * >( this );
 143         m_pDisposeEventListeners->disposeAndClear( aEvt );
 144     }
 145 }
 146
 147 //=========================================================================
 148 // virtual
 149 void SAL_CALL ResultSetImplHelper::addEventListener(
 150         const uno::Reference< lang::XEventListener >& Listener )
 151     throw( uno::RuntimeException )
 152 {
 153     osl::MutexGuard aGuard( m_aMutex );
 154
 155     if ( !m_pDisposeEventListeners )
 156         m_pDisposeEventListeners
 157             = new cppu::OInterfaceContainerHelper( m_aMutex );
 158
 159     m_pDisposeEventListeners->addInterface( Listener );
 160 }
 161
 162 //=========================================================================
 163 // virtual
 164 void SAL_CALL ResultSetImplHelper::removeEventListener(
 165         const uno::Reference< lang::XEventListener >& Listener )
 166     throw( uno::RuntimeException )
 167 {
 168     osl::MutexGuard aGuard( m_aMutex );
 169
 170     if ( m_pDisposeEventListeners )
 171         m_pDisposeEventListeners->removeInterface( Listener );
 172 }
 173
 174 //=========================================================================
 175 //
 176 // XDynamicResultSet methods.
 177 //
 178 //=========================================================================
 179
 180 // virtual
 181 uno::Reference< sdbc::XResultSet > SAL_CALL
 182 ResultSetImplHelper::getStaticResultSet()
 183     throw( com::sun::star::ucb::ListenerAlreadySetException,
 184            uno::RuntimeException )
 185 {
 186     osl::MutexGuard aGuard( m_aMutex );
 187
 188     if ( m_xListener.is() )
 189         throw com::sun::star::ucb::ListenerAlreadySetException();
 190
 191     init( sal_True );
 192     return m_xResultSet1;
 193 }
 194
 195 //=========================================================================
 196 // virtual
 197 void SAL_CALL ResultSetImplHelper::setListener(
 198         const uno::Reference< com::sun::star::ucb::XDynamicResultSetListener >&
 199             Listener )
 200     throw( com::sun::star::ucb::ListenerAlreadySetException,
 201            uno::RuntimeException )
 202 {
 203     osl::ClearableMutexGuard aGuard( m_aMutex );
 204
 205     if ( m_bStatic || m_xListener.is() )
 206         throw com::sun::star::ucb::ListenerAlreadySetException();
 207
 208     m_xListener = Listener;
 209
 210     //////////////////////////////////////////////////////////////////////
 211     // Create "welcome event" and send it to listener.
 212     //////////////////////////////////////////////////////////////////////
 213
 214     // Note: We only have the implementation for a static result set at the
 215     //       moment (src590). The dynamic result sets passed to the listener
 216     //       are a fake. This implementation will never call "notify" at the
 217     //       listener to propagate any changes!!!
 218
 219     init( sal_False );
 220
 221     uno::Any aInfo;
 222     aInfo <<= com::sun::star::ucb::WelcomeDynamicResultSetStruct(
 223         m_xResultSet1 /* "old" */,
 224         m_xResultSet2 /* "new" */ );
 225
 226     uno::Sequence< com::sun::star::ucb::ListAction > aActions( 1 );
 227     aActions.getArray()[ 0 ]
 228         = com::sun::star::ucb::ListAction(
 229             0, // Position; not used
 230             0, // Count; not used
 231             com::sun::star::ucb::ListActionType::WELCOME,
 232             aInfo );
 233     aGuard.clear();
 234
 235     Listener->notify(
 236         com::sun::star::ucb::ListEvent(
 237             static_cast< cppu::OWeakObject * >( this ), aActions ) );
 238 }
 239
 240 //=========================================================================
 241 // virtual
 242 sal_Int16 SAL_CALL ResultSetImplHelper::getCapabilities()
 243     throw( uno::RuntimeException )
 244 {
 245     // ! com::sun::star::ucb::ContentResultSetCapability::SORTED
 246     return 0;
 247 }
 248
 249 //=========================================================================
 250 // virtual
 251 void SAL_CALL ResultSetImplHelper::connectToCache(
 252         const uno::Reference< com::sun::star::ucb::XDynamicResultSet > &
 253             xCache )
 254     throw( com::sun::star::ucb::ListenerAlreadySetException,
 255            com::sun::star::ucb::AlreadyInitializedException,
 256            com::sun::star::ucb::ServiceNotFoundException,
 257            uno::RuntimeException )
 258 {
 259     if ( m_xListener.is() )
 260         throw com::sun::star::ucb::ListenerAlreadySetException();
 261
 262     if ( m_bStatic )
 263         throw com::sun::star::ucb::ListenerAlreadySetException();
 264
 265     uno::Reference< com::sun::star::ucb::XSourceInitialization >
 266         xTarget( xCache, uno::UNO_QUERY );
 267     if ( xTarget.is() )
 268     {
 269         uno::Reference<
 270             com::sun::star::ucb::XCachedDynamicResultSetStubFactory >
 271                 xStubFactory;
 272         try
 273         {
 274             xStubFactory
 275                 = uno::Reference<
 276                     com::sun::star::ucb::XCachedDynamicResultSetStubFactory >(
 277                         m_xSMgr->createInstance(
 278                             rtl::OUString::createFromAscii(
 279                                 "com.sun.star.ucb.CachedDynamicResultSetStubFactory" ) ),
 280                 uno::UNO_QUERY );
 281         }
 282         catch ( uno::Exception const & )
 283         {
 284         }
 285
 286         if ( xStubFactory.is() )
 287         {
 288             xStubFactory->connectToCache(
 289                                   this, xCache, m_aCommand.SortingInfo, 0 );
 290             return;
 291         }
 292     }
 293     throw com::sun::star::ucb::ServiceNotFoundException();
 294 }
 295
 296 //=========================================================================
 297 //
 298 // Non-interface methods.
 299 //
 300 //=========================================================================
 301
 302 void ResultSetImplHelper::init( sal_Bool bStatic )
 303 {
 304     osl::MutexGuard aGuard( m_aMutex );
 305
 306     if ( !m_bInitDone )
 307     {
 308         if ( bStatic )
 309         {
 310             // virtual... derived class fills m_xResultSet1
 311             initStatic();
 312
 313             OSL_ENSURE( m_xResultSet1.is(),
 314                         "ResultSetImplHelper::init - No 1st result set!" );
 315             m_bStatic = sal_True;
 316         }
 317         else
 318         {
 319             // virtual... derived class fills m_xResultSet1 and m_xResultSet2
 320             initDynamic();
 321
 322             OSL_ENSURE( m_xResultSet1.is(),
 323                         "ResultSetImplHelper::init - No 1st result set!" );
 324             OSL_ENSURE( m_xResultSet2.is(),
 325                         "ResultSetImplHelper::init - No 2nd result set!" );
 326             m_bStatic = sal_False;
 327         }
 328         m_bInitDone = sal_True;
 329     }
 330 }
 331
 332 } // namespace ucbhelper