1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef CONNECTIVITY_FILTERMANAGER_HXX
#define CONNECTIVITY_FILTERMANAGER_HXX
/** === begin UNO includes === **/
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/sdb/XSQLQueryComposer.hpp>
#include <com/sun/star/sdbc/XConnection.hpp>
/** === end UNO includes === **/
#include <rtl/ustring.hxx>
#include <vector>
#include "connectivity/dbtoolsdllapi.hxx"
//........................................................................
namespace dbtools
{
//........................................................................
//====================================================================
//= FilterManager
//====================================================================
/** manages the filter of a database component with filter properties
The idea is that the filter which a database component actually really uses is composed of several single
filter components (which all are conjunctive).
First, there is a component which is visible to the clients of the database component itself - if they ask
the database component for the Filter property, they will get this public filter.
Second, there is an implicit filter, which is (to be) created from the MasterFields and DetailFields
property of the database component, if the latter denote columns.<br/>
For instance, if there is a link-pair CustomerID->cid, where |CustomerID| is a column of the master
database component, and |cid| is a column of the detail database component (the database component we're responsible for), then there will
be an implicit filter "cid = :param_cid_link" (or something like this), which is never visible
to the clients of the database component, but nevertheless needs to be propagated to the aggregated RowSet.<br/>
Actually, this implicit filter is maintained by the FormParameterManager.
Potentially, there could be more filter components (for instance, you could imagine database component
controls which act as live filter, which could be implemented with a third component), but
at the moment there are only these two.
*/
class OOO_DLLPUBLIC_DBTOOLS FilterManager
{
public:
enum FilterComponent
{
fcPublicFilter = 0, // the filter which is to be published as "Filter" property of the database component
fcLinkFilter, // the filter part which is implicitly created for a database component when connecting
// master and detail database components via column names
FC_COMPONENT_COUNT // boundary delimiter, not to be used from outside
};
private:
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
m_xORB;
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
m_xComponentAggregate;
::std::vector< ::rtl::OUString > m_aFilterComponents;
sal_Bool m_bApplyPublicFilter;
public:
/// ctor
explicit FilterManager(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB
);
/// late ctor
void initialize(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxComponentAggregate );
/// makes the object forgetting the references to the database component
void dispose( );
const ::rtl::OUString& getFilterComponent( FilterComponent _eWhich ) const;
void setFilterComponent( FilterComponent _eWhich, const ::rtl::OUString& _rComponent );
inline sal_Bool isApplyPublicFilter( ) const { return m_bApplyPublicFilter; }
void setApplyPublicFilter( sal_Bool _bApply );
private:
/** retrieves a filter which is a conjunction of all single filter components
*/
::rtl::OUString getComposedFilter( ) const;
/** appends one filter component to the statement in our composer
*/
void appendFilterComponent( ::rtl::OUString& /* [inout] */ _rAppendTo, const ::rtl::OUString& _rComponent ) const;
/// checks whether there is only one (or even no) non-empty filter component
bool isThereAtMostOneComponent( ::rtl::OUString& _rOnlyComponent ) const;
/// returns the index of the first filter component which should be considered when building the composed filter
inline sal_Int32 getFirstApplicableFilterIndex() const
{
return m_bApplyPublicFilter ? fcPublicFilter : fcPublicFilter + 1;
}
};
//........................................................................
} // namespacefrm
//........................................................................
#endif // CONNECTIVITY_FORMFILTERMANAGER_HXX
|
