runtime/nepomuk/libnepomukquery/query.h

   1 /*
   2    This file is part of the Nepomuk KDE project.
   3    Copyright (C) 2008 Sebastian Trueg <trueg@kde.org>
   4
   5    This library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public
   7    License version 2 as published by the Free Software Foundation.
   8
   9    This library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public License
  15    along with this library; see the file COPYING.LIB.  If not, write to
  16    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17    Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef _NEPOMUK_SEARCH_QUERY_H_
  21 #define _NEPOMUK_SEARCH_QUERY_H_
  22
  23 #include <QtCore/QSharedDataPointer>
  24 #include <QtCore/QList>
  25 #include <QtCore/QPair>
  26 #include <QtCore/QDebug>
  27
  28 #include <nepomuk/nepomuk_export.h>
  29
  30 class QUrl;
  31
  32 namespace Nepomuk {
  33     namespace Search {
  34
  35         class Term;
  36
  37         /**
  38          * \class Query query.h nepomuk/query.h
  39          *
  40          * \brief A Nepomuk desktop query.
  41          *
  42          * A query can either be based on Term or a more complex
  43          * SPARQL query.
  44          *
  45          * \author Sebastian Trueg <trueg@kde.org>
  46          */
  47         class NEPOMUK_EXPORT Query
  48         {
  49         public:
  50             enum Type {
  51                 InvalidQuery,
  52                 PlainQuery,
  53                 SPARQLQuery
  54             };
  55
  56             /**
  57              * Create an empty invalid query object.
  58              */
  59             Query();
  60
  61             /**
  62              * Create a query of type PlainQuery based on
  63              * \a term.
  64              */
  65             Query( const Term& term );
  66
  67             /**
  68              * Create a SPARQL query. The query has to have one select variable called "?r"
  69              */
  70             explicit Query( const QString& sparqlQuery );
  71
  72             /**
  73              * Copy constructor.
  74              */
  75             Query( const Query& );
  76
  77             /**
  78              * Destructor
  79              */
  80             ~Query();
  81
  82             /**
  83              * Assignment operator
  84              */
  85             Query& operator=( const Query& );
  86
  87             Type type() const;
  88             Term term() const;
  89             QString sparqlQuery() const;
  90             int limit() const;
  91
  92             void setTerm( const Term& );
  93             void setSparqlQuery( const QString& );
  94             void setLimit( int );
  95
  96             /**
  97              * Add a property that should be reported with each search result.
  98              * \param property The requested property.
  99              * \param optional If \p true the property is optional, meaning it can
 100              *        be empty ins earch results.
 101              */
 102             void addRequestProperty( const QUrl& property, bool optional = true );
 103             void clearRequestProperties();
 104
 105             typedef QPair<QUrl, bool> RequestProperty;
 106
 107             QList<RequestProperty> requestProperties() const;
 108
 109             bool operator==( const Query& ) const;
 110
 111         private:
 112             class Private;
 113             QSharedDataPointer<Private> d;
 114         };
 115
 116         NEPOMUK_EXPORT uint qHash( const Nepomuk::Search::Query& );
 117     }
 118 }
 119
 120 NEPOMUK_EXPORT QDebug operator<<( QDebug, const Nepomuk::Search::Query& );
 121
 122 #endif