include/connectivity/filtermanager.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_FILTERMANAGER_HXX
  20 #define INCLUDED_CONNECTIVITY_FILTERMANAGER_HXX
  21
  22 #include <com/sun/star/uno/Reference.hxx>
  23
  24 #include <rtl/ustrbuf.hxx>
  25
  26 #include <connectivity/dbtoolsdllapi.hxx>
  27
  28 namespace com::sun::star::beans { class XPropertySet; }
  29
  30
  31 namespace dbtools
  32 {
  33
  34
  35     //= FilterManager
  36
  37     /** manages the filter of a database component with filter properties
  38
  39         The idea is that the filter which a database component actually really uses is composed of several single
  40         filter components (which all are conjunctive).
  41
  42         First, there is a component which is visible to the clients of the database component itself - if they ask
  43         the database component for the Filter property, they will get this public filter.
  44
  45         Second, there is an implicit filter, which is (to be) created from the MasterFields and DetailFields
  46         property of the database component, if the latter denote columns.<br/>
  47         For instance, if there is a link-pair CustomerID->cid, where |CustomerID| is a column of the master
  48         database component, and |cid| is a column of the detail database component (the database component we're responsible for), then there will
  49         be an implicit filter "cid = :param_cid_link" (or something like this), which is never visible
  50         to the clients of the database component, but nevertheless needs to be propagated to the aggregated RowSet.<br/>
  51         Actually, this implicit filter is maintained by the FormParameterManager.
  52
  53         Potentially, there could be more filter components (for instance, you could imagine database component
  54         controls which act as live filter, which could be implemented with a third component), but
  55         at the moment there are only these two.
  56     */
  57     class OOO_DLLPUBLIC_DBTOOLS FilterManager
  58     {
  59     public:
  60         enum class FilterComponent
  61         {
  62             PublicFilter,     // The filter which is to be published as "Filter" property of the database component.
  63             LinkFilter,       // The filter part which is implicitly created for a database component when connecting
  64                               // master and detail database components via column names.
  65             PublicHaving,     // the same, but should go in HAVING clause instead of WHERE clause
  66             LinkHaving
  67         };
  68
  69     private:
  70         css::uno::Reference< css::beans::XPropertySet >   m_xComponentAggregate;
  71         OUString                                          m_aPublicFilterComponent;
  72         OUString                                          m_aPublicHavingComponent;
  73         OUString                                          m_aLinkFilterComponent;
  74         OUString                                          m_aLinkHavingComponent;
  75         bool                                              m_bApplyPublicFilter;
  76
  77     public:
  78         /// ctor
  79         explicit FilterManager();
  80
  81         /// late ctor
  82         void    initialize(const css::uno::Reference< css::beans::XPropertySet >& _rxComponentAggregate );
  83
  84         /// makes the object forgetting the references to the database component
  85         void    dispose( );
  86
  87         const OUString&  getFilterComponent( FilterComponent _eWhich ) const;
  88         void             setFilterComponent( FilterComponent _eWhich, const OUString& _rComponent );
  89
  90         bool     isApplyPublicFilter( ) const { return m_bApplyPublicFilter; }
  91         void     setApplyPublicFilter( bool _bApply );
  92
  93     private:
  94         /** retrieves a filter which is a conjunction of all single filter components
  95         */
  96         OUString         getComposedFilter( ) const;
  97         OUString         getComposedHaving( ) const;
  98
  99         /** appends one filter component to the statement in our composer
 100         */
 101         static void      appendFilterComponent( OUStringBuffer& io_appendTo, const OUString& i_component );
 102
 103         /// checks whether there is only one (or even no) non-empty filter component
 104         bool    isThereAtMostOneFilterComponent( OUString& o_singleComponent ) const;
 105         bool    isThereAtMostOneHavingComponent( OUString& o_singleComponent ) const;
 106     };
 107
 108
 109 } // namespacefrm
 110
 111
 112 #endif // CONNECTIVITY_FORMFILTERMANAGER_HXX
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */