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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
/*************************************************************************
*
* $RCSfile: mergeddataprovider.hxx,v $
*
* $Revision: 1.4 $
*
* last change: $Author: hr $ $Date: 2003-03-19 16:18:59 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CONFIGMGR_BACKEND_MERGEDDATAPROVIDER_HXX
#define CONFIGMGR_BACKEND_MERGEDDATAPROVIDER_HXX
#ifndef CONFIGMGR_BACKEND_REQUEST_HXX_
#include "request.hxx"
#endif
#ifndef CONFIGMGR_BACKEND_REQUESTTYPES_HXX_
#include "requesttypes.hxx"
#endif
#ifndef CONFIGMGR_UTILITY_HXX_
#include "utility.hxx"
#endif
namespace configmgr
{
// ---------------------------------------------------------------------------
namespace backend
{
// ---------------------------------------------------------------------------
/** Listener interface for receiving notifications
about changes to previously requested data
*/
struct SAL_NO_VTABLE INodeDataListener : Refcounted
{
/** is called to indicate changes within the data being observed.
@param _aOriginalRequest
identifies the data that changed
*/
virtual void dataChanged(NodeRequest const & _aOriginalRequest) CFG_NOTHROW() = 0;
};
// ---------------------------------------------------------------------------
/// Interface providing access to (merged) data for whole components
struct SAL_NO_VTABLE IComponentDataProvider
{
/** loads merged data for a (complete) tree and returns it as return value.
@param _aRequest
identifies the component to be loaded
@returns
A valid component instance for the given component.
@throws com::sun::star::uno::Exception
if the node cannot be retrieved.
The exact exception being thrown may depend on the underlying backend.
*/
virtual ComponentResult getComponentData(ComponentRequest const & _aRequest)
CFG_UNO_THROW_ALL() = 0;
};
// ---------------------------------------------------------------------------
/// Interface providing access to template (schema) data
struct SAL_NO_VTABLE ITemplateDataProvider
{
/** loads a given template and returns it as return value
@param _aRequest
identifies the template to be loaded
@returns
A valid instance of the given template.
<p> Currently a request with empty template name
will retrieve a group node holding all templates
of a component.
</p>
@throws com::sun::star::uno::Exception
if the template cannot be retrieved.
The exact exception being thrown may depend on the underlying backend.
*/
virtual TemplateResult getTemplateData(TemplateRequest const & _aRequest)
CFG_UNO_THROW_ALL() = 0;
};
// ---------------------------------------------------------------------------
/** Interface providing access to (merged) data for individual nodes
with optional notification about subsequent changes.
There is no guarantee, that all changes are notified immediately
(or even at all).If the provider cannot detect changes
it may simply ignore a supplied listener.
*/
struct SAL_NO_VTABLE INodeDataProvider
{
/** loads merged data for a (partial) tree and returns it as return value.
@param _aRequest
identifies the component to be loaded
@param _pListener
a listener to observe subsequent changes to the data requested
<p> If NULL, no notifications will be sent. </p>
<p> Otherwise the listener will be notified of changes.
The listener must subsequently be removed by calling
<member>INodeDataProvider::removeRequestListener</member>.
The listener must live at least until it is removed.
</p>
@returns
A valid component instance for the given request.
@throws com::sun::star::uno::Exception
if the node cannot be retrieved.
The exact exception being thrown may depend on the underlying backend.
*/
virtual ComponentResult getNodeData(ComponentRequest const & _aRequest,
ITemplateDataProvider* _aTemplateProvider,
INodeDataListener * _pListener = NULL)
CFG_UNO_THROW_ALL() = 0;
/** remove a listener registered for a previous request.
<p>This may also release some open resources for the request.</p>
@param _pListener
a listener that was passed to a previous succes
*/
virtual void removeRequestListener(INodeDataListener * _pListener) CFG_NOTHROW() = 0;
};
// ---------------------------------------------------------------------------
/// Interface providing the capability to update node data
struct SAL_NO_VTABLE INodeUpdateProvider
{
/** applies an update to the stored data.
@param _anUpdate
identifies the node to be updated and
describes the changes to be applied.
@throws com::sun::star::uno::Exception
if the node cannot be updated.
The exact exception being thrown may depend on the underlying backend.
*/
virtual void updateNodeData(UpdateRequest const & _anUpdate)
CFG_UNO_THROW_ALL() = 0;
};
// ---------------------------------------------------------------------------
/// Interface providing access to (merged) default data
struct SAL_NO_VTABLE IDefaultDataProvider
{
/** loads default data for a (partial) tree and returns it as return value
@param _aRequest
identifies the node to be loaded
@returns
A valid node instance for the default state of the given node.
<p>May be NULL, if the node exists but has no default equivalent.</p>
@throws com::sun::star::uno::Exception
if the default cannot be retrieved.
The exact exception being thrown may depend on the underlying backend.
*/
virtual NodeResult getDefaultData(NodeRequest const & _aRequest)
CFG_UNO_THROW_ALL() = 0;
};
// ---------------------------------------------------------------------------
/// Interface providing access to backend meta-data
struct SAL_NO_VTABLE IDataProviderMetaData
{
/** Queries whether default property values are stripped from
a merged result tree or whether they are returned inline.
@returns
<TRUE/> if default data is stripped from a merged node result, <BR/>
<FALSE/> if default data is left in the merged node result
*/
virtual bool isStrippingDefaults() CFG_NOTHROW() = 0;
};
// ---------------------------------------------------------------------------
/** Composite interface providing simple direct access to (merged) configuration data
from some data store.
<p> Only loading data is supported (no updates or notifications). </p>
*/
struct IDirectDataProvider
: Refcounted
, IComponentDataProvider
, IDefaultDataProvider
, ITemplateDataProvider
{
};
// ---------------------------------------------------------------------------
/** Composite interface providing full access to merged configuration data
from some data store.
<p> Loading and updating of data is supported.
Support for notification depends on the backend.
</p>
*/
struct IMergedDataProvider
: Refcounted
, INodeDataProvider
, INodeUpdateProvider
, IDefaultDataProvider
, ITemplateDataProvider
, IDataProviderMetaData
{
};
// ---------------------------------------------------------------------------
} // namespace backend
// ---------------------------------------------------------------------------
} // namespace configmgr
#endif
|
