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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_UCBHELPER_RESULTSETHELPER_HXX
#define INCLUDED_UCBHELPER_RESULTSETHELPER_HXX
#include <memory>
#include <osl/mutex.hxx>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/ucb/XDynamicResultSet.hpp>
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#include <com/sun/star/ucb/OpenCommandArgument2.hpp>
#include <cppuhelper/weak.hxx>
#include <ucbhelper/macros.hxx>
#include <ucbhelper/contenthelper.hxx>
#include <ucbhelper/ucbhelperdllapi.h>
namespace cppu {
class OInterfaceContainerHelper;
}
namespace ucbhelper {
#define DYNAMICRESULTSET_SERVICE_NAME "com.sun.star.ucb.DynamicResultSet"
/**
* This is an abstract base class for implementations of the service
* com.sun.star.ucb.DynamicResultSet, which is the result of the command
* "open" executed at a UCB folder content.
*
* Features of the base class implementation:
* - standard interfaces ( XInterface, XTypeProvider, XServiceInfo )
* - all required interfaces for service css::ucb::DynamicResultSet
*/
class UCBHELPER_DLLPUBLIC ResultSetImplHelper :
public cppu::OWeakObject,
public css::lang::XTypeProvider,
public css::lang::XServiceInfo,
public css::ucb::XDynamicResultSet
{
std::unique_ptr<cppu::OInterfaceContainerHelper> m_pDisposeEventListeners;
bool m_bStatic;
bool m_bInitDone;
protected:
osl::Mutex m_aMutex;
css::ucb::OpenCommandArgument2 m_aCommand;
css::uno::Reference< css::uno::XComponentContext > m_xContext;
// Resultset #1
css::uno::Reference< css::sdbc::XResultSet > m_xResultSet1;
// Resultset #2
css::uno::Reference< css::sdbc::XResultSet > m_xResultSet2;
// Resultset changes listener.
css::uno::Reference< css::ucb::XDynamicResultSetListener > m_xListener;
private:
UCBHELPER_DLLPRIVATE void init( bool bStatic );
/**
* Your implementation of this method has to fill the protected member
* m_xResultSet1. This resultset must implement a complete static
* resultset ( service com.sun.star.ucb.ContentResultSet ). This method
* will be called at most once in the life of your implementation object.
* After this method was called, the type of this resultset will be
* "static". There is no way to change the type afterwards.
* If this method gets called the client wants to use your resultset
* exclusively statically. You may deploy this factum to optimize your
* implementation (i.e. "switch off" all changes detection code in
* your implementation).
* Note that you may use the class ucb::ResultSet to implement the
* static resultset, that is required here.
*/
UCBHELPER_DLLPRIVATE virtual void initStatic() = 0;
/**
* Your implementation of this method has to fill the protected members
* m_xResultSet1 and m_xResultSet2 of this base class. Each of these
* resultsets must implement a complete static resultset
* ( service com.sun.star.ucb.ContentResultSet ). This method will be
* called at most once in the life of your implementation object.
* After this method was called, the type of this resultset will be
* "dynamic". There is no way to change the type afterwards.
* If this method gets called the client wants to use your resultset
* exclusively dynamically. This means, it is interested in getting
* notifications on changes of data of the resultset contents. ( These
* changes are to propagate by your implementation throw the member
* m_xListener of this base class ).
* If your implementation cannot detect changes of relevant data, you
* may fill m_xResultSet1 and m_xResultSet2 with the same static resultset
* implementation object. This normally will be the same instance you put
* into m_xResultSet1 when initStatic() is called.
*/
UCBHELPER_DLLPRIVATE virtual void initDynamic() = 0;
public:
/**
* Constructor.
*
* @param rxContext is a Service Manager.
* @param rCommand is the parameter for the open command that produces
* this resultset.
*/
ResultSetImplHelper(
const css::uno::Reference<
css::uno::XComponentContext >& rxContext,
const css::ucb::OpenCommandArgument2& rCommand );
/**
* Destructor.
*/
virtual ~ResultSetImplHelper() override;
// XInterface
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
virtual void SAL_CALL acquire()
throw() override;
virtual void SAL_CALL release()
throw() override;
// XTypeProvider
virtual css::uno::Sequence< sal_Int8 > SAL_CALL
getImplementationId() override;
virtual css::uno::Sequence< css::uno::Type > SAL_CALL
getTypes() override;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
// XComponent ( base class of XDynamicResultSet )
virtual void SAL_CALL
dispose() override;
virtual void SAL_CALL
addEventListener( const css::uno::Reference< css::lang::XEventListener >& Listener ) override;
virtual void SAL_CALL
removeEventListener( const css::uno::Reference< css::lang::XEventListener >& Listener ) override;
// XDynamicResultSet
virtual css::uno::Reference< css::sdbc::XResultSet > SAL_CALL
getStaticResultSet() override;
virtual void SAL_CALL
setListener( const css::uno::Reference< css::ucb::XDynamicResultSetListener >& Listener ) override;
virtual void SAL_CALL
connectToCache( const css::uno::Reference< css::ucb::XDynamicResultSet > & xCache ) override;
/**
* The implementation of this method always returns 0. Override this
* method, if necessary.
*/
virtual sal_Int16 SAL_CALL
getCapabilities() override;
};
}
#endif /* ! INCLUDED_UCBHELPER_RESULTSETHELPER_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
