|
1 /* |
|
2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef MCSTORAGE_H |
|
20 #define MCSTORAGE_H |
|
21 |
|
22 |
|
23 #include <e32base.h> |
|
24 #include <bamdesca.h> |
|
25 #include "ncddatabasestorage.h" |
|
26 #include "ncdstorageitem.h" |
|
27 |
|
28 class CNcdStorageItem; |
|
29 class MNcdStorageDataItem; |
|
30 class CNcdStorageBaseListener; |
|
31 class CNcdStorageItemIdentifier; |
|
32 |
|
33 |
|
34 |
|
35 class CNcdStorageBase : public CBase |
|
36 { |
|
37 |
|
38 public: |
|
39 |
|
40 |
|
41 virtual ~CNcdStorageBase(); |
|
42 |
|
43 |
|
44 public: |
|
45 |
|
46 /** |
|
47 * @note Only ENcdStorageTypeDatabase is currently supported |
|
48 */ |
|
49 static CNcdStorageBase* NewL( |
|
50 RFs& aFs, |
|
51 const TDesC& aUid, |
|
52 const TDesC& aStorageFolder, |
|
53 const TDesC& aStorageName ); |
|
54 |
|
55 |
|
56 public: |
|
57 |
|
58 |
|
59 CNcdStorageItem* StorageItemL( const TDesC& aUid, TInt aType ); |
|
60 |
|
61 void StorageItemsL( RPointerArray<MNcdStorageItem>& aItems ); |
|
62 |
|
63 |
|
64 void RemoveItemsL( |
|
65 const RArray<RNcdDatabaseItems>& aDoNotRemoveItems ); |
|
66 |
|
67 void OpenItemL( CNcdStorageItem* aItem ); |
|
68 |
|
69 void SaveItemL( CNcdStorageItem* aItem ); |
|
70 |
|
71 void RemoveItemL( CNcdStorageItem* aItem ); |
|
72 |
|
73 void ReadDataL( CNcdStorageItem* aItem, MNcdStorageDataItem& aDataItem ); |
|
74 |
|
75 void WriteDataL( CNcdStorageItem* aItem, MNcdStorageDataItem& aDataItem ); |
|
76 |
|
77 TBool ItemsOpen() const; |
|
78 |
|
79 HBufC8* GetDataL( CNcdStorageItem* aItem ); |
|
80 |
|
81 |
|
82 TInt Commit(); |
|
83 |
|
84 void RollbackItems(); |
|
85 |
|
86 |
|
87 public: |
|
88 |
|
89 |
|
90 TInt Open(); |
|
91 |
|
92 void Close(); |
|
93 |
|
94 TBool IsOpen() const; |
|
95 |
|
96 const TDesC& Uid() const; |
|
97 |
|
98 const TDesC& StorageFolder() const; |
|
99 |
|
100 const TDesC& Name() const; |
|
101 |
|
102 void SetListener( CNcdStorageBaseListener* aListener ); |
|
103 |
|
104 void Rollback(); |
|
105 |
|
106 TBool ItemExistsInStorageL( const TDesC& aUid, TInt aType ); |
|
107 |
|
108 |
|
109 virtual void Compact() = 0; |
|
110 public: |
|
111 |
|
112 |
|
113 virtual RDbDatabase::TSize Size() const = 0; |
|
114 |
|
115 |
|
116 protected: |
|
117 |
|
118 |
|
119 CNcdStorageBase( HBufC* aUid, HBufC* aStorageFolder, HBufC* aName ); |
|
120 |
|
121 |
|
122 protected: |
|
123 |
|
124 CNcdStorageItem* FindStorageItem( const TDesC& aUid, TInt aType ); |
|
125 |
|
126 |
|
127 protected: |
|
128 |
|
129 virtual CNcdStorageItem* CreateStorageItemLC( const TDesC& aUid, TInt aType ) = 0; |
|
130 |
|
131 virtual TBool ItemExistsL( const TDesC& aUid, TInt aType ) = 0; |
|
132 |
|
133 virtual void DoOpenItemL( CNcdStorageItem* aItem ) = 0; |
|
134 |
|
135 virtual void DoRollback() = 0; |
|
136 |
|
137 virtual void DoRemoveItemL( CNcdStorageItem* aItem ) = 0; |
|
138 |
|
139 virtual void DoReadDataL( CNcdStorageItem* aItem, MNcdStorageDataItem& aDataItem ) = 0; |
|
140 |
|
141 virtual void DoWriteDataL( CNcdStorageItem* aItem, MNcdStorageDataItem& aDataItem ) = 0; |
|
142 |
|
143 virtual TInt DoCommit() = 0; |
|
144 |
|
145 virtual void GetAllItemsFromStorageL( RPointerArray<CNcdStorageItemIdentifier>& aItems ) = 0; |
|
146 |
|
147 virtual HBufC8* DoGetDataL( CNcdStorageItem* aItem ) = 0; |
|
148 |
|
149 virtual void DoRemoveItemsL( |
|
150 const RArray<RNcdDatabaseItems>& aDoNotRemoveItems ) = 0; |
|
151 |
|
152 |
|
153 protected: |
|
154 |
|
155 virtual void DoOpenL() = 0; |
|
156 |
|
157 virtual void DoClose() = 0; |
|
158 |
|
159 |
|
160 protected: |
|
161 |
|
162 HBufC8* GetAllDataL( RReadStream& aStream ); |
|
163 |
|
164 |
|
165 HBufC8* GetAllDataLC( RReadStream& aStream ); |
|
166 |
|
167 |
|
168 protected: |
|
169 |
|
170 |
|
171 |
|
172 HBufC* iUid; |
|
173 |
|
174 HBufC* iStorageFolder; |
|
175 |
|
176 HBufC* iName; |
|
177 |
|
178 TBool iOpen; |
|
179 |
|
180 |
|
181 private: |
|
182 |
|
183 RPointerArray<CNcdStorageItem> iItems; |
|
184 |
|
185 RPointerArray<CNcdStorageItem> iOpenItems; |
|
186 |
|
187 RPointerArray<CNcdStorageItem> iRemovedItems; |
|
188 |
|
189 CNcdStorageBaseListener* iListener; |
|
190 }; |
|
191 |
|
192 |
|
193 class CNcdStorageItem : public CBase, public MNcdStorageItem |
|
194 { |
|
195 |
|
196 public: |
|
197 |
|
198 /** |
|
199 * @note Uids must be unique in a type |
|
200 */ |
|
201 static CNcdStorageItem* NewL( CNcdStorageBase* aStorage, const TDesC& aUid, TInt aType ); |
|
202 |
|
203 ~CNcdStorageItem(); |
|
204 |
|
205 public: |
|
206 |
|
207 |
|
208 void SetOpen( TBool aOpen ); |
|
209 |
|
210 |
|
211 public: // From MNcdStorageItem |
|
212 |
|
213 |
|
214 virtual void OpenL(); |
|
215 |
|
216 /** |
|
217 * Marks the item as saved but doesn't commit it to storage until |
|
218 * all open items are saved |
|
219 */ |
|
220 virtual void SaveL(); |
|
221 |
|
222 /** |
|
223 * @note Rollbacks all open & saved items |
|
224 */ |
|
225 virtual void Rollback(); |
|
226 |
|
227 virtual void RemoveFromStorageL(); |
|
228 |
|
229 /** |
|
230 * Read data item from the storage |
|
231 */ |
|
232 virtual void ReadDataL(); |
|
233 |
|
234 /** |
|
235 * Write data item to the storage |
|
236 */ |
|
237 virtual void WriteDataL(); |
|
238 |
|
239 virtual TBool IsOpen() const; |
|
240 |
|
241 virtual const TDesC& Uid() const; |
|
242 |
|
243 virtual TInt Type() const; |
|
244 |
|
245 virtual void SetDataItem( MNcdStorageDataItem* aDataItem ); |
|
246 |
|
247 |
|
248 virtual HBufC8* GetDataLC(); |
|
249 |
|
250 |
|
251 protected: |
|
252 |
|
253 CNcdStorageItem( CNcdStorageBase* aStorage ); |
|
254 |
|
255 void ConstructL( const TDesC& aUid, TInt aType ); |
|
256 |
|
257 |
|
258 private: |
|
259 |
|
260 CNcdStorageBase* iStorage; |
|
261 |
|
262 MNcdStorageDataItem* iDataItem; |
|
263 |
|
264 CNcdStorageItemIdentifier* iIdentifier; |
|
265 |
|
266 TBool iOpen; |
|
267 |
|
268 }; |
|
269 |
|
270 |
|
271 class CNcdStorageItemIdentifier : public CBase |
|
272 { |
|
273 public: |
|
274 static CNcdStorageItemIdentifier* NewLC( const TDesC8& aId, TInt aType ); |
|
275 static CNcdStorageItemIdentifier* NewL( const TDesC16& aId, TInt aType ); |
|
276 static CNcdStorageItemIdentifier* NewLC( const TDesC16& aId, TInt aType ); |
|
277 |
|
278 ~CNcdStorageItemIdentifier(); |
|
279 |
|
280 public: |
|
281 |
|
282 const TDesC& Id() const; |
|
283 |
|
284 TInt Type() const; |
|
285 |
|
286 |
|
287 private: |
|
288 |
|
289 void ConstructL( const TDesC16& aId ); |
|
290 void ConstructL( const TDesC8& aId ); |
|
291 |
|
292 CNcdStorageItemIdentifier( TInt aType ); |
|
293 |
|
294 |
|
295 private: |
|
296 |
|
297 |
|
298 HBufC* iId; |
|
299 |
|
300 TInt iType; |
|
301 }; |
|
302 |
|
303 |
|
304 class CNcdStorageBaseListener : public CBase |
|
305 { |
|
306 |
|
307 public: |
|
308 |
|
309 virtual void CacheOpened() = 0; |
|
310 |
|
311 virtual void CacheReadyL() = 0; |
|
312 |
|
313 virtual void NotifyRollback() = 0; |
|
314 |
|
315 }; |
|
316 |
|
317 |
|
318 #endif |