File indexing completed on 2024-04-21 03:51:41

0001 /*
0002     SPDX-FileCopyrightText: 2015 Vishesh Handa <vhanda@kde.org>
0003 
0004     SPDX-License-Identifier: LGPL-2.1-or-later
0005 */
0006 
0007 #ifndef BALOO_POSTINGITERATOR_H
0008 #define BALOO_POSTINGITERATOR_H
0009 
0010 #include <QVector>
0011 #include "engine_export.h"
0012 
0013 namespace Baloo {
0014 
0015 /**
0016  * A PostingIterator is an abstract base class which can be used to iterate
0017  * over all the "postings" or "documents" which are particular term appears.
0018  *
0019  * All PostingIterators should iterate over a list of non-decreasing document ids.
0020  */
0021 class BALOO_ENGINE_EXPORT PostingIterator
0022 {
0023 public:
0024     virtual ~PostingIterator();
0025 
0026     virtual quint64 next() = 0;
0027     virtual quint64 docId() const = 0;
0028     virtual quint64 skipTo(quint64 docId);
0029 };
0030 }
0031 
0032 #endif // BALOO_POSTINGITERATOR_H