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
|
/*
Copyright (c) 2008 Sebastian Trueg <trueg@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _NEPOMUK_QUERY_SERVICE_CLIENT_H_
#define _NEPOMUK_QUERY_SERVICE_CLIENT_H_
#include <QtCore/QObject>
#include <QtCore/QHash>
class QUrl;
namespace Nepomuk {
namespace Query {
class Result;
/**
* \class QueryServiceClient queryserviceclient.h Nepomuk/Search/QueryServiceClient
*
* \brief Convenience frontend to the %Nepomuk Query DBus Service
*
* The QueryServiceClient provides an easy way to access the %Nepomuk Query Service
* without having to deal with any communication details. By default it monitors
* queries for changes.
*
* Usage is simple: Create an instance of the client for each search you want to
* track. Once instance may also be reused for subsequent queries if further updates
* of the persistent query are not necessary.
*
* \author Sebastian Trueg <trueg@kde.org>
*/
class QueryServiceClient : public QObject
{
Q_OBJECT
public:
/**
* Create a new QueryServiceClient instance.
*/
QueryServiceClient( QObject* parent = 0 );
/**
* Desctructor. Closes the query.
*/
~QueryServiceClient();
/**
* Check if the service is running.
* \return \p true if the Nepomuk query service is running and could
* be contacted via DBus, \p false otherwise
*/
static bool serviceAvailable();
public Q_SLOTS:
/**
* Start a query using the Nepomuk user query language.
*
* Results will be reported via newEntries. All results
* have been reported once finishedListing has been emitted.
*
* \return \p true if the query service was found and the query
* was started. \p false otherwise.
*
* \sa QueryParser
*/
bool query( const QString& query, const QHash<QString, QString> &encodedRps = QHash<QString, QString>() );
/**
* Start a query using the Nepomuk user query language.
*
* Results will be reported as with query(const QString&)
* but a local event loop will be started to block the method
* call until all results have been listed.
*
* The client will be closed after the initial listing. Thus,
* changes to results will not be reported as it is the case
* with the non-blocking methods.
*
* \return \p true if the query service was found and the query
* was started. \p false otherwise.
*
* \sa query(const QString&), close()
*/
bool blockingQuery( const QString& query, const QHash<QString, QString> &encodedRps = QHash<QString, QString>() );
/**
* Close the client, thus stop to monitor the query
* for changes. Without closing the client it will continue
* signalling changes to the results.
*
* This will also make any blockingQuery return immediately.
*/
void close();
Q_SIGNALS:
/**
* Emitted for new search results. This signal is emitted both
* for the initial listing and for changes to the search.
*/
void newEntries( const QList<Nepomuk::Query::Result>& entries );
/**
* Emitted if the search results changed when monitoring a query.
* \param entries A list of resource URIs identifying the resources
* that dropped out of the query results.
*/
void entriesRemoved( const QList<Nepomuk::Query::Result>& entries );
/**
* Emitted when the initial listing has been finished, ie. if all
* results have been reported via newEntries. If no further updates
* are necessary the client should be closed now.
*/
void finishedListing();
private:
class Private;
Private* const d;
Q_PRIVATE_SLOT( d, void _k_finishedListing() )
};
}
}
#endif
|