Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #ifndef CONNECTIVITY_VIRTUAL_DBTOOLS_HXX
21 : #define CONNECTIVITY_VIRTUAL_DBTOOLS_HXX
22 :
23 : #include <rtl/ref.hxx>
24 : #include <rtl/ustring.hxx>
25 : #include <com/sun/star/uno/Reference.hxx>
26 : #include <com/sun/star/util/Date.hpp>
27 : #include <com/sun/star/sdbc/SQLException.hpp>
28 : #include <com/sun/star/uno/Sequence.hxx>
29 :
30 : #include <vector>
31 : #include <memory>
32 : #include "connectivity/dbtoolsdllapi.hxx"
33 :
34 : //========================================================================
35 : //= forward declarations
36 : //========================================================================
37 : namespace com {
38 : namespace sun {
39 : namespace star {
40 : namespace util {
41 : class XNumberFormatter;
42 : class XNumberFormatTypes;
43 : class XNumberFormatsSupplier;
44 : }
45 : namespace beans {
46 : class XPropertySet;
47 : }
48 : namespace lang {
49 : class XMultiServiceFactory;
50 : class XComponent;
51 : class WrappedTargetException;
52 : struct Locale;
53 : }
54 : namespace sdbc {
55 : class XDatabaseMetaData;
56 : class XConnection;
57 : class XRowSet;
58 : class XDataSource;
59 : }
60 : namespace sdb {
61 : class XColumn;
62 : class SQLContext;
63 : }
64 : namespace uno {
65 : class XComponentContext;
66 : }
67 : namespace container {
68 : class XNameAccess;
69 : }
70 : }
71 : }
72 : }
73 :
74 : namespace dbtools {
75 : class SQLExceptionInfo;
76 : class FormattedColumnValue;
77 : }
78 :
79 : namespace comphelper {
80 : class ComponentContext;
81 : }
82 :
83 : //========================================================================
84 : //= entry into this library
85 : //========================================================================
86 : /** this is the entry point for the load-on-call usage of the DBTOOLS
87 : library.
88 : <p>When you need one of the simple objects in this library, load the lib
89 : and call this method. The returned pointer is a pointer to an IDataAccessToolsFactory
90 : instance, which is acquired <em>once</em>.</p>
91 : @return
92 : a pointer to an object implementing the IDataAccessToolsFactory interface,
93 : aquired exactly <em>once</em>.
94 : */
95 : extern "C" OOO_DLLPUBLIC_DBTOOLS void* SAL_CALL createDataAccessToolsFactory();
96 :
97 : //========================================================================
98 : //=
99 : //========================================================================
100 : //........................................................................
101 : namespace connectivity
102 : {
103 : //........................................................................
104 :
105 : class IParseContext;
106 : //....................................................................
107 : namespace simple
108 : {
109 : //....................................................................
110 :
111 : typedef void* (SAL_CALL * createDataAccessToolsFactoryFunction)( );
112 :
113 : //================================================================
114 : //= IDataAccessTools
115 : //================================================================
116 3 : class OOO_DLLPUBLIC_DBTOOLS IDataAccessTools : public ::rtl::IReference
117 : {
118 : public:
119 : virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> getConnection_withFeedback(
120 : const ::rtl::OUString& _rDataSourceName,
121 : const ::rtl::OUString& _rUser,
122 : const ::rtl::OUString& _rPwd,
123 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext
124 : ) const SAL_THROW ( (::com::sun::star::sdbc::SQLException) ) = 0;
125 :
126 : virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> connectRowset(
127 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet>& _rxRowSet,
128 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext,
129 : sal_Bool _bSetAsActiveConnection
130 : ) const SAL_THROW ( ( ::com::sun::star::sdbc::SQLException
131 : , ::com::sun::star::lang::WrappedTargetException
132 : , ::com::sun::star::uno::RuntimeException ) ) = 0;
133 :
134 : virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> getRowSetConnection(
135 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet>& _rxRowSet)
136 : const SAL_THROW ( (::com::sun::star::uno::RuntimeException) ) = 0;
137 :
138 : virtual ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier> getNumberFormats(
139 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rxConn,
140 : sal_Bool _bAllowDefault
141 : ) const = 0;
142 :
143 : virtual sal_Int32 getDefaultNumberFormat(
144 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxColumn,
145 : const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatTypes >& _rxTypes,
146 : const ::com::sun::star::lang::Locale& _rLocale
147 : ) const = 0;
148 :
149 : virtual void TransferFormComponentProperties(
150 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxOld,
151 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxNew,
152 : const ::com::sun::star::lang::Locale& _rLocale
153 : ) const = 0;
154 :
155 : virtual ::rtl::OUString quoteName(
156 : const ::rtl::OUString& _rQuote,
157 : const ::rtl::OUString& _rName
158 : ) const = 0;
159 :
160 : virtual ::rtl::OUString composeTableNameForSelect(
161 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
162 : const ::rtl::OUString& _rCatalog,
163 : const ::rtl::OUString& _rSchema,
164 : const ::rtl::OUString& _rName
165 : ) const = 0;
166 :
167 : virtual ::rtl::OUString composeTableNameForSelect(
168 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
169 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xTable
170 : ) const = 0;
171 :
172 : virtual ::com::sun::star::sdb::SQLContext prependContextInfo(
173 : ::com::sun::star::sdbc::SQLException& _rException,
174 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxContext,
175 : const ::rtl::OUString& _rContextDescription,
176 : const ::rtl::OUString& _rContextDetails
177 : ) const = 0;
178 :
179 : virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource > getDataSource(
180 : const ::rtl::OUString& _rsRegisteredName,
181 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext
182 : ) const = 0;
183 :
184 : virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >
185 : getFieldsByCommandDescriptor(
186 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
187 : const sal_Int32 _nCommandType,
188 : const ::rtl::OUString& _rCommand,
189 : ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >& _rxKeepFieldsAlive,
190 : ::dbtools::SQLExceptionInfo* _pErrorInfo = NULL
191 : ) SAL_THROW( ( ) ) = 0;
192 :
193 : virtual ::com::sun::star::uno::Sequence< ::rtl::OUString >
194 : getFieldNamesByCommandDescriptor(
195 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
196 : const sal_Int32 _nCommandType,
197 : const ::rtl::OUString& _rCommand,
198 : ::dbtools::SQLExceptionInfo* _pErrorInfo = NULL
199 : ) SAL_THROW( ( ) ) = 0;
200 :
201 : /** check if the property "Privileges" supports ::com::sun::star::sdbcx::Privilege::INSERT
202 : @param _rxCursorSet the property set
203 : */
204 : virtual sal_Bool canInsert(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxCursorSet) const = 0;
205 :
206 : /** check if the property "Privileges" supports ::com::sun::star::sdbcx::Privilege::UPDATE
207 : @param _rxCursorSet the property set
208 : */
209 : virtual sal_Bool canUpdate(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxCursorSet) const = 0;
210 :
211 : /** check if the property "Privileges" supports ::com::sun::star::sdbcx::Privilege::DELETE
212 : @param _rxCursorSet the property set
213 : */
214 : virtual sal_Bool canDelete(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxCursorSet) const = 0;
215 :
216 : /** determines whether the given component is part of a document which is an embedded database
217 : document (such as a form)
218 : */
219 : virtual bool isEmbeddedInDatabase(
220 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxComponent,
221 : ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxActualConnection
222 : ) = 0;
223 :
224 : protected:
225 3 : ~IDataAccessTools() {}
226 : };
227 :
228 : //================================================================
229 : //= IDataAccessCharSet
230 : //================================================================
231 : /** simple wrapper for the <type>OCharsetMap</type>
232 : */
233 0 : class OOO_DLLPUBLIC_DBTOOLS IDataAccessCharSet :
234 : public ::rtl::IReference
235 : {
236 : // to be extended if necessary ....
237 : public:
238 : /** enumerates all supported char sets
239 : @return the number of charsets supported
240 : */
241 : virtual sal_Int32 getSupportedTextEncodings(
242 : ::std::vector< rtl_TextEncoding >& /* [out] */ _rEncs
243 : ) const = 0;
244 :
245 : protected:
246 0 : ~IDataAccessCharSet() {}
247 : };
248 :
249 : //================================================================
250 : //= IDataAccessTypeConversion
251 : //================================================================
252 3 : class OOO_DLLPUBLIC_DBTOOLS IDataAccessTypeConversion :
253 : public ::rtl::IReference
254 : {
255 : public:
256 : virtual ::com::sun::star::util::Date getStandardDate() const = 0;
257 :
258 : virtual double getValue(
259 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn>& _rxVariant,
260 : const ::com::sun::star::util::Date& rNullDate ) const = 0;
261 :
262 : virtual ::rtl::OUString getFormattedValue(
263 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn >& _rxColumn,
264 : const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter,
265 : const ::com::sun::star::util::Date& _rNullDate,
266 : sal_Int32 _nKey,
267 : sal_Int16 _nKeyType) const = 0;
268 :
269 : virtual ::rtl::OUString getFormattedValue(
270 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxColumn,
271 : const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter>& _rxFormatter,
272 : const ::com::sun::star::lang::Locale& _rLocale,
273 : const ::com::sun::star::util::Date& _rNullDate
274 : ) const = 0;
275 :
276 : protected:
277 3 : ~IDataAccessTypeConversion() {}
278 : };
279 :
280 : //================================================================
281 : //= ISQLParseNode
282 : //================================================================
283 : /** a simple version of the OSQLParseNode, with all methods beeing virtual
284 : */
285 0 : class OOO_DLLPUBLIC_DBTOOLS ISQLParseNode : public ::rtl::IReference
286 : {
287 : public:
288 : virtual void parseNodeToStr(::rtl::OUString& _rString,
289 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
290 : const IParseContext* _pContext
291 : ) const = 0;
292 :
293 : virtual void parseNodeToPredicateStr(::rtl::OUString& _rString,
294 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
295 : const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter,
296 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxField,
297 : const ::com::sun::star::lang::Locale& _rIntl,
298 : const sal_Char _cDecSeparator,
299 : const IParseContext* _pContext
300 : ) const = 0;
301 :
302 : protected:
303 0 : ~ISQLParseNode() {}
304 : };
305 :
306 : //================================================================
307 : //= ISQLParser
308 : //================================================================
309 : /** a simple version of the OSQLParser, with all methods beeing virtual
310 : */
311 0 : class OOO_DLLPUBLIC_DBTOOLS ISQLParser : public ::rtl::IReference
312 : {
313 : public:
314 : virtual ::rtl::Reference< ISQLParseNode > predicateTree(
315 : ::rtl::OUString& rErrorMessage,
316 : const ::rtl::OUString& rStatement,
317 : const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter,
318 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxField
319 : ) const = 0;
320 :
321 : virtual const IParseContext& getContext() const = 0;
322 :
323 : protected:
324 0 : ~ISQLParser() {}
325 : };
326 :
327 : //================================================================
328 : //= IDataAccessToolsFactory
329 : //================================================================
330 : /** the main factory for runtime-loadable tools in the DBTOOLS library
331 : */
332 3 : class OOO_DLLPUBLIC_DBTOOLS IDataAccessToolsFactory :
333 : public ::rtl::IReference
334 : {
335 : public:
336 : /// creates a simple version of the class OSQLParser
337 : virtual ::rtl::Reference< ISQLParser > createSQLParser(
338 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
339 : const IParseContext* _pContext
340 : ) const = 0;
341 :
342 : /// creates a helper for charset related functionality (<type>OCharsetMap</type>)
343 : virtual ::rtl::Reference< IDataAccessCharSet > createCharsetHelper( ) const = 0;
344 :
345 : /// creates a simple version of the DBTypeConversion helper
346 : virtual ::rtl::Reference< IDataAccessTypeConversion > getTypeConversionHelper() = 0;
347 :
348 : /// creates a helper which can be used to access the static methods in dbtools.hxx
349 : virtual ::rtl::Reference< IDataAccessTools > getDataAccessTools() = 0;
350 :
351 : virtual ::std::auto_ptr< ::dbtools::FormattedColumnValue > createFormattedColumnValue(
352 : const ::comphelper::ComponentContext& _rContext,
353 : const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet >& _rxRowSet,
354 : const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxColumn
355 : ) = 0;
356 :
357 : protected:
358 3 : ~IDataAccessToolsFactory() {}
359 : };
360 :
361 : //....................................................................
362 : } // namespace simple
363 : //....................................................................
364 :
365 : //........................................................................
366 : } // namespace connectivity
367 : //........................................................................
368 :
369 : #endif // CONNECTIVITY_VIRTUAL_DBTOOLS_HXX
370 :
371 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
