queryserviceclient.h

Go to the documentation of this file.

/*
   Copyright (c) 2008-2010 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) version 3, or any
   later version accepted by the membership of KDE e.V. (or its
   successor approved by the membership of KDE e.V.), which shall
   act as a proxy defined in Section 6 of version 3 of the license.

   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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _NEPOMUK_QUERY_SERVICE_CLIENT_H_
#define _NEPOMUK_QUERY_SERVICE_CLIENT_H_

#include <QtCore/QObject>

#include "property.h"
#include "query.h"

#include "nepomukquery_export.h"

class QUrl;

namespace Nepomuk {
    namespace Query {

        class Result;

        class NEPOMUKQUERY_EXPORT QueryServiceClient : public QObject
        {
            Q_OBJECT

        public:
            QueryServiceClient( QObject* parent = 0 );

            ~QueryServiceClient();

            static bool serviceAvailable();

            static QList<Nepomuk::Query::Result> syncQuery( const Query& query, bool *ok = 0 );

            static QList<Nepomuk::Query::Result> syncSparqlQuery( const QString& query,
                            const Nepomuk::Query::RequestPropertyMap& requestPropertyMap = Nepomuk::Query::RequestPropertyMap(),
                            bool *ok = 0 );

            static QList<Nepomuk::Query::Result> syncDesktopQuery( const QString& query, bool *ok = 0 );

        public Q_SLOTS:
            bool query( const Query& query );

            bool sparqlQuery( const QString& query, const Nepomuk::Query::RequestPropertyMap& requestPropertyMap = Nepomuk::Query::RequestPropertyMap() );

            bool desktopQuery( const QString& query );

            bool blockingQuery( const Query& query );

            bool blockingSparqlQuery( const QString& query, const Nepomuk::Query::RequestPropertyMap& requestPropertyMap = Nepomuk::Query::RequestPropertyMap() );

            bool blockingDesktopQuery( const QString& query );

            void close();

            bool isListingFinished() const;

            QString errorMessage() const;

        Q_SIGNALS:
            void newEntries( const QList<Nepomuk::Query::Result>& entries );

            void entriesRemoved( const QList<QUrl>& entries );

            void resultCount( int count );

            void finishedListing();

            void error( const QString& errorMessage );

            void serviceAvailabilityChanged( bool running );

        private:
            class Private;
            Private* const d;

            Q_PRIVATE_SLOT( d, void _k_entriesRemoved( const QStringList& ) )
            Q_PRIVATE_SLOT( d, void _k_finishedListing() )
            Q_PRIVATE_SLOT( d, void _k_handleQueryReply(QDBusPendingCallWatcher*) )
            Q_PRIVATE_SLOT( d, void _k_serviceRegistered( const QString& ) )
            Q_PRIVATE_SLOT( d, void _k_serviceUnregistered( const QString& ) )
        };
    }
}

#endif