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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: migrationlog.hxx,v $
* $Revision: 1.3.2.2 $
*
* 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 DBACCESS_MIGRATIONLOG_HXX
#define DBACCESS_MIGRATIONLOG_HXX
#include "dbmm_types.hxx"
/** === begin UNO includes === **/
/** === end UNO includes === **/
#include <rtl/ustring.hxx>
#include <memory>
//........................................................................
namespace dbmm
{
//........................................................................
typedef sal_Int16 DocumentID;
struct MigrationError;
//====================================================================
//= MigrationLog
//====================================================================
struct MigrationLog_Data;
class MigrationLog
{
public:
MigrationLog();
~MigrationLog();
//----------------------------------------------------------------
//- event logging
/** logs an unrecoverable error during the migration process
*/
void logFailure( const MigrationError& _rError );
/** logs a recoverable (or at least ignorable) error during the migration process
*/
void logRecoverable( const MigrationError& _rError );
/// checks whether logFailure has been called
bool hadFailure() const;
/// logs the fact that the database document has been backed up
void backedUpDocument( const ::rtl::OUString& _rNewDocumentLocation );
/** logs that the migration for a certain sub document has been started, returns
a unique ID for this sub document which is to be used in later calls
*/
DocumentID startedDocument( const SubDocumentType _eType, const ::rtl::OUString& _rName );
/** logs the event that a macro or script library has been moved from within a
sub document to the database document
*/
void movedLibrary(
const DocumentID _nDocID,
const ScriptType _eScriptType,
const ::rtl::OUString& _rOriginalLibName,
const ::rtl::OUString& _rNewLibName
);
/** logs that the migration for a certain document has been finished
*/
void finishedDocument( const DocumentID _nDocID );
//----------------------------------------------------------------
//- information retrieval
/** retrieves the new name of a library
The new library name must previously have been logger by calling
<member>movedLibrary</member>. If not, an assertion will be raised in
the non-product builds, and an empty string will be returned.
*/
const ::rtl::OUString&
getNewLibraryName(
DocumentID _nDocID,
ScriptType _eScriptType,
const ::rtl::OUString& _rOriginalLibName
) const;
/** determines whether for the given document, any library needed to be (and was) moved
*/
bool movedAnyLibrary( const DocumentID );
/** provides a human-readable version of the log, explaining a user what happened during
the migration.
*/
::rtl::OUString
getCompleteLog() const;
private:
::std::auto_ptr< MigrationLog_Data > m_pData;
};
//........................................................................
} // namespace dbmm
//........................................................................
#endif // DBACCESS_MIGRATIONLOG_HXX
|
