85
|
1 |
/*
|
|
2 |
* Copyright (c) 2009 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: caquery.cpp
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#include <QStringList>
|
|
19 |
#include <QDebug>
|
|
20 |
|
|
21 |
#include "caquery.h"
|
|
22 |
#include "caquery_p.h"
|
|
23 |
|
|
24 |
// ======== MEMBER FUNCTIONS ========
|
|
25 |
|
|
26 |
|
|
27 |
/*!
|
|
28 |
\class CaQuery
|
|
29 |
\brief This class contains data describing a query used by CaService.
|
|
30 |
|
|
31 |
Thanks to CaQuery object, it's possible to create objects easly
|
|
32 |
using this one like CaNotifierFilter for example or define criteria during
|
|
33 |
geting entries via service. CaQuery anable set usufull data to do that,
|
|
34 |
including entry roles, type names, parent id, sort ordering
|
|
35 |
and set on/off flags quickly.
|
|
36 |
|
|
37 |
\example
|
|
38 |
\code
|
|
39 |
CaQuery query;
|
|
40 |
query.setEntryRoles( ItemEntryRole | GroupEntryRole );
|
|
41 |
query.setSort( MostUsedSortAttribute, Qt::DescendingOrder );
|
|
42 |
query.setFlagsOn( UsedEntryFlag | RemovableEntryFlag | RunningEntryFlag );
|
|
43 |
query.setFlagsOff( SystemEntryFlag | VisibleEntryFlag );
|
|
44 |
// using CaQuery to get data from DB
|
|
45 |
QList<CaEntry *> entries = CaService::instance()->getEntries( query );
|
|
46 |
...
|
|
47 |
// using CaQuery to create notifier
|
|
48 |
CaQuery queryNot( query );
|
|
49 |
CaNotifierFilter notifierFilter( queryNot );
|
|
50 |
CaNotifier * notifier = CaService::instance()->createNotifier( notifierFilter );
|
|
51 |
...
|
|
52 |
|
|
53 |
\endcode
|
|
54 |
*/
|
|
55 |
|
|
56 |
/*!
|
|
57 |
Default constructor.
|
|
58 |
*/
|
|
59 |
CaQuery::CaQuery() :
|
|
60 |
m_d(new CaQueryPrivate(this))
|
|
61 |
{
|
|
62 |
|
|
63 |
}
|
|
64 |
|
|
65 |
/*!
|
|
66 |
Copy constructor.
|
|
67 |
\param query reference to CaQuery.
|
|
68 |
*/
|
|
69 |
CaQuery::CaQuery(const CaQuery &query) :
|
|
70 |
m_d(new CaQueryPrivate(this))
|
|
71 |
{
|
|
72 |
*m_d = *(query.m_d);
|
|
73 |
}
|
|
74 |
|
|
75 |
/*!
|
|
76 |
Copy assignment operator.
|
|
77 |
\param query const reference to CaQuery.
|
|
78 |
\retval reference to CaQuery.
|
|
79 |
*/
|
|
80 |
CaQuery &CaQuery::operator=(const CaQuery &query)
|
|
81 |
{
|
|
82 |
if (this != &query) {
|
|
83 |
*m_d = *(query.m_d);
|
|
84 |
}
|
|
85 |
return *this;
|
|
86 |
}
|
|
87 |
|
|
88 |
/*!
|
|
89 |
Destructor.
|
|
90 |
*/
|
|
91 |
CaQuery::~CaQuery()
|
|
92 |
{
|
|
93 |
delete m_d;
|
|
94 |
}
|
|
95 |
|
|
96 |
/*!
|
|
97 |
Sets entry roles.
|
|
98 |
\param entryRoles role of the entry.
|
|
99 |
*/
|
|
100 |
void CaQuery::setEntryRoles(EntryRoles entryRoles)
|
|
101 |
{
|
|
102 |
m_d->setEntryRoles(entryRoles);
|
|
103 |
}
|
|
104 |
|
|
105 |
/*!
|
|
106 |
Returns an entry role.
|
|
107 |
\retval entry role.
|
|
108 |
*/
|
|
109 |
EntryRoles CaQuery::entryRoles() const
|
|
110 |
{
|
|
111 |
return m_d->entryRoles();
|
|
112 |
}
|
|
113 |
|
|
114 |
/*!
|
|
115 |
Sets parent id.
|
|
116 |
\param id id of the parent.
|
|
117 |
*/
|
|
118 |
void CaQuery::setParentId(int id)
|
|
119 |
{
|
|
120 |
m_d->setParentId(id);
|
|
121 |
}
|
|
122 |
|
|
123 |
/*!
|
|
124 |
Returns parent id.
|
|
125 |
\retval parent id.
|
|
126 |
*/
|
|
127 |
int CaQuery::parentId() const
|
|
128 |
{
|
|
129 |
return m_d->parentId();
|
|
130 |
}
|
|
131 |
|
|
132 |
/*!
|
|
133 |
Sets names of entry types.
|
|
134 |
\param entryTypeNames list of entry type names (strings).
|
|
135 |
*/
|
|
136 |
void CaQuery::setEntryTypeNames(const QStringList &entryTypeNames)
|
|
137 |
{
|
|
138 |
m_d->setEntryTypeNames(entryTypeNames);
|
|
139 |
}
|
|
140 |
|
|
141 |
/*!
|
|
142 |
Returns a list of entry type names.
|
|
143 |
\retval list of names of entry types.
|
|
144 |
*/
|
|
145 |
QStringList CaQuery::entryTypeNames() const
|
|
146 |
{
|
|
147 |
return m_d->entryTypeNames();
|
|
148 |
}
|
|
149 |
|
|
150 |
/*!
|
|
151 |
Adds the next entry type name.
|
|
152 |
\param entryTypeName name of an entry type.
|
|
153 |
*/
|
|
154 |
void CaQuery::addEntryTypeName(const QString &entryTypeName)
|
|
155 |
{
|
|
156 |
m_d->addEntryTypeName(entryTypeName);
|
|
157 |
}
|
|
158 |
|
|
159 |
/*!
|
|
160 |
Sets flags which should be enabled.
|
|
161 |
\param onFlags flags.
|
|
162 |
*/
|
|
163 |
void CaQuery::setFlagsOn(EntryFlags onFlags)
|
|
164 |
{
|
|
165 |
m_d->setFlagsOn(onFlags);
|
|
166 |
}
|
|
167 |
|
|
168 |
/*!
|
|
169 |
Returns enabled flags.
|
|
170 |
\retval flags which should be enabled.
|
|
171 |
*/
|
|
172 |
EntryFlags CaQuery::flagsOn() const
|
|
173 |
{
|
|
174 |
return m_d->flagsOn();
|
|
175 |
}
|
|
176 |
|
|
177 |
/*!
|
|
178 |
Sets flags which should be disabled.
|
|
179 |
\param offFlags flags.
|
|
180 |
*/
|
|
181 |
void CaQuery::setFlagsOff(EntryFlags offFlags)
|
|
182 |
{
|
|
183 |
m_d->setFlagsOff(offFlags);
|
|
184 |
}
|
|
185 |
|
|
186 |
/*!
|
|
187 |
Returns disabled flags.
|
|
188 |
\retval flags which should be disabled.
|
|
189 |
*/
|
|
190 |
EntryFlags CaQuery::flagsOff() const
|
|
191 |
{
|
|
192 |
return m_d->flagsOff();
|
|
193 |
}
|
|
194 |
|
|
195 |
/*!
|
|
196 |
Sets type of sorting.
|
|
197 |
\param sortAttribute enum describing what is taken into account to sort.
|
|
198 |
\param sortOrder sort order (ascending, descending).
|
|
199 |
*/
|
|
200 |
void CaQuery::setSort(SortAttribute sortAttribute, Qt::SortOrder sortOrder)
|
|
201 |
{
|
|
202 |
m_d->setSort(sortAttribute, sortOrder);
|
|
203 |
}
|
|
204 |
|
|
205 |
/*!
|
|
206 |
Gets type of sorting.
|
|
207 |
\param[out] sortAttribute enum describing what is taken into account to sort.
|
|
208 |
\param[out] sortOrder sort order (ascending, descending).
|
|
209 |
*/
|
|
210 |
void CaQuery::getSort(SortAttribute& sortAttribute,
|
|
211 |
Qt::SortOrder& sortOrder) const
|
|
212 |
{
|
|
213 |
m_d->getSort(sortAttribute, sortOrder);
|
|
214 |
}
|
|
215 |
|
|
216 |
/*!
|
|
217 |
Returns no of entries.
|
|
218 |
\retval no of entries.
|
|
219 |
*/
|
|
220 |
unsigned int CaQuery::count() const
|
|
221 |
{
|
|
222 |
return m_d->count();
|
|
223 |
}
|
|
224 |
|
|
225 |
/*!
|
|
226 |
Sets no of entries.
|
|
227 |
\param count no of entries.
|
|
228 |
*/
|
|
229 |
void CaQuery::setCount(unsigned int count)
|
|
230 |
{
|
|
231 |
m_d->setCount(count);
|
|
232 |
}
|
|
233 |
|
|
234 |
/*!
|
|
235 |
Clears query (restores the initial state).
|
|
236 |
*/
|
|
237 |
void CaQuery::clear()
|
|
238 |
{
|
|
239 |
m_d->clear();
|
|
240 |
}
|
|
241 |
|
|
242 |
/*!
|
|
243 |
Constructor.
|
|
244 |
\param queryPublic reference to CaQuery.
|
|
245 |
*/
|
|
246 |
CaQueryPrivate::CaQueryPrivate(CaQuery *queryPublic) :
|
|
247 |
m_q(queryPublic), mEntryRoles(ItemEntryRole | GroupEntryRole),
|
|
248 |
mParentId(0), mEntryTypeNames(), mFlagsOn(), mFlagsOff(),
|
|
249 |
mSortAttribute(DefaultSortAttribute),
|
|
250 |
mSortOrder(Qt::AscendingOrder), mCount(0)
|
|
251 |
{
|
|
252 |
}
|
|
253 |
|
|
254 |
/*!
|
|
255 |
Copy assignment operator.
|
|
256 |
\param queryPrivate const reference to CaQueryPrivate.
|
|
257 |
\retval reference to CaQueryPrivate.
|
|
258 |
*/
|
|
259 |
|
|
260 |
CaQueryPrivate &CaQueryPrivate::operator=(
|
|
261 |
const CaQueryPrivate &queryPrivate)
|
|
262 |
{
|
|
263 |
/*m_q is not changed*/
|
|
264 |
mEntryRoles = queryPrivate.mEntryRoles;
|
|
265 |
mParentId = queryPrivate.mParentId;
|
|
266 |
mEntryTypeNames = queryPrivate.mEntryTypeNames;
|
|
267 |
mFlagsOn = queryPrivate.mFlagsOn;
|
|
268 |
mFlagsOff = queryPrivate.mFlagsOff;
|
|
269 |
mSortAttribute = queryPrivate.mSortAttribute;
|
|
270 |
mSortOrder = queryPrivate.mSortOrder;
|
|
271 |
mCount = queryPrivate.mCount;
|
|
272 |
|
|
273 |
return *this;
|
|
274 |
}
|
|
275 |
|
|
276 |
/*!
|
|
277 |
Destructor.
|
|
278 |
*/
|
|
279 |
CaQueryPrivate::~CaQueryPrivate()
|
|
280 |
{
|
|
281 |
}
|
|
282 |
|
|
283 |
/*!
|
|
284 |
Returns an entry role.
|
|
285 |
\retval entry role.
|
|
286 |
*/
|
|
287 |
EntryRoles CaQueryPrivate::entryRoles() const
|
|
288 |
{
|
|
289 |
return mEntryRoles;
|
|
290 |
}
|
|
291 |
|
|
292 |
/*!
|
|
293 |
Sets entry roles.
|
|
294 |
\param entryRoles role of the entry.
|
|
295 |
*/
|
|
296 |
void CaQueryPrivate::setEntryRoles(EntryRoles entryRoles)
|
|
297 |
{
|
|
298 |
mEntryRoles = entryRoles;
|
|
299 |
}
|
|
300 |
|
|
301 |
/*!
|
|
302 |
Returns parent id.
|
|
303 |
\retval parent id.
|
|
304 |
*/
|
|
305 |
int CaQueryPrivate::parentId() const
|
|
306 |
{
|
|
307 |
return mParentId;
|
|
308 |
}
|
|
309 |
|
|
310 |
/*!
|
|
311 |
Sets parent id.
|
|
312 |
\param id id of the parent.
|
|
313 |
*/
|
|
314 |
void CaQueryPrivate::setParentId(int id)
|
|
315 |
{
|
|
316 |
mParentId = id;
|
|
317 |
}
|
|
318 |
|
|
319 |
/*!
|
|
320 |
Returns a list of entry type names.
|
|
321 |
\retval list of names of entry types.
|
|
322 |
*/
|
|
323 |
QStringList CaQueryPrivate::entryTypeNames() const
|
|
324 |
{
|
|
325 |
return mEntryTypeNames;
|
|
326 |
}
|
|
327 |
|
|
328 |
/*!
|
|
329 |
Sets names of entry types.
|
|
330 |
\param entryTypeNames list of entry type names (strings).
|
|
331 |
*/
|
|
332 |
void CaQueryPrivate::setEntryTypeNames(const QStringList &entryTypeNames)
|
|
333 |
{
|
|
334 |
mEntryTypeNames = entryTypeNames;
|
|
335 |
}
|
|
336 |
|
|
337 |
/*!
|
|
338 |
Adds the next entry type name.
|
|
339 |
\param entryTypeName name of an entry type.
|
|
340 |
*/
|
|
341 |
void CaQueryPrivate::addEntryTypeName(const QString &entryTypeName)
|
|
342 |
{
|
|
343 |
mEntryTypeNames << entryTypeName;
|
|
344 |
}
|
|
345 |
|
|
346 |
/*!
|
|
347 |
Sets flags which should be enabled.
|
|
348 |
\param onFlags flags.
|
|
349 |
*/
|
|
350 |
void CaQueryPrivate::setFlagsOn(EntryFlags onFlags)
|
|
351 |
{
|
|
352 |
mFlagsOn = onFlags;
|
|
353 |
}
|
|
354 |
|
|
355 |
/*!
|
|
356 |
Returns enabled flags.
|
|
357 |
\retval flags which should be enabled.
|
|
358 |
*/
|
|
359 |
EntryFlags CaQueryPrivate::flagsOn() const
|
|
360 |
{
|
|
361 |
return mFlagsOn;
|
|
362 |
}
|
|
363 |
|
|
364 |
/*!
|
|
365 |
Sets flags which should be disabled.
|
|
366 |
\param offFlags flags.
|
|
367 |
*/
|
|
368 |
void CaQueryPrivate::setFlagsOff(EntryFlags offFlags)
|
|
369 |
{
|
|
370 |
mFlagsOff = offFlags;
|
|
371 |
}
|
|
372 |
|
|
373 |
/*!
|
|
374 |
Returns disabled flags.
|
|
375 |
\retval flags which should be disabled.
|
|
376 |
*/
|
|
377 |
EntryFlags CaQueryPrivate::flagsOff() const
|
|
378 |
{
|
|
379 |
return mFlagsOff;
|
|
380 |
}
|
|
381 |
|
|
382 |
/*!
|
|
383 |
Gets type of sorting.
|
|
384 |
\param[out] sortAttribute enum describing what is taken into account to sort.
|
|
385 |
\param[out] sortOrder sort order (ascending, descending).
|
|
386 |
*/
|
|
387 |
void CaQueryPrivate::getSort(SortAttribute &sortAttribute,
|
|
388 |
Qt::SortOrder &sortOrder) const
|
|
389 |
{
|
|
390 |
sortAttribute = mSortAttribute;
|
|
391 |
sortOrder = mSortOrder;
|
|
392 |
}
|
|
393 |
|
|
394 |
/*!
|
|
395 |
Sets type of sorting.
|
|
396 |
\param sortAttribute enum describing what is taken into account to sort.
|
|
397 |
\param sortOrder sort order (ascending, descending).
|
|
398 |
*/
|
|
399 |
void CaQueryPrivate::setSort(SortAttribute sortAttribute,
|
|
400 |
Qt::SortOrder sortOrder)
|
|
401 |
{
|
|
402 |
mSortAttribute = sortAttribute;
|
|
403 |
mSortOrder = sortOrder;
|
|
404 |
}
|
|
405 |
|
|
406 |
/*!
|
|
407 |
Returns no of entries.
|
|
408 |
\retval no of entries.
|
|
409 |
*/
|
|
410 |
unsigned int CaQueryPrivate::count() const
|
|
411 |
{
|
|
412 |
return mCount;
|
|
413 |
}
|
|
414 |
|
|
415 |
/*!
|
|
416 |
Sets no of entries.
|
|
417 |
\param count no of entries.
|
|
418 |
*/
|
|
419 |
void CaQueryPrivate::setCount(unsigned int count)
|
|
420 |
{
|
|
421 |
mCount = count;
|
|
422 |
}
|
|
423 |
|
|
424 |
/*!
|
|
425 |
Clears query (restores the initial state).
|
|
426 |
*/
|
|
427 |
void CaQueryPrivate::clear()
|
|
428 |
{
|
|
429 |
mEntryRoles = ItemEntryRole | GroupEntryRole;
|
|
430 |
mParentId = 0;
|
|
431 |
mEntryTypeNames = QStringList();
|
|
432 |
mFlagsOn = EntryFlags();
|
|
433 |
mFlagsOff = EntryFlags();
|
|
434 |
mSortAttribute = DefaultSortAttribute;
|
|
435 |
mSortOrder = Qt::AscendingOrder;
|
|
436 |
mCount = 0;
|
|
437 |
}
|