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
|
/* -*- 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_RESULTSETMETADATA_HXX
#define INCLUDED_UCBHELPER_RESULTSETMETADATA_HXX
#include <vector>
#include <memory>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/sdbc/XResultSetMetaData.hpp>
#include <cppuhelper/weak.hxx>
#include <ucbhelper/ucbhelperdllapi.h>
namespace com { namespace sun { namespace star {
namespace beans { struct Property; }
namespace uno { class XComponentContext; }
} } }
namespace ucbhelper_impl {
struct ResultSetMetaData_Impl;
}
namespace ucbhelper
{
/**
* This is a structure that holds additional meta data for one column
* of a resultset. The default values set in the constructor should be a
* good guess for many UCB use cases.
*/
struct ResultSetColumnData
{
/** @see ResultSetMetaData::isCaseSensitive */
bool isCaseSensitive;
inline ResultSetColumnData();
};
// Note: Never change the initial values! Implementations using this struct
// may heavily depend on the behaviour of the default constructor.
ResultSetColumnData::ResultSetColumnData()
: isCaseSensitive( true )
{
}
/**
* This is an implementation of the interface XResultSetMetaData. It can be
* used to implement the interface
* css::sdbc::XResultSetMetaDataSupplier, which is required for
* implementations of service com.sun.star.ucb.ContentResultSet.
*/
class UCBHELPER_DLLPUBLIC ResultSetMetaData final :
public ::cppu::OWeakObject,
public css::lang::XTypeProvider,
public css::sdbc::XResultSetMetaData
{
std::unique_ptr<ucbhelper_impl::ResultSetMetaData_Impl> m_pImpl;
css::uno::Reference< css::uno::XComponentContext > m_xContext;
css::uno::Sequence< css::beans::Property > m_aProps;
public:
/**
* Constructor. ResultSet is readonly by default.
*
* @param rxSMgr is a Servive Manager.
* @param rProps is a sequence of properties (partially) describing the
* columns of a resultset.
*/
ResultSetMetaData(
const css::uno::Reference< css::uno::XComponentContext >& rxContext,
const css::uno::Sequence< css::beans::Property >& rProps );
/**
* Constructor.
*
* @param rxSMgr is a Servive Manager.
* @param rProps is a sequence of properties (partially) describing the
* columns of a resultset.
* @param rColumnData contains additional meta data for the columns of
* a resultset, which override the default values returned by the
* appropriate methods of this class. The length of rColumnData
* must be the same as length of rProps.
* rColumnData[ 0 ] corresponds to data in rProps[ 0 ],
* rColumnData[ 1 ] corresponds to data in rProps[ 1 ], ...
*/
ResultSetMetaData(
const css::uno::Reference< css::uno::XComponentContext >& rxContext,
const css::uno::Sequence< css::beans::Property >& rProps,
const std::vector< ResultSetColumnData >& rColumnData );
/**
* Destructor.
*/
virtual ~ResultSetMetaData() 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;
// XResultSetMetaData
/**
* Returns the number of columns of the resultset.
*
* @return the length of the property sequence.
*/
virtual sal_Int32 SAL_CALL
getColumnCount() override;
/**
* Checks whether column is automatically numbered, which makes it
* read-only.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if column is automatically numbered.
*/
virtual sal_Bool SAL_CALL
isAutoIncrement( sal_Int32 column ) override;
/**
* Checks whether column is case sensitive.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if column is case sensitive.
*/
virtual sal_Bool SAL_CALL
isCaseSensitive( sal_Int32 column ) override;
/**
* Checks whether the value stored in column can be used in a
* WHERE clause.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if the column is searchable.
*/
virtual sal_Bool SAL_CALL
isSearchable( sal_Int32 column ) override;
/**
* Checks whether column is a cash value.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if the column is a cash value.
*/
virtual sal_Bool SAL_CALL
isCurrency( sal_Int32 column ) override;
/**
* Checks whether a NULL can be stored in column.
*
* @see css::sdbc::ColumnValue
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return css::sdbc::ColumnValue::NULLABLE, if a NULL
* can be stored in the column.
*/
virtual sal_Int32 SAL_CALL
isNullable( sal_Int32 column ) override;
/**
* Checks whether the value stored in column is a signed number.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if the value stored in column is a signed number.
*/
virtual sal_Bool SAL_CALL
isSigned( sal_Int32 column ) override;
/**
* Gets the normal maximum width in characters for column.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the normal maximum width in characters for column.
*/
virtual sal_Int32 SAL_CALL
getColumnDisplaySize( sal_Int32 column ) override;
/**
* Gets the suggested column title for column, to be used in print-
* outs and displays.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the column label.
*/
virtual OUString SAL_CALL
getColumnLabel( sal_Int32 column ) override;
/**
* Gets the name of column.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the name of the property that corresponds to column.
*/
virtual OUString SAL_CALL
getColumnName( sal_Int32 column ) override;
/**
* Gets the schema name for the table from which column of this
* result set was derived.
* Because this feature is not widely supported, the return value
* for many DBMSs will be an empty string.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the schema name of column or an empty string.
*/
virtual OUString SAL_CALL
getSchemaName( sal_Int32 column ) override;
/**
* For number types, getprecision gets the number of decimal digits
* in column.
* For character types, it gets the maximum length in characters for
* column.
* For binary types, it gets the maximum length in bytes for column.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the precision for the column.
*/
virtual sal_Int32 SAL_CALL
getPrecision( sal_Int32 column ) override;
/**
* Gets the number of digits to the right of the decimal point for
* values in column.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the scale of the column.
*/
virtual sal_Int32 SAL_CALL
getScale( sal_Int32 column ) override;
/**
* Gets the name of the table from which column of this result set
* was derived or "" if there is none (for example, for a join).
* Because this feature is not widely supported, the return value
* for many DBMSs will be an empty string.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the table name for column or an empty string.
*/
virtual OUString SAL_CALL
getTableName( sal_Int32 column ) override;
virtual OUString SAL_CALL
/**
* Gets the catalog name for the table from which column of this
* result set was derived.
* Because this feature is not widely supported, the return value
* for many DBMSs will be an empty string.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the catalog name for column or an empty string.
*/
getCatalogName( sal_Int32 column ) override;
/**
* Gets the JDBC type for the value stored in column. ... The STRUCT
* and DISTINCT type codes are always returned for structured and
* distinct types, regardless of whether the value will be mapped
* according to the standard mapping or be a custom mapping.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the type of the property that corresponds to column - mapped
* from UNO-Type to SQL-Type.
*/
virtual sal_Int32 SAL_CALL
getColumnType( sal_Int32 column ) override;
/**
* Gets the type name used by this particular data source for the
* values stored in column. If the type code for the type of value
* stored in column is STRUCT, DISTINCT or JAVA_OBJECT, this method
* returns a fully-qualified SQL type name.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the column type name.
*/
virtual OUString SAL_CALL
getColumnTypeName( sal_Int32 column ) override;
/**
* Indicates whether a column is definitely not writable.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if the column is definetely not writable.
*/
virtual sal_Bool SAL_CALL
isReadOnly( sal_Int32 column ) override;
/**
* Indicates whether it is possible for a write on the column to succeed.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if it is possible for a write to succeed.
*/
virtual sal_Bool SAL_CALL
isWritable( sal_Int32 column ) override;
/**
* Indicates whether a write on the column will definitely succeed.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return true, if a write on the column will definetely succeed.
*/
virtual sal_Bool SAL_CALL
isDefinitelyWritable( sal_Int32 column ) override;
/**
* Returns the fully-qualified name of the service whose instances
* are manufactured if the method
* css::sdbc::ResultSet::getObject is called to retrieve a
* value from the column.
*
* @param column is the number of the column for that a value shall
* be returned. The first column is 1, the second is 2, ...
* @return the service name for column or an empty string, if no service
* is applicable.
*/
virtual OUString SAL_CALL
getColumnServiceName( sal_Int32 column ) override;
};
} // namespace ucbhelper
#endif /* ! INCLUDED_UCBHELPER_RESULTSETMETADATA_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|