Changes: add support for relationshipFilter with HasMember
[qtcontacts-tracker:qtcontacts-tracker.git] / src / dao / querybuilder.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the Qt Mobility Components.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** No Commercial Usage
11 ** This file contains pre-release code and may not be distributed.
12 ** You may use this file in accordance with the terms and conditions
13 ** contained in the Technology Preview License Agreement accompanying
14 ** this package.
15 **
16 ** GNU Lesser General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU Lesser
18 ** General Public License version 2.1 as published by the Free Software
19 ** Foundation and appearing in the file LICENSE.LGPL included in the
20 ** packaging of this file.  Please review the following information to
21 ** ensure the GNU Lesser General Public License version 2.1 requirements
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23 **
24 ** In addition, as a special exception, Nokia gives you certain additional
25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27 **
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
30 **
31 **
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QTRACKERCONTACTQUERYBUILDER_H
43 #define QTRACKERCONTACTQUERYBUILDER_H
44
45 #include "resourceinfo.h"
46
47 #include <QtTracker/tracker.h>
48
49 QTM_USE_NAMESPACE;
50
51 ////////////////////////////////////////////////////////////////////////////////////////////////////
52
53 class QTrackerContactDetail;
54 class QTrackerContactDetailField;
55 class QTrackerContactDetailSchema;
56 class PredicateChain;
57
58 ////////////////////////////////////////////////////////////////////////////////////////////////////
59
60 typedef QHash<QString, SopranoLive::RDFVariable>        VariableHash;
61 typedef QHash<PredicateChain, SopranoLive::RDFVariable> PredicateVariableHash;
62
63 ////////////////////////////////////////////////////////////////////////////////////////////////////
64
65 class PredicateChain : public QList<QUrl>
66 {
67 public:
68     PredicateChain() : QList<QUrl>() {}
69     PredicateChain(const QList<QUrl> &other) : QList<QUrl>(other) {}
70     PredicateChain(const PropertyInfoList::ConstIterator &first,
71                    const PropertyInfoList::ConstIterator &last,
72                    const PredicateChain &context = PredicateChain());
73 };
74
75 ////////////////////////////////////////////////////////////////////////////////////////////////////
76
77 class QTrackerContactQueryBuilder
78 {
79     Q_DISABLE_COPY(QTrackerContactQueryBuilder);
80
81 public: // typedefs
82     enum SubjectRole { Contact, HomeContext, WorkContext };
83
84 public: // constructors
85     explicit QTrackerContactQueryBuilder(const QTrackerContactDetailSchema &schema);
86     virtual ~QTrackerContactQueryBuilder();
87
88 public: // attributes
89     const QTrackerContactDetailSchema & schema() const { return m_schema; }
90     const PredicateVariableHash & properties() const { return m_properties; }
91     QContactManager::Error error() const { return m_error; }
92
93 public: // methods
94     static QString name(const QString &prefix, const QString &suffix);
95     static QString name(const SopranoLive::RDFVariable &variable, const QString &suffix = QString());
96     static QString name(const QContactDetail &detail, const QString &suffix = QString());
97     static QString name(const QTrackerContactDetail &detail, const QString &suffix = QString());
98     static QString name(const QTrackerContactDetail &detail, const QTrackerContactDetailField &field);
99
100     static SopranoLive::RDFVariable value(const QVariant &value);
101
102     void bindFields(const QTrackerContactDetail &detail, SopranoLive::RDFSelect &query);
103
104     bool bindFilter(const QContactFilter &filter, SopranoLive::RDFVariable &subject);
105     bool bindFilter(const QContactLocalIdFilter &filter, SopranoLive::RDFVariable &subject);
106     bool bindFilter(const QContactIntersectionFilter &filter, SopranoLive::RDFVariable &subject);
107     bool bindFilter(const QContactUnionFilter &filter, SopranoLive::RDFVariable &subject);
108     bool bindFilter(const QContactDetailFilter &filter, SopranoLive::RDFVariable &subject);
109     bool bindFilter(const QContactDetailRangeFilter &filter, SopranoLive::RDFVariable &subject);
110     bool bindFilter(const QContactChangeLogFilter &filter, SopranoLive::RDFVariable &subject);
111     bool bindFilter(const QContactRelationshipFilter &filter, SopranoLive::RDFVariable &subject);
112
113     static bool isFilterSupported(const QContactFilter &filter);
114     void bindLocalIdFilter(const QList<QContactLocalId> &localIds,
115                            SopranoLive::RDFVariable &subject);
116
117 private:
118     void bindColumns(const QTrackerContactDetail &detail,
119                      const QTrackerContactDetailField &field,
120                      SopranoLive::RDFSelect &query);
121
122     void bindFields(const QTrackerContactDetail &detail,
123                     SubjectRole role, SopranoLive::RDFVariable &subject);
124
125     void bindProperties(const QTrackerContactDetail &detail,
126                         const QTrackerContactDetailField &field,
127                         SopranoLive::RDFVariable subject,
128                         SopranoLive::RDFVariable &object);
129     void bindSubTypes(const QTrackerContactDetail &detail,
130                       const QTrackerContactDetailField &field,
131                       SopranoLive::RDFVariable &subject);
132     void bindDetailUri(const QTrackerContactDetail &detail,
133                        const QTrackerContactDetailField &field);
134
135     const QTrackerContactDetail * findDetail(const QString &detailName);
136
137     const QTrackerContactDetailField * findField(const QTrackerContactDetail &detail,
138                                                  const QString &fieldName);
139
140     VariableHash::Iterator lookupVariable(const QString &name);
141
142 private:
143     QContactManager::Error              m_error;
144     const QTrackerContactDetailSchema  &m_schema;
145     VariableHash                        m_variables;
146     PredicateVariableHash               m_properties;
147     PredicateChain                      m_context;
148 };
149
150 ////////////////////////////////////////////////////////////////////////////////////////////////////
151
152 template<class Container>
153 inline SopranoLive::RDFVariableList
154 literalVariableList(const Container &container)
155 {
156     SopranoLive::RDFVariableList result;
157
158     foreach(const QString &value, container) {
159         result.append(SopranoLive::LiteralValue(value));
160     }
161
162     return result;
163 }
164
165 template<class Container>
166 inline SopranoLive::RDFVariableList
167 iriVariableList(const Container &container)
168 {
169     SopranoLive::RDFVariableList result;
170
171     foreach(const QUrl &iri, container) {
172         result.append(iri);
173     }
174
175     return result;
176 }
177
178 ////////////////////////////////////////////////////////////////////////////////////////////////////
179
180 #endif // QTRACKERCONTACTQUERYBUILDER_H