summaryrefslogtreecommitdiffstats
path: root/src/clientcompat/jsondb-query.h
blob: 5e4210524242b300ea841d1c33176331ca112871 (plain)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtAddOn.JsonDb module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef JSONDB_QUERY_H
#define JSONDB_QUERY_H

#include <QObject>
#include <QVariantMap>
#include <QList>
#include <QStringList>
#include <QScopedPointer>

#include "jsondb-global.h"
#include "jsondb-error.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE_JSONDB

class JsonDbClient;
class JsonDbResultBasePrivate;
class JsonDbQueryPrivate;
class JsonDbChangesSincePrivate;

class Q_ADDON_JSONDB_EXPORT JsonDbResultBase : public QObject
{
    Q_OBJECT
    Q_PROPERTY(int requestId READ requestId)
    Q_PROPERTY(bool isFinished READ isFinished)
    Q_PROPERTY(int resultsAvailable READ resultsAvailable)
    Q_PROPERTY(QString partition READ partition WRITE setPartition)

public:
    ~JsonDbResultBase();

    int requestId() const;
    bool isFinished() const;

    QVariantMap header() const;

    int resultsAvailable() const;

    QString partition() const;
    void setPartition(const QString &);

public Q_SLOTS:
    virtual void start();
    QVariantList takeResults();

Q_SIGNALS:
    void started();
    void resultsReady(int resultsAvailable);
    void finished();
#ifdef qdoc
    void error(JsonDbError::ErrorCode code, const QString &message);
#else
    void error(QtAddOn::JsonDb::JsonDbError::ErrorCode code, const QString &message);
#endif

protected:
    JsonDbResultBase(JsonDbResultBasePrivate *d, QObject *parent = 0);

    Q_DISABLE_COPY(JsonDbResultBase)
    Q_DECLARE_PRIVATE(JsonDbResultBase)
    QScopedPointer<JsonDbResultBasePrivate> d_ptr;
};

class Q_ADDON_JSONDB_EXPORT JsonDbQuery : public JsonDbResultBase
{
    Q_OBJECT
    Q_PROPERTY(QString partition READ partition WRITE setPartition)
    Q_PROPERTY(QString query READ query WRITE setQuery)
    Q_PROPERTY(int queryOffset READ queryOffset WRITE setQueryOffset)
    Q_PROPERTY(int queryLimit READ queryLimit WRITE setQueryLimit)
    Q_PROPERTY(int resultsAvailable READ resultsAvailable)

    Q_PROPERTY(quint32 stateNumber READ stateNumber)
    Q_PROPERTY(QString sortKey READ sortKey)

public:
    ~JsonDbQuery();

    quint32 stateNumber() const;
    QString sortKey() const;

    QString query() const;
    void setQuery(const QString &);

    int queryOffset() const;
    void setQueryOffset(int offset);

    int queryLimit() const;
    void setQueryLimit(int limit);

#ifdef qdoc
    int requestId() const;
    bool isFinished() const;
Q_SIGNALS:
    void started();
    void resultsReady(int resultsAvailable);
    void finished();
    void error(JsonDbError::ErrorCode code, const QString &message);
public Q_SLOTS:
    QVariantList takeResults();
#endif

public Q_SLOTS:
    virtual void start();

    void bindValue(const QString &placeHolder, const QVariant &val);
    QVariant boundValue(const QString &placeHolder) const;
    QMap<QString,QVariant> boundValues() const;

private:
    JsonDbQuery(JsonDbClient *client, QObject *parent = 0);

    Q_DECLARE_PRIVATE(JsonDbQuery)
    Q_PRIVATE_SLOT(d_func(), void _q_response(int,QVariant))
    Q_PRIVATE_SLOT(d_func(), void _q_error(int,int,QString))
    Q_PRIVATE_SLOT(d_func(), void _q_emitMoreData())
    friend class JsonDbClient;
};

class Q_ADDON_JSONDB_EXPORT JsonDbChangesSince : public JsonDbResultBase
{
    Q_OBJECT
    Q_PROPERTY(QString partition READ partition WRITE setPartition)
    Q_PROPERTY(QStringList types READ types WRITE setTypes)
    Q_PROPERTY(quint32 stateNumber READ stateNumber WRITE setStateNumber)
    Q_PROPERTY(int resultsAvailable READ resultsAvailable)

    Q_PROPERTY(quint32 startingStateNumber READ startingStateNumber)
    Q_PROPERTY(quint32 currentStateNumber READ currentStateNumber)

public:
    ~JsonDbChangesSince();

    quint32 startingStateNumber() const;
    quint32 currentStateNumber() const;

    QStringList types() const;
    void setTypes(const QStringList &types);

    quint32 stateNumber() const;
    void setStateNumber(quint32 stateNumber);

#ifdef qdoc
    int requestId() const;
    bool isFinished() const;
Q_SIGNALS:
    void started();
    void resultsReady(int resultsAvailable);
    void finished();
    void error(JsonDbError::ErrorCode code, const QString &message);
public Q_SLOTS:
    QVariantList takeResults();
#endif

public Q_SLOTS:
    virtual void start();

private:
    JsonDbChangesSince(JsonDbClient *client, QObject *parent = 0);

    Q_DECLARE_PRIVATE(JsonDbChangesSince)
    Q_PRIVATE_SLOT(d_func(), void _q_response(int,QVariant))
    Q_PRIVATE_SLOT(d_func(), void _q_error(int,int,QString))
    Q_PRIVATE_SLOT(d_func(), void _q_emitMoreData())
    friend class JsonDbClient;
};

QT_END_NAMESPACE_JSONDB

QT_END_HEADER

#endif // JSONDB_QUERY_H