/usr/include/nepomuk/result.h is in kdelibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 215 216 217 218 219 220 221 | /*
This file is part of the Nepomuk KDE project.
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 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_RESULT_H_
#define _NEPOMUK_QUERY_RESULT_H_
#include <QtCore/QSharedDataPointer>
#include <QtCore/QUrl>
#include <QtCore/QList>
#include <QtCore/QHash>
#include <Soprano/Statement>
#include <Soprano/BindingSet>
#include "nepomukquery_export.h"
namespace Nepomuk {
class Resource;
class Variant;
namespace Types {
class Property;
}
namespace Query {
/**
* \class Result result.h Nepomuk/Query/Result
*
* \brief A single search result.
*
* A search via QueryServiceClient returns a set of Result object. A result consists
* of a Nepomuk::Resource and an optional score.
*
* Additional bindings (variable values) as requested via ComparisonTerm::setVariableName()
* can be retrieved using additionalBinding().
*
* \author Sebastian Trueg <trueg@kde.org>
*
* \since 4.4
*/
class NEPOMUKQUERY_EXPORT Result
{
public:
/**
* Create an empty result.
*/
Result();
/**
* Create a new result.
*
* \param resource The result resource.
* \param score The optional result score.
*/
Result( const Nepomuk::Resource& resource, double score = 0.0 );
/**
* Copy constructor.
*/
Result( const Result& );
/**
* Destructor
*/
~Result();
/**
* Assignment operator
*/
Result& operator=( const Result& );
/**
* The score of the result. By default the value is 0.0
* which means no score.
*
* Be aware that scoring needs to be enabled via Query::setFullTextScoringEnabled()
* in order for this value to be filled.
*
* \sa setScore
*/
double score() const;
/**
* The result resource.
*/
Resource resource() const;
/**
* Set the score of the result.
*
* Normally there is no need to call this method as the query service
* does set the bindings.
*
* \sa score
*/
void setScore( double score );
/**
* Add the value of a request property.
*
* \sa Query::RequestProperty
*/
void addRequestProperty( const Types::Property& property, const Soprano::Node& value );
/**
* Retrieve the values of the request properties.
*
* \sa Query::RequestProperty
*/
QHash<Types::Property, Soprano::Node> requestProperties() const;
/**
* Retrieve value of request property \p property.
*
* \sa requestProperties, addRequestProperty
*/
Soprano::Node operator[]( const Types::Property& property ) const;
/**
* Retrieve value of request property \p property.
*
* \sa additionalBinding, requestProperties, addRequestProperty
*/
Soprano::Node requestProperty( const Types::Property& property ) const;
/**
* Set the additional bindings a query returned besides the result
* itself and the request properties.
*
* Normally there is no need to call this method as the query service
* does set the bindings.
*
* \since 4.5
*/
void setAdditionalBindings( const Soprano::BindingSet& bindings );
/**
* Retrieve the set of additional bindings as set via setAdditionalBindings().
* Normally one would use additionalBinding() instead.
*
* \since 4.5
*/
Soprano::BindingSet additionalBindings() const;
/**
* Retrieve an additional binding as returned by the query. Typically
* these bindings are created via ComparisonTerm::setVariableName().
* But they could also stem from custom SPARQL queries. A simple
* example would be:
*
* \code
* select ?r ?rating where { ?r nao:numericRating ?rating . }
* \endcode
*
* Here \p ?r would be used as the result's resource while
* \p ?rating could be accessed via
*
* \code
* additionalBinding( QLatin1String("rating") );
* \endcode
*
* If for some reason one needs the plain binding values one
* could use additionalBinding().
*
* \since 4.5
*/
Variant additionalBinding( const QString& name ) const;
/**
* Set the excerpt from the query.
*
* Normally there is no need to call this method as the query service
* does set the excerpt.
*
* \since 4.6
*/
void setExcerpt( const QString& text );
/**
* An excerpt of the matched text with highlighted search words
* in case the query contained a full text matching.
*
* \return A rich-text snippet highlighting the search words or
* and empty string if the query did not contain any full text
* search terms.
*
* \sa LiteralTerm
*
* \since 4.6
*/
QString excerpt() const;
/**
* Comparison operator
*/
bool operator==( const Result& ) const;
private:
class Private;
QSharedDataPointer<Private> d;
};
}
}
#endif
|