1 /* |
|
2 * Copyright (c) 2008 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: Main class in the SQL wrapper component |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 #ifndef C_CMSQLMAIN_H |
|
24 #define C_CMSQLMAIN_H |
|
25 |
|
26 #include <e32base.h> |
|
27 #include "mcmsqlmain.h" |
|
28 |
|
29 // Forward declarations |
|
30 class RFs; |
|
31 |
|
32 /** |
|
33 * CCmSqlMain class ( Interface to sql wrapper ) |
|
34 * Part of SQL wrapper. SQL wrapper is part of |
|
35 * Content manager component. |
|
36 * |
|
37 * @lib cmsqlwrapper.lib |
|
38 * |
|
39 * @since S60 5.1 |
|
40 */ |
|
41 class CCmSqlMain : public CBase, |
|
42 public MCmSqlMain |
|
43 { |
|
44 |
|
45 public: |
|
46 |
|
47 /** |
|
48 * Two-phased constructor. |
|
49 * |
|
50 * @since S60 5.1 |
|
51 * @param aFs, ref to file server session |
|
52 * @return pointer to CCmSqlMain class |
|
53 */ |
|
54 static CCmSqlMain* NewL( RFs& aFs ); |
|
55 |
|
56 /** |
|
57 * Two-phased constructor. |
|
58 * |
|
59 * @since S60 5.1 |
|
60 * @param aFs, ref to file server session |
|
61 * @return pointer to CCmSqlMain class |
|
62 */ |
|
63 static CCmSqlMain* NewLC( RFs& aFs ); |
|
64 |
|
65 /** |
|
66 * Destructor. |
|
67 */ |
|
68 virtual ~CCmSqlMain(); |
|
69 |
|
70 /** |
|
71 * Canceling operation |
|
72 * |
|
73 * @since S60 5.1 |
|
74 * @param None |
|
75 * @return None |
|
76 */ |
|
77 void CancelAsyncOperation(); |
|
78 |
|
79 /** |
|
80 * Setting media server id |
|
81 * |
|
82 * @since S60 5.1 |
|
83 * @param aId, id to be used |
|
84 * @return None |
|
85 */ |
|
86 void SetMsId( TUint aId ); |
|
87 |
|
88 /** |
|
89 * Setting mmc quota |
|
90 * |
|
91 * @since S60 5.1 |
|
92 * @param aQuota, quota to be used in unlimited fill lists |
|
93 * @return None |
|
94 */ |
|
95 void SetQuota( TInt64 aQuota ); |
|
96 |
|
97 /** |
|
98 * Setting dlna profile filters |
|
99 * |
|
100 * @since S60 5.1 |
|
101 * @param aProfileIds, unsupported profile ids |
|
102 * @return None |
|
103 */ |
|
104 void SetDlnaProfileFilters( const RArray<TInt64>& aProfileIds ); |
|
105 |
|
106 /** |
|
107 * Asyncronous batch add |
|
108 * |
|
109 * @since S60 5.1 |
|
110 * @param aItems, items to be added |
|
111 * @param aStatus, request status to be completed |
|
112 * @return None |
|
113 */ |
|
114 void AsyncBatchAdd( RPointerArray<CCmSqlGenericItem>& aItems, |
|
115 TRequestStatus& aStatus ); |
|
116 |
|
117 /** |
|
118 * Asyncronous batch property value add |
|
119 * |
|
120 * @since S60 5.1 |
|
121 * @param aItems, property items to be added |
|
122 * @param aField, property identifier |
|
123 * @param aStatus, request status to be completed |
|
124 * @return None |
|
125 */ |
|
126 void AsyncBatchAddPropertyItems( |
|
127 RPointerArray<CCmSqlPropertyItem>& aItems, TCmMetadataField aField, |
|
128 TRequestStatus& aStatus ); |
|
129 |
|
130 /** |
|
131 * Syncronous property value add |
|
132 * |
|
133 * @since S60 5.1 |
|
134 * @param aItem, property item to be added |
|
135 * @param aField, property identifier |
|
136 * @return None |
|
137 */ |
|
138 void SyncAddPropertyItemL( CCmSqlPropertyItem& aItem, |
|
139 TCmMetadataField aField ); |
|
140 |
|
141 /** |
|
142 * Asyncronous batch delete |
|
143 * |
|
144 * @since S60 5.1 |
|
145 * @param aItems, items to be deleted |
|
146 * @param aStatus, request status to be completed |
|
147 * @return None |
|
148 */ |
|
149 void AsyncBatchDelete( RPointerArray<CCmSqlBaseItem>& aItems, |
|
150 TRequestStatus& aStatus ); |
|
151 |
|
152 /** |
|
153 * Asyncronous metadata delete |
|
154 * |
|
155 * @since S60 5.1 |
|
156 * @param aMsIds, defines where metadata is harvested |
|
157 * @param aStatus, request status to be completed |
|
158 * @return None |
|
159 */ |
|
160 void AsyncMetadataDelete( RArray<TInt>& aMsIds, |
|
161 TRequestStatus& aStatus ); |
|
162 |
|
163 /** |
|
164 * SELECT XXX oldest and delete those |
|
165 * Delete defined amount of media items |
|
166 * |
|
167 * @since S60 5.1 |
|
168 * @param aType, media type identifier |
|
169 * @param aCount, amount to be deleted |
|
170 * @return None |
|
171 */ |
|
172 void DeleteOldestMediaItemsL( TCmMediaType aType, |
|
173 TInt64 aCount ); |
|
174 |
|
175 /** |
|
176 * Deletes unused propertys |
|
177 * |
|
178 * @since S60 5.1 |
|
179 * @param None |
|
180 * @return None |
|
181 */ |
|
182 void DeleteUnusedPropertys( ); |
|
183 |
|
184 /** |
|
185 * Asyncronous metadata query |
|
186 * |
|
187 * @since S60 5.1 |
|
188 * @param aItems, result array reference |
|
189 * @param aStatus, request status to be completed |
|
190 * @return None |
|
191 */ |
|
192 void GetItemsL( RPointerArray<CCmSqlBaseItem>& aItems, |
|
193 TRequestStatus& aStatus ); |
|
194 |
|
195 /** |
|
196 * Asyncronous fill list item query |
|
197 * |
|
198 * @since S60 5.1 |
|
199 * @param aItems, result array reference |
|
200 * @param aRule, fill list used as a query clause parameter |
|
201 * @param aStatus, request status to be completed |
|
202 * @return None |
|
203 */ |
|
204 void GetFillItemsL( RPointerArray<CCmFillListItem>& aItems, |
|
205 CCmFillRule& aRule, TRequestStatus& aStatus ); |
|
206 |
|
207 /** |
|
208 * Asyncronous metadata property values query |
|
209 * |
|
210 * @since S60 5.1 |
|
211 * @param aItems, result array reference |
|
212 * @param aStatus, request status to be completed |
|
213 * @param aField, property identifier ( e.g. artist ) |
|
214 * @param aMedia, media type identifier ( e.g. audio ) |
|
215 * @return None |
|
216 */ |
|
217 void GetPropertyValuesL( |
|
218 RPointerArray<CCmSqlPropertyItem>& aItems, TRequestStatus& aStatus, |
|
219 TCmMetadataField aField, TCmMediaType aMedia = ECmAll ); |
|
220 |
|
221 /** |
|
222 * Asyncronous metadata filtered property values query |
|
223 * |
|
224 * @since S60 5.1 |
|
225 * @param aPropertys, result array reference |
|
226 * @param aStatus, request status to be completed |
|
227 * @return None |
|
228 */ |
|
229 void GetFilteredPropertyValuesL( |
|
230 CCmSqlPropertyCollector& aPropertys, TRequestStatus& aStatus ); |
|
231 |
|
232 /** |
|
233 * Returns amount of media items |
|
234 * |
|
235 * @since S60 5.1 |
|
236 * @param aCount, media amount on return |
|
237 * @param aType, media type |
|
238 * @return None |
|
239 */ |
|
240 void GetMediaCountL( TInt64& aCount, TCmMediaType aType ); |
|
241 |
|
242 /** |
|
243 * Returns ETrue if item exist in db |
|
244 * |
|
245 * @since S60 5.1 |
|
246 * @param aItem, item |
|
247 * @param aDevId, device id |
|
248 * @return ETrue if exists |
|
249 */ |
|
250 TBool ExistsL( const CCmBaseListItem& aItem, const TInt aDevId ); |
|
251 |
|
252 /** |
|
253 * Deletes the object |
|
254 * |
|
255 * @since S60 5.1 |
|
256 * @param None |
|
257 * @return None |
|
258 */ |
|
259 void Close(); |
|
260 |
|
261 private: |
|
262 |
|
263 /** |
|
264 * Performs the first phase of two phase construction. |
|
265 * |
|
266 * @since S60 5.1 |
|
267 * @param aFs, file server |
|
268 * @return None |
|
269 */ |
|
270 CCmSqlMain( RFs& aFs ); |
|
271 |
|
272 /** |
|
273 * Performs the second phase construction. |
|
274 */ |
|
275 void ConstructL(); |
|
276 |
|
277 |
|
278 private: |
|
279 |
|
280 /** |
|
281 * Clause format class |
|
282 */ |
|
283 CCmSqlDbClause* iClause; // Owned |
|
284 |
|
285 /** |
|
286 * Database maintenance class |
|
287 */ |
|
288 CCmSqlDbMaintenance* iMaintenance; // Owned |
|
289 |
|
290 /** |
|
291 * Database connection class |
|
292 */ |
|
293 CCmSqlConnection* iConnection; // Owned |
|
294 |
|
295 /** |
|
296 * Reference to file server session |
|
297 */ |
|
298 RFs& iFs; |
|
299 |
|
300 }; |
|
301 |
|
302 #endif // C_CMSQLMAIN_H |
|