xapian-core/backends/multi/multi_termlist.h

   1 /** @file multi_termlist.h
   2  * @brief C++ class declaration for multiple database access
   3  */
   4 /* Copyright 1999,2000,2001 BrightStation PLC
   5  * Copyright 2002,2003,2004,2005,2006,2007,2010,2011 Olly Betts
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  20  * USA
  21  */
  22
  23 #ifndef OM_HGUARD_MULTI_TERMLIST_H
  24 #define OM_HGUARD_MULTI_TERMLIST_H
  25
  26 #include "api/termlist.h"
  27 #include "backends/database.h"
  28
  29 class MultiTermList : public TermList {
  30     friend class Xapian::Database;
  31     private:
  32         TermList *tl;
  33         const Xapian::Database & db;
  34         size_t db_index;
  35         double termfreq_factor;
  36
  37         MultiTermList(TermList * tl_,
  38                       const Xapian::Database &db_,
  39                       size_t db_index_);
  40     public:
  41         Xapian::termcount get_approx_size() const;
  42
  43         /// Collate weighting information for the current term.
  44         void accumulate_stats(Xapian::Internal::ExpandStats & stats) const;
  45
  46         string get_termname() const;
  47         Xapian::termcount get_wdf() const; // Number of occurrences of term in current doc
  48         Xapian::doccount get_termfreq() const;  // Number of docs indexed by term
  49         TermList * next();
  50         TermList * skip_to(const std::string & term);
  51         bool at_end() const;
  52
  53         Xapian::termcount positionlist_count() const;
  54
  55         Xapian::PositionIterator positionlist_begin() const;
  56
  57         ~MultiTermList();
  58 };
  59
  60 #endif /* OM_HGUARD_MULTI_TERMLIST_H */