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
|
/* -*- 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 _DBHELPER_DBEXCEPTION_HXX_
#define _DBHELPER_DBEXCEPTION_HXX_
#include <com/sun/star/sdbc/SQLException.hpp>
#include "connectivity/standardsqlstate.hxx"
#include "connectivity/dbtoolsdllapi.hxx"
namespace com
{
namespace sun
{
namespace star
{
namespace sdb
{
class SQLContext;
struct SQLErrorEvent;
}
namespace sdbc
{
class SQLWarning;
}
}
}
}
//.........................................................................
namespace dbtools
{
//.........................................................................
//==============================================================================
//= Special exception if cancel is pressed in DBA UI
//==============================================================================
enum OOoBaseErrorCode
{
ParameterInteractionCancelled = 1
};
//==============================================================================
//= SQLExceptionInfo - encapsulating the type info of an SQLException-derived class
//==============================================================================
class OOO_DLLPUBLIC_DBTOOLS SQLExceptionInfo
{
public:
enum TYPE { SQL_EXCEPTION, SQL_WARNING, SQL_CONTEXT, UNDEFINED };
private:
::com::sun::star::uno::Any m_aContent;
TYPE m_eType; // redundant (could be derived from m_aContent.getValueType())
public:
SQLExceptionInfo();
SQLExceptionInfo(const ::com::sun::star::sdbc::SQLException& _rError);
SQLExceptionInfo(const ::com::sun::star::sdbc::SQLWarning& _rError);
SQLExceptionInfo(const ::com::sun::star::sdb::SQLContext& _rError);
/** convenience constructor
If your error processing relies on SQLExceptions, and SQLExceptionInfos, you still may
need to display an error which consists of a simple message string only.
In those cases, you can use this constructor, which behaves as if you would have used
an SQLException containing exactly the given error message.
*/
SQLExceptionInfo( const ::rtl::OUString& _rSimpleErrorMessage );
SQLExceptionInfo(const SQLExceptionInfo& _rCopySource);
SQLExceptionInfo(const ::com::sun::star::sdb::SQLErrorEvent& _rError);
// use for events got via XSQLErrorListener::errorOccured
SQLExceptionInfo(const ::com::sun::star::uno::Any& _rError);
// use with the Reason member of an SQLErrorEvent or with NextElement of an SQLException
/** prepends a plain error message to the chain of exceptions
@param _rSimpleErrorMessage
the error message to prepend
@param _pAsciiSQLState
the SQLState of the to-be-constructed SQLException, or NULL if this should be defaulted to HY000
@param _nErrorCode
the ErrorCode of the to-be-constructed SQLException
*/
void prepend( const ::rtl::OUString& _rErrorMessage, const sal_Char* _pAsciiSQLState = NULL, const sal_Int32 _nErrorCode = 0 );
/** appends a plain message to the chain of exceptions
@param _eType
the type of exception to append. Must be SQL_EXCEPTION, SQL_WARNING, SQL_CONTEXT, for all other
values, the behavior is undefined.
@param _rErrorMessage
the message to append
@param _pAsciiSQLState
the SQLState of the exception to append
@param _nErrorCode
the error code of the exception to append
*/
void append( TYPE _eType, const ::rtl::OUString& _rErrorMessage, const sal_Char* _pAsciiSQLState = NULL, const sal_Int32 _nErrorCode = 0 );
/** throws (properly typed) the exception contained in the object
@precond
isValid() returns <TRUE/>
@throws SQLException
@throws RuntimeException
if the instance does not contain an SQLException
*/
void doThrow();
const SQLExceptionInfo& operator=(const ::com::sun::star::sdbc::SQLException& _rError);
const SQLExceptionInfo& operator=(const ::com::sun::star::sdbc::SQLWarning& _rError);
const SQLExceptionInfo& operator=(const ::com::sun::star::sdb::SQLContext& _rError);
const SQLExceptionInfo& operator=(const ::com::sun::star::sdb::SQLErrorEvent& _rErrorEvent);
const SQLExceptionInfo& operator=(const ::com::sun::star::uno::Any& _rCaughtSQLException);
sal_Bool isKindOf(TYPE _eType) const;
// not just a simple comparisation ! e.g. getType() == SQL_CONTEXT implies isKindOf(SQL_EXCEPTION) == sal_True !
sal_Bool isValid() const { return m_eType != UNDEFINED; }
TYPE getType() const { return m_eType; }
operator const ::com::sun::star::sdbc::SQLException* () const;
operator const ::com::sun::star::sdbc::SQLWarning* () const;
operator const ::com::sun::star::sdb::SQLContext* () const;
const ::com::sun::star::uno::Any& get() const { return m_aContent; }
void clear()
{
m_aContent.clear();
m_eType = UNDEFINED;
}
protected:
void implDetermineType();
};
//==============================================================================
//= SQLExceptionIteratorHelper - iterating through an SQLException chain
//==============================================================================
class OOO_DLLPUBLIC_DBTOOLS SQLExceptionIteratorHelper
{
protected:
const ::com::sun::star::sdbc::SQLException* m_pCurrent;
SQLExceptionInfo::TYPE m_eCurrentType;
public:
/** constructs an iterator instance from an SQLException
@param _rChainStart
the start of the exception chain to iterate. Must live as long as the iterator
instances lives, at least.
*/
SQLExceptionIteratorHelper( const ::com::sun::star::sdbc::SQLException& _rChainStart );
/** constructs an iterator instance from an SQLWarning
@param _rChainStart
the start of the exception chain to iterate. Must live as long as the iterator
instances lives, at least.
*/
SQLExceptionIteratorHelper( const ::com::sun::star::sdbc::SQLWarning& _rChainStart );
/** constructs an iterator instance from an SQLContext
@param _rChainStart
the start of the exception chain to iterate. Must live as long as the iterator
instances lives, at least.
*/
SQLExceptionIteratorHelper( const ::com::sun::star::sdb::SQLContext& _rChainStart );
/** constructs an iterator instance from an SQLExceptionInfo
@param _rErrorInfo
the start of the exception chain to iterate. Must live as long as the iterator
instances lives, at least.
*/
SQLExceptionIteratorHelper( const SQLExceptionInfo& _rErrorInfo );
/** determines whether there are more elements in the exception chain
*/
sal_Bool hasMoreElements() const { return ( m_pCurrent != NULL ); }
/** returns the type of the current element in the exception chain
*/
SQLExceptionInfo::TYPE currentType() const { return m_eCurrentType; }
/** retrieves the current element in the chain, or <NULL/> if the chain has been completely
traveled.
*/
const ::com::sun::star::sdbc::SQLException* current() const { return m_pCurrent; }
/** retrieves the current element in the chain, or <NULL/> if the chain has been completely
traveled.
In opposite to the second <member>current</member>, this version allows typed access to
the respective SQLException.
*/
void current( SQLExceptionInfo& _out_rInfo ) const;
/** proceeds to the next element in the chain
@return the current element in the chain, as <b>before</em> the chain move.
*/
const ::com::sun::star::sdbc::SQLException* next();
/** proceeds to the next element in the chain
In opposite to the second <member>current</member>, this version allows typed access to
the respective SQLException.
*/
void next( SQLExceptionInfo& _out_rInfo );
};
//==================================================================================
//= StandardExceptions
//==================================================================================
//----------------------------------------------------------------------------------
/** returns a standard error string for a given SQLState
@param _eState
describes the state whose description is to retrieve. Must not be SQL_ERROR_UNSPECIFIED.
@raises RuntimeException
in case of an internal error
*/
OOO_DLLPUBLIC_DBTOOLS ::rtl::OUString getStandardSQLState( StandardSQLState _eState );
//----------------------------------------------------------------------------------
/** returns a standard ASCII string for a given SQLState
@param _eState
describes the state whose description is to retrieve. Must not be SQL_ERROR_UNSPECIFIED.
@return
a non-<NULL/> pointer to an ASCII character string denoting the requested SQLState
@raises RuntimeException
in case of an internal error
*/
OOO_DLLPUBLIC_DBTOOLS const sal_Char* getStandardSQLStateAscii( StandardSQLState _eState );
//----------------------------------------------------------------------------------
OOO_DLLPUBLIC_DBTOOLS void throwFunctionNotSupportedException(
const ::rtl::OUString& _rMsg,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _Context,
const ::com::sun::star::uno::Any& _Next = ::com::sun::star::uno::Any()
)
throw ( ::com::sun::star::sdbc::SQLException );
//----------------------------------------------------------------------------------
/** throws an exception with SQL state IM001, saying that a certain function is not supported
*/
OOO_DLLPUBLIC_DBTOOLS void throwFunctionNotSupportedException(
const sal_Char* _pAsciiFunctionName,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxContext,
const ::com::sun::star::uno::Any* _pNextException = NULL
)
throw ( ::com::sun::star::sdbc::SQLException );
//----------------------------------------------------------------------------------
/** throws a function sequence (HY010) exception
*/
OOO_DLLPUBLIC_DBTOOLS void throwFunctionSequenceException(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _Context,
const ::com::sun::star::uno::Any& _Next = ::com::sun::star::uno::Any()
)
throw ( ::com::sun::star::sdbc::SQLException );
//----------------------------------------------------------------------------------
/** throw a invalid index sqlexception
*/
OOO_DLLPUBLIC_DBTOOLS void throwInvalidIndexException(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _Context,
const ::com::sun::star::uno::Any& _Next = ::com::sun::star::uno::Any()
)
throw ( ::com::sun::star::sdbc::SQLException );
//----------------------------------------------------------------------------------
/** throw a generic SQLException, i.e. one with an SQLState of HY000, an ErrorCode of 0 and no NextException
*/
OOO_DLLPUBLIC_DBTOOLS void throwGenericSQLException(
const ::rtl::OUString& _rMsg,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxSource
)
throw (::com::sun::star::sdbc::SQLException);
//----------------------------------------------------------------------------------
/** throw a generic SQLException, i.e. one with an SQLState of HY000, an ErrorCode of 0 and no NextException
*/
OOO_DLLPUBLIC_DBTOOLS void throwGenericSQLException(
const ::rtl::OUString& _rMsg,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxSource,
const ::com::sun::star::uno::Any& _rNextException
)
throw (::com::sun::star::sdbc::SQLException);
//----------------------------------------------------------------------------------
/** throw a SQLException with SQLState HYC00 (Optional feature not implemented)
@param _pAsciiFeatureName
an ASCII description of the feature which is not implemented. It's recommended that the feature
name is built from the name of the interface plus its method, for instance "XParameters::updateBinaryStream"
@param _rxContext
the context of the exception
@param _pNextException
the next exception to chain into the thrown exception, if any
*/
OOO_DLLPUBLIC_DBTOOLS void throwFeatureNotImplementedException(
const sal_Char* _pAsciiFeatureName,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxContext,
const ::com::sun::star::uno::Any* _pNextException = NULL
)
throw (::com::sun::star::sdbc::SQLException);
//----------------------------------------------------------------------------------
/** throws an SQLException
*/
OOO_DLLPUBLIC_DBTOOLS void throwSQLException(
const sal_Char* _pAsciiMessage,
const sal_Char* _pAsciiState,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxContext,
const sal_Int32 _nErrorCode = 0,
const ::com::sun::star::uno::Any* _pNextException = NULL
)
throw (::com::sun::star::sdbc::SQLException);
//----------------------------------------------------------------------------------
/** throws an SQLException
*/
OOO_DLLPUBLIC_DBTOOLS void throwSQLException(
const sal_Char* _pAsciiMessage,
StandardSQLState _eSQLState,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxContext,
const sal_Int32 _nErrorCode = 0,
const ::com::sun::star::uno::Any* _pNextException = NULL
)
throw (::com::sun::star::sdbc::SQLException);
//----------------------------------------------------------------------------------
/** throws an SQLException
*/
OOO_DLLPUBLIC_DBTOOLS void throwSQLException(
const ::rtl::OUString& _rMessage,
StandardSQLState _eSQLState,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxContext,
const sal_Int32 _nErrorCode = 0,
const ::com::sun::star::uno::Any* _pNextException = NULL
)
throw (::com::sun::star::sdbc::SQLException);
//.........................................................................
} // namespace dbtools
//.........................................................................
#endif // _DBHELPER_DBEXCEPTION_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
