xapian-core/api/documentvaluelist.h

   1 /** @file documentvaluelist.h
   2  * @brief Iteration over values in a document.
   3  */
   4 /* Copyright (C) 2007,2008,2009,2011,2017 Olly Betts
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef XAPIAN_INCLUDED_DOCUMENTVALUELIST_H
  22 #define XAPIAN_INCLUDED_DOCUMENTVALUELIST_H
  23
  24 #include "backends/valuelist.h"
  25
  26 #include "backends/documentinternal.h"
  27
  28 #include <map>
  29
  30 /// Iteration over values in a document.
  31 class DocumentValueList : public ValueList {
  32     /// Don't allow assignment.
  33     void operator=(const DocumentValueList &);
  34
  35     /// Don't allow copying.
  36     DocumentValueList(const DocumentValueList &);
  37
  38     /// Document internals we're iterating over.
  39     Xapian::Internal::intrusive_ptr<const Xapian::Document::Internal> doc;
  40
  41     /** Iterator over the map inside @a doc.
  42      *
  43      *  If we haven't started yet, this will be set to: doc->values.end()
  44      */
  45     std::map<Xapian::valueno, std::string>::const_iterator it;
  46
  47   public:
  48     explicit DocumentValueList(const Xapian::Document::Internal* doc_)
  49         : doc(doc_), it(doc->values->end()) { }
  50
  51     Xapian::docid get_docid() const;
  52
  53     std::string get_value() const;
  54
  55     Xapian::valueno get_valueno() const;
  56
  57     bool at_end() const;
  58
  59     void next();
  60
  61     /// The parameter is actually a Xapian::valueno for this subclass.
  62     void skip_to(Xapian::docid slot);
  63
  64     std::string get_description() const;
  65 };
  66
  67 #endif // XAPIAN_INCLUDED_DOCUMENTVALUELIST_H