/usr/include/soprano/asyncmodel.h is in libsoprano-dev 2.9.4+dfsg1-0ubuntu3.
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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | /*
* This file is part of Soprano Project.
*
* 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 as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* 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 _SOPRANO_ASYNC_MODEL_H_
#define _SOPRANO_ASYNC_MODEL_H_
#include "filtermodel.h"
#include "asyncresult.h" // backwards comp when AsyncResult was defined in this header
#include "soprano_export.h"
namespace Soprano {
class Statement;
class StatementIterator;
class Node;
class NodeIterator;
class QueryResultIterator;
namespace Util {
class AsyncModelPrivate;
/**
* \class AsyncModel asyncmodel.h Soprano/Server/AsyncModel
*
* \brief Filter model that allows to perform operations
* asyncroneously.
*
* AsyncModel has two modes: AsyncModel::SingleThreaded and AsyncModel::MultiThreaded.
* The main purpose of the AsyncModel::SingleThreaded mode is to protect a
* Model against deadlocks in a single threaded situation.
*
* AsyncModel::MultiThreaded mode provides real asyncroneous execution of
* Model commands.
*
* Usage:
* \code
* AsyncResult* result = model->listStatementsAsync( s );
* connect( result, SIGNAL(resultReady(AsyncResult*)),
* this, SLOT(slotResultReady(AsyncResult*)) );
* \endcode
*
* \author Sebastian Trueg <trueg@kde.org>
*
* \since 2.1
*/
class SOPRANO_EXPORT AsyncModel : public FilterModel
{
Q_OBJECT
public:
/**
* Create a new Model.
*
* \param parent The parent model to forward the operations to.
*/
AsyncModel( Model* parent = 0 );
/**
* Destructor.
*/
~AsyncModel();
/**
* The mode of the model, single vs. multi threaded execution.
*
* \since 2.2
*/
enum AsyncModelMode {
/**
* The model uses a single thread. Thus, commands are executed in the
* same thread but no two commands will ever block each other.
* This is the default mode for historical reasons.
*/
SingleThreaded,
/**
* The model uses multiple threads through QThreadPool.
* Commands are executed in parallel.
* Be aware that the parent model needs to be thread-safe.
*/
MultiThreaded
};
/**
* Set the mode to be used. For historical reasons the default mode is
* SingleThreaded.
*
* \sa mode
*
* \since 2.2
*/
void setMode( AsyncModelMode mode );
/**
* The mode used by this model.
*
* \sa setMode
*
* \since 2.2
*/
AsyncModelMode mode() const;
/**
* Asyncroneously add the Statement to the Model.
*
* \param statement The Statement to add.
*
* \sa addStatement
*
* \return an AsyncResult with result type Error::ErrorCode
* object which will signal when the result is ready.
*/
AsyncResult* addStatementAsync( const Statement& statement );
/**
* \overload
*
* \since 2.2
*/
AsyncResult* addStatementAsync( const Node& subject, const Node& predicate, const Node& object, const Node& context = Node() );
/**
* \overload
*
* \since 2.2
*/
AsyncResult* addStatementsAsync( const QList<Statement>& statements );
/**
* Asyncroneously remove one statement. For removing statements
* with wildward matching see removeAllStatementsAsync().
*
* \param statement The statement that should be removed.
* This has to be a valid statement.
*
* \sa removeStatement
*
* \return an AsyncResult with result type Error::ErrorCode
* object which will signal when the result is ready.
*/
AsyncResult* removeStatementAsync( const Statement& statement );
/**
* \overload
*
* \since 2.2
*/
AsyncResult* removeStatementAsync( const Node& subject, const Node& predicate, const Node& object, const Node& context = Node() );
/**
* \overload
*
* \since 2.2
*/
AsyncResult* removeStatementsAsync( const QList<Statement>& statements );
/**
* Asyncroneously remove all statements that match the partial statement.
* For removing one specific statement see removeStatement().
*
* \param statement A possible partially defined statement that serves as
* a filter for all statements that should be removed.
*
* \sa removeAllStatements
*
* \return an AsyncResult with result type Error::ErrorCode
* object which will signal when the result is ready.
*/
AsyncResult* removeAllStatementsAsync( const Statement& statement );
/**
* \overload
*
* \since 2.2
*/
AsyncResult* removeAllStatementsAsync( const Node& subject, const Node& predicate, const Node& object, const Node& context = Node() );
/**
* Asyncroneously check if the Model does contain any Statement.
*
* \sa isEmpty
*
* \return an AsyncResult with result type bool
* object which will signal when the result is ready.
*/
AsyncResult* isEmptyAsync() const;
/**
* Asyncroneously determine the number of statements stored in this Model.
*
* \sa statementCount
*
* \return an AsyncResult with result type int
* object which will signal when the result is ready.
*/
AsyncResult* statementCountAsync() const;
/**
* Asyncroneously return an iterator over Model Statements that "partial"
* match the input Statement.
*
* \param statement The partial Statement to match.
*
* \sa listStatements
*
* \return an AsyncResult with result type StatementIterator
* object which will signal when the result is ready.
*/
AsyncResult* listStatementsAsync( const Statement& statement ) const;
/**
* \overload
*
* \since 2.2
*/
AsyncResult* listStatementsAsync( const Node& subject, const Node& predicate, const Node& object, const Node& context = Node() ) const;
/**
* \overload
*
* Lists all statements in the Model asyncroneously.
*
* \since 2.2
*/
AsyncResult* listStatementsAsync() const;
/**
* Asyncroneously list all contexts in the model, i.e. all named graphs.
*
* \sa listContexts
*
* \return an AsyncResult with result type NodeIterator
* object which will signal when the result is ready.
*/
AsyncResult* listContextsAsync() const;
/**
* Asyncroneously execute the given query over the Model.
*
* This is a const read-only method. As such Model implementations should not
* support SPARQL extensions such as INSERT or UPDATE through this method.
* A future version of %Soprano will provide an additional API for queries
* that change the Model.
*
* \param query The query to evaluate.
* \param language The %query language used to encode \p query.
* \param userQueryLanguage If \p language equals Query::QueryLanguageUser
* userQueryLanguage defines the language to use.
*
* \sa executeQuery
*
* \return an AsyncResult with result type QueryResultIterator
* object which will signal when the result is ready.
*/
AsyncResult* executeQueryAsync( const QString& query,
Query::QueryLanguage language,
const QString& userQueryLanguage = QString() ) const;
/**
* AsyncResult check if the model contains a statements.
*
* \param statement The statement in question. This has to be a valid statement,
* i.e. subject, predicate, and object need to be defined. If the context node
* is empty the default graph is searched.
*
* \sa containsStatement
*
* \return an AsyncResult with result type bool
* object which will signal when the result is ready.
*/
AsyncResult* containsStatementAsync( const Statement& statement ) const;
/**
* \overload
*
* \since 2.2
*/
AsyncResult* containsStatementAsync( const Node& subject, const Node& predicate, const Node& object, const Node& context = Node() ) const;
/**
* Asyncroneously check if the model contains certain statements.
*
* \param statement A partially defined statement that serves as
* a pattern.
*
* \sa containsAnyStatement
*
* \return an AsyncResult with result type bool
* object which will signal when the result is ready.
*/
AsyncResult* containsAnyStatementAsync( const Statement& statement ) const;
/**
* \overload
*
* \since 2.2
*/
AsyncResult* containsAnyStatementAsync( const Node& subject, const Node& predicate, const Node& object, const Node& context = Node() ) const;
/**
* Asyncroneously create a new blank node with a unique identifier.
*
* \sa createBlankNode
*
* \return an AsyncResult with result type Node
* object which will signal when the result is ready.
*/
AsyncResult* createBlankNodeAsync();
/**
* \reimplemented
*
* The call is directly delivered to the parent model. However, the iterator is counted so that interweaving
* asyncroneous and non-asyncroneous calls does not result in unwanted behaviour.
*
* \since 2.4
*/
StatementIterator listStatements( const Statement& partial ) const;
/**
* \reimplemented
*
* The call is directly delivered to the parent model. However, the iterator is counted so that interweaving
* asyncroneous and non-asyncroneous calls does not result in unwanted behaviour.
*
* \since 2.4
*/
NodeIterator listContexts() const;
/**
* \reimplemented
*
* The call is directly delivered to the parent model. However, the iterator is counted so that interweaving
* asyncroneous and non-asyncroneous calls does not result in unwanted behaviour.
*
* \since 2.4
*/
QueryResultIterator executeQuery( const QString& query, Query::QueryLanguage language, const QString& userQueryLanguage = QString() ) const;
using FilterModel::addStatement;
using FilterModel::removeStatement;
using FilterModel::removeAllStatements;
using FilterModel::listStatements;
using FilterModel::containsStatement;
using FilterModel::containsAnyStatement;
private:
AsyncModelPrivate* const d;
Q_PRIVATE_SLOT( d, void _s_executeNextCommand() )
};
}
}
#endif
|