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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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 _UCBHELPER_RESULTSET_HXX
#define _UCBHELPER_RESULTSET_HXX
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/ucb/ResultSetException.hpp>
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#include <com/sun/star/ucb/XContentAccess.hpp>
#include <com/sun/star/sdbc/XResultSet.hpp>
#include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
#include <com/sun/star/sdbc/XRow.hpp>
#include <com/sun/star/sdbc/XCloseable.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include "rtl/ref.hxx"
#include "salhelper/simplereferenceobject.hxx"
#include <cppuhelper/weak.hxx>
#include <ucbhelper/macros.hxx>
#include "ucbhelper/ucbhelperdllapi.h"
namespace ucbhelper {
//=========================================================================
#define RESULTSET_SERVICE_NAME "com.sun.star.ucb.ContentResultSet"
//=========================================================================
class ResultSetDataSupplier;
struct ResultSet_Impl;
/**
* This is an implementation of the service com.sun.star.ucb.ContentResultSet.
* It can be used to implement the method XDynamicResultSet::getStaticResultSet,
* which needs to be implemented for instance to implement the command "open"
* at folder objects. This class uses a user supplied ResultSetDataSupplier
* object to request data on demand.
*
* @see ResultSetDataSupplier
*/
class UCBHELPER_DLLPUBLIC ResultSet :
public cppu::OWeakObject,
public com::sun::star::lang::XTypeProvider,
public com::sun::star::lang::XServiceInfo,
public com::sun::star::lang::XComponent,
public com::sun::star::ucb::XContentAccess,
public com::sun::star::sdbc::XResultSet,
public com::sun::star::sdbc::XResultSetMetaDataSupplier,
public com::sun::star::sdbc::XRow,
public com::sun::star::sdbc::XCloseable,
public com::sun::star::beans::XPropertySet
{
ResultSet_Impl* m_pImpl;
public:
/**
* Construction.
*
* @param rxSMgr is a Service Manager.
* @param rProperties is a sequence of properties for that the resultset
* shall be able to obtain the values.
* @param rDataSupplier is a supplier for the resultset data.
*/
ResultSet(
const com::sun::star::uno::Reference<
com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
const com::sun::star::uno::Sequence<
com::sun::star::beans::Property >& rProperties,
const rtl::Reference< ResultSetDataSupplier >& rDataSupplier );
/**
* Construction.
*
* @param rxSMgr is a Service Manager.
* @param rProperties is a sequence of properties for that the resultset
* shall be able to obtain the values.
* @param rDataSupplier is a supplier for the resultset data.
* @param rxEnv is the environment for interactions, progress propagation,
* ...
*/
ResultSet(
const com::sun::star::uno::Reference<
com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
const com::sun::star::uno::Sequence<
com::sun::star::beans::Property >& rProperties,
const rtl::Reference< ResultSetDataSupplier >& rDataSupplier,
const com::sun::star::uno::Reference<
com::sun::star::ucb::XCommandEnvironment >& rxEnv );
virtual ~ResultSet();
// XInterface
XINTERFACE_DECL()
// XTypeProvider
XTYPEPROVIDER_DECL()
// XServiceInfo
XSERVICEINFO_NOFACTORY_DECL()
// XComponent
virtual void SAL_CALL
dispose()
throw( com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
addEventListener( const com::sun::star::uno::Reference<
com::sun::star::lang::XEventListener >& Listener )
throw( com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
removeEventListener( const com::sun::star::uno::Reference<
com::sun::star::lang::XEventListener >& Listener )
throw( com::sun::star::uno::RuntimeException );
// XContentAccess
virtual rtl::OUString SAL_CALL
queryContentIdentifierString()
throw( com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::ucb::XContentIdentifier > SAL_CALL
queryContentIdentifier()
throw( com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::ucb::XContent > SAL_CALL
queryContent()
throw( com::sun::star::uno::RuntimeException );
// XResultSetMetaDataSupplier
virtual com::sun::star::uno::Reference<
com::sun::star::sdbc::XResultSetMetaData > SAL_CALL
getMetaData()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
// XResultSet
virtual sal_Bool SAL_CALL
next()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
isBeforeFirst()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
isAfterLast()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
isFirst()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
isLast()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
beforeFirst()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
afterLast()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
first()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
last()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Int32 SAL_CALL
getRow()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
absolute( sal_Int32 row )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
relative( sal_Int32 rows )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
previous()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
refreshRow()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
rowUpdated()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
rowInserted()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
rowDeleted()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::uno::XInterface > SAL_CALL
getStatement()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
// XRow
virtual sal_Bool SAL_CALL
wasNull()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual rtl::OUString SAL_CALL
getString( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL
getBoolean( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Int8 SAL_CALL
getByte( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Int16 SAL_CALL
getShort( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Int32 SAL_CALL
getInt( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual sal_Int64 SAL_CALL
getLong( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual float SAL_CALL
getFloat( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual double SAL_CALL
getDouble( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL
getBytes( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::util::Date SAL_CALL
getDate( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::util::Time SAL_CALL
getTime( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::util::DateTime SAL_CALL
getTimestamp( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::io::XInputStream > SAL_CALL
getBinaryStream( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::io::XInputStream > SAL_CALL
getCharacterStream( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Any SAL_CALL
getObject( sal_Int32 columnIndex,
const com::sun::star::uno::Reference<
com::sun::star::container::XNameAccess >& typeMap )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::sdbc::XRef > SAL_CALL
getRef( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::sdbc::XBlob > SAL_CALL
getBlob( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::sdbc::XClob > SAL_CALL
getClob( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Reference<
com::sun::star::sdbc::XArray > SAL_CALL
getArray( sal_Int32 columnIndex )
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
// XCloseable
virtual void SAL_CALL
close()
throw( com::sun::star::sdbc::SQLException,
com::sun::star::uno::RuntimeException );
// XPropertySet
virtual com::sun::star::uno::Reference<
com::sun::star::beans::XPropertySetInfo > SAL_CALL
getPropertySetInfo()
throw( com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
setPropertyValue( const rtl::OUString& aPropertyName,
const com::sun::star::uno::Any& aValue )
throw( com::sun::star::beans::UnknownPropertyException,
com::sun::star::beans::PropertyVetoException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
virtual com::sun::star::uno::Any SAL_CALL
getPropertyValue( const rtl::OUString& PropertyName )
throw( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
addPropertyChangeListener( const rtl::OUString& aPropertyName,
const com::sun::star::uno::Reference<
com::sun::star::beans::XPropertyChangeListener >& xListener )
throw( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
removePropertyChangeListener( const rtl::OUString& aPropertyName,
const com::sun::star::uno::Reference<
com::sun::star::beans::XPropertyChangeListener >& aListener )
throw( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
addVetoableChangeListener( const rtl::OUString& PropertyName,
const com::sun::star::uno::Reference<
com::sun::star::beans::XVetoableChangeListener >& aListener )
throw( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
virtual void SAL_CALL
removeVetoableChangeListener( const rtl::OUString& PropertyName,
const com::sun::star::uno::Reference<
com::sun::star::beans::XVetoableChangeListener >& aListener )
throw( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException );
/////////////////////////////////////////////////////////////////////
// Non-interface methods.
/////////////////////////////////////////////////////////////////////
/**
* This method propagates property value changes to all registered
* listeners.
*
* @param rEvt is a property change event.
*/
void propertyChanged(
const com::sun::star::beans::PropertyChangeEvent& rEvt );
/**
* This method should be called by the data supplier for the result set
* to indicate that there were new data obtained from the data source.
*
* @param nOld is the old count of rows; must be non-negative.
* @param nnew is the new count of rows; must be non-negative.
*/
void rowCountChanged( sal_uInt32 nOld, sal_uInt32 nNew );
/**
* This method should be called by the data supplier for the result set
* to indicate that there were all rows obtained from the data source.
*/
void rowCountFinal();
/**
* This method returns a sequence containing all properties ( not the
* values! ) of the result set.
*
* @return a sequence of properties.
*/
const com::sun::star::uno::Sequence< com::sun::star::beans::Property >&
getProperties();
/**
* This method returns the environment to use for interactions, progress
* propagation, ... It can by empty.
*
* @return an environment or an empty reference.
*/
const com::sun::star::uno::Reference<
com::sun::star::ucb::XCommandEnvironment >&
getEnvironment();
};
//=========================================================================
/**
* This is the base class for an object that supplies data to a result set
*
* @see ResultSet
*/
class ResultSetDataSupplier : public salhelper::SimpleReferenceObject
{
friend class ResultSet;
// No ref, otherwise we get a cyclic reference between supplier and set!
// Will be set from ResultSet ctor.
ResultSet* m_pResultSet;
public:
ResultSetDataSupplier() : m_pResultSet( 0 ) {}
/**
* This method returns the resultset this supplier belongs to.
*
* @return the resultset for that the supplier supplies data.
*/
rtl::Reference< ResultSet > getResultSet() const { return m_pResultSet; }
/**
* This method returns the identifier string of the content at the
* specified index.
*
* @param nIndex is the zero-based index within the logical data array
* of the supplier; must be non-negative.
* @return the content's identifier string.
*/
virtual rtl::OUString queryContentIdentifierString( sal_uInt32 nIndex ) = 0;
/**
* This method returns the identifier of the content at the specified index.
*
* @param nIndex is the zero-based index within the logical data array
* of the supplier; must be non-negative.
* @return the content's identifier.
*/
virtual com::sun::star::uno::Reference<
com::sun::star::ucb::XContentIdentifier >
queryContentIdentifier( sal_uInt32 nIndex ) = 0;
/**
* This method returns the the content at the specified index.
*
* @param nIndex is the zero-based index within the logical data array
* of the supplier; must be non-negative.
* @return the content.
*/
virtual com::sun::star::uno::Reference< com::sun::star::ucb::XContent >
queryContent( sal_uInt32 nIndex ) = 0;
/**
* This method returns whether there is a content at the specified index.
*
* @param nIndex is the zero-based index within the logical data array
* of the supplier; must be non-negative.
* @return true, if there is a content at the given index.
*/
virtual sal_Bool getResult( sal_uInt32 nIndex ) = 0;
/**
* This method returns the total count of objects in the logical data array
* of the supplier. The implementation of this method may be very
* "expensive", because it can be necessary to obtain all data in order
* to determine the count. Therefor the ResultSet implementation calls
* it very seldom.
*
* @return the total count of objects; will always be non-negative.
*/
virtual sal_uInt32 totalCount() = 0;
/**
* This method returns the count of objects obtained so far. There is no
* for the implemetation to obtain all objects at once. It can obtain
* all data on demand.
*
* The implementation should call m_pResultSet->rowCountChanged(...)
* everytime it has inserted a new entry in its logical result array.
*
* @return the count of objects obtained so far; will always be
* non-negative.
*/
virtual sal_uInt32 currentCount() = 0;
/**
* This method returns whether the value returned by currentCount() is
* "final". This is the case, if that there was all data obtained by the
* supplier and the current count won't increase any more.
*
* The implementation should call m_pResultSet->rowCountFinal(...) if
* it has inserted all entries in its logical result array.
*
* @return true, if the the value returned by currentCount() won't change
anymore.
*/
virtual sal_Bool isCountFinal() = 0;
/**
* This method returns an object for accessing the property values at
* the specified index. The implementation may use the helper class
* ucb::PropertyValueSet to provide the return value.
*
* @param nIndex is the zero-based index within the logical data array
* of the supplier.
* @return the object for accessing the property values.
*/
virtual com::sun::star::uno::Reference< com::sun::star::sdbc::XRow >
queryPropertyValues( sal_uInt32 nIndex ) = 0;
/**
* This method is called to instruct the supplier to release the (possibly
* presnt) property values at the given index.
*
* @param nIndex is the zero-based index within the logical data array
* of the supplier.
*/
virtual void releasePropertyValues( sal_uInt32 nIndex ) = 0;
/**
* This method will be called by the resultset implementation in order
* to instruct the data supplier to release all resources it has
* allocated so far. In case the supplier is collecting data
* asynchronously, that process must be stopped.
*/
virtual void close() = 0;
/**
* This method will be called by the resultset implementation in order
* check, whether an error has occured while collecting data. The
* implementation of this method must throw an exception in that case.
*
* Note: An exception thrown to indicate an error must always be thrown
* by the thread that created the data supplier. If the supplier collects
* data asynchronously ( i.e. in a separate thread ) and an error
* occures, throwing of the appropriate exception must be deferred
* until validate() is called by the ResultSet implementation from
* inside the main thread.
* In case data are obtained synchronously, the ResultSetException can
* be thrown directly.
*
* @exception ResultSetException thrown, if an error has occured
*/
virtual void validate()
throw( com::sun::star::ucb::ResultSetException ) = 0;
};
}
#endif /* !_UCBHELPER_RESULTSET_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
