/usr/include/soprano/statementiterator.h is in libsoprano-dev 2.9.4+dfsg1-0ubuntu4.
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 | /*
* This file is part of Soprano Project.
*
* Copyright (C) 2006 Daniele Galdi <daniele.galdi@gmail.com>
* Copyright (C) 2007 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_STATEMENT_ITERATOR_H
#define SOPRANO_STATEMENT_ITERATOR_H
#include "iterator.h"
#include "statement.h"
#include "soprano_export.h"
#include <QtCore/QList>
namespace Soprano {
class Node;
class NodeIterator;
class Statement;
class StatementIteratorBackend;
/**
* \class StatementIterator statementiterator.h Soprano/StatementIterator
*
* \brief An iterator that provides a stream of Statements.
*
* The most common use of StatementIterator is through Model::listStatements().
*
* Many backends do lock the underlying Model during iteration. Thus,
* it is always a good idea to cache the results if they are to be used
* to modify the model to prevent a deadlock:
*
* \code
* Soprano::StatementIterator it = model->listStatements();
* QList<Statement> allStatements = it.allElements();
* Q_FOREACH( Soprano::Statement s, allStatements ) {
* modifyTheModel( model, s );
* }
* \endcode
*
* Iterators have to be closed.
* This can either be achieved by deleting the iterator, finishing it (next() does return \p false),
* or calling close(). Before that other operations on the Model may block.
*
* Iterators are not thread-safe. Two threads using the same iterator may result
* in undefined behaviour and even crashes. An iterator needs to be closed by the
* same thread that opened it (except if the iterator contains special code to handle such
* a situation.)
*
* \warning Be aware that iterators in Soprano are shared objects which means
* that copies of one iterator object work on the same data.
*
* For further details on %Soprano iterators see Iterator.
*
* \author Daniele Galdi <daniele.galdi@gmail.com><br>Sebastian Trueg <trueg@kde.org>
*/
class SOPRANO_EXPORT StatementIterator : public Iterator<Statement>
{
public:
/**
* Creates and empty, invalid iterator.
*/
StatementIterator();
/**
* Create a new StatementIterator instance that uses sti as backend.
* StatementIterator will take ownership of the backend.
*/
StatementIterator( IteratorBackend<Statement> *sti );
StatementIterator( const StatementIterator &sti );
virtual ~StatementIterator();
StatementIterator& operator=( const StatementIterator& );
/**
* Convenience method which extracts all statements (this does not include the
* statements that have already been read from the iterator) from the iterator
* and returns them in a list.
*
* Be aware that after calling this method the iterator will be invalid.
*
* \return A list of all statements that rest in the iterator.
*/
QList<Statement> allStatements() { return allElements(); }
/**
* Convenience method that creates an iterator over the subject nodes of the statements
* in this iterator.
*
* \warning The new iterator is just a wrapper around this one. Thus, changing it will also
* change this one.
*
* \return A wrapper iterator over the subject nodes.
*/
NodeIterator iterateSubjects() const;
/**
* Convenience method that creates an iterator over the predicate nodes of the statements
* in this iterator.
*
* \warning The new iterator is just a wrapper around this one. Thus, changing it will also
* change this one.
*
* \return A wrapper iterator over the predicate nodes.
*/
NodeIterator iteratePredicates() const;
/**
* Convenience method that creates an iterator over the object nodes of the statements
* in this iterator.
*
* \warning The new iterator is just a wrapper around this one. Thus, changing it will also
* change this one.
*
* \return A wrapper iterator over the object nodes.
*/
NodeIterator iterateObjects() const;
/**
* Convenience method that creates an iterator over the context nodes of the statements
* in this iterator.
*
* \warning The new iterator is just a wrapper around this one. Thus, changing it will also
* change this one.
*
* \return A wrapper iterator over the context nodes.
*/
NodeIterator iterateContexts() const;
};
}
#endif // SOPRANO_STATEMENT_ITERATOR_H
|