include/ucbhelper/resultsethelper.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
  20 #ifndef INCLUDED_UCBHELPER_RESULTSETHELPER_HXX
  21 #define INCLUDED_UCBHELPER_RESULTSETHELPER_HXX
  22
  23 #include <memory>
  24 #include <osl/mutex.hxx>
  25 #include <com/sun/star/lang/XTypeProvider.hpp>
  26 #include <com/sun/star/lang/XServiceInfo.hpp>
  27 #include <com/sun/star/ucb/XDynamicResultSet.hpp>
  28 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  29 #include <com/sun/star/ucb/OpenCommandArgument2.hpp>
  30 #include <cppuhelper/weak.hxx>
  31 #include <ucbhelper/macros.hxx>
  32 #include <ucbhelper/contenthelper.hxx>
  33 #include <ucbhelper/ucbhelperdllapi.h>
  34
  35 namespace cppu {
  36     class OInterfaceContainerHelper;
  37 }
  38
  39 namespace ucbhelper {
  40
  41
  42 #define DYNAMICRESULTSET_SERVICE_NAME "com.sun.star.ucb.DynamicResultSet"
  43
  44
  45 /**
  46   * This is an abstract base class for implementations of the service
  47   * com.sun.star.ucb.DynamicResultSet, which is the result of the command
  48   * "open" executed at a UCB folder content.
  49   *
  50   * Features of the base class implementation:
  51   * - standard interfaces ( XInterface, XTypeProvider, XServiceInfo )
  52   * - all required interfaces for service css::ucb::DynamicResultSet
  53   */
  54 class UCBHELPER_DLLPUBLIC ResultSetImplHelper :
  55                 public cppu::OWeakObject,
  56                 public css::lang::XTypeProvider,
  57                 public css::lang::XServiceInfo,
  58                 public css::ucb::XDynamicResultSet
  59 {
  60     std::unique_ptr<cppu::OInterfaceContainerHelper> m_pDisposeEventListeners;
  61     bool                         m_bStatic;
  62     bool                         m_bInitDone;
  63
  64 protected:
  65     osl::Mutex                                                 m_aMutex;
  66     css::ucb::OpenCommandArgument2                             m_aCommand;
  67     css::uno::Reference< css::uno::XComponentContext >         m_xContext;
  68     // Resultset #1
  69     css::uno::Reference< css::sdbc::XResultSet >               m_xResultSet1;
  70     // Resultset #2
  71     css::uno::Reference< css::sdbc::XResultSet >               m_xResultSet2;
  72     // Resultset changes listener.
  73     css::uno::Reference< css::ucb::XDynamicResultSetListener > m_xListener;
  74
  75 private:
  76     UCBHELPER_DLLPRIVATE void init( bool bStatic );
  77
  78     /**
  79       * Your implementation of this method has to fill the protected member
  80       * m_xResultSet1. This resultset must implement a complete static
  81       * resultset ( service com.sun.star.ucb.ContentResultSet ). This method
  82       * will be called at most once in the life of your implementation object.
  83       * After this method was called, the type of this resultset will be
  84       * "static". There is no way to change the type afterwards.
  85       * If this method gets called the client wants to use your resultset
  86       * exclusively statically. You may deploy this factum to optimize your
  87       * implementation (i.e. "switch off" all changes detection code in
  88       * your implementation).
  89       * Note that you may use the class ucb::ResultSet to implement the
  90       * static resultset, that is required here.
  91       */
  92     UCBHELPER_DLLPRIVATE virtual void initStatic() = 0;
  93
  94     /**
  95       * Your implementation of this method has to fill the protected members
  96       * m_xResultSet1 and m_xResultSet2 of this base class. Each of these
  97       * resultsets must implement a complete static resultset
  98       * ( service com.sun.star.ucb.ContentResultSet ). This method will be
  99       * called at most once in the life of your implementation object.
 100       * After this method was called, the type of this resultset will be
 101       * "dynamic". There is no way to change the type afterwards.
 102       * If this method gets called the client wants to use your resultset
 103       * exclusively dynamically. This means, it is interested in getting
 104       * notifications on changes of data of the resultset contents. ( These
 105       * changes are to propagate by your implementation throw the member
 106       * m_xListener of this base class ).
 107       * If your implementation cannot detect changes of relevant data, you
 108       * may fill m_xResultSet1 and m_xResultSet2 with the same static resultset
 109       * implementation object. This normally will be the same instance you put
 110       * into m_xResultSet1 when initStatic() is called.
 111       */
 112     UCBHELPER_DLLPRIVATE virtual void initDynamic() = 0;
 113
 114 public:
 115     /**
 116       * Constructor.
 117       *
 118       * @param rxContext is a Service Manager.
 119       * @param rCommand is the parameter for the open command that produces
 120       *        this resultset.
 121       */
 122     ResultSetImplHelper(
 123             const css::uno::Reference<
 124                 css::uno::XComponentContext >& rxContext,
 125             const css::ucb::OpenCommandArgument2& rCommand );
 126
 127     /**
 128       * Destructor.
 129       */
 130     virtual ~ResultSetImplHelper() override;
 131
 132     // XInterface
 133     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
 134     virtual void SAL_CALL acquire()
 135         throw() override;
 136     virtual void SAL_CALL release()
 137         throw() override;
 138
 139     // XTypeProvider
 140     virtual css::uno::Sequence< sal_Int8 > SAL_CALL
 141     getImplementationId() override;
 142     virtual css::uno::Sequence< css::uno::Type > SAL_CALL
 143     getTypes() override;
 144
 145     // XServiceInfo
 146     virtual OUString SAL_CALL getImplementationName() override;
 147     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 148     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 149
 150     // XComponent ( base class of XDynamicResultSet )
 151     virtual void SAL_CALL
 152     dispose() override;
 153     virtual void SAL_CALL
 154     addEventListener( const css::uno::Reference< css::lang::XEventListener >& Listener ) override;
 155     virtual void SAL_CALL
 156     removeEventListener( const css::uno::Reference< css::lang::XEventListener >& Listener ) override;
 157
 158     // XDynamicResultSet
 159     virtual css::uno::Reference< css::sdbc::XResultSet > SAL_CALL
 160     getStaticResultSet() override;
 161     virtual void SAL_CALL
 162     setListener( const css::uno::Reference< css::ucb::XDynamicResultSetListener >& Listener ) override;
 163     virtual void SAL_CALL
 164     connectToCache( const css::uno::Reference< css::ucb::XDynamicResultSet > & xCache ) override;
 165
 166     /**
 167       * The implementation of this method always returns 0. Override this
 168       * method, if necessary.
 169       */
 170     virtual sal_Int16 SAL_CALL
 171     getCapabilities() override;
 172
 173 };
 174
 175 }
 176
 177 #endif /* ! INCLUDED_UCBHELPER_RESULTSETHELPER_HXX */
 178
 179 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */