ucbhelper/source/provider/resultsethelper.cxx

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