xapian-core/api/omenquireinternal.h

   1 /** @file omenquireinternal.h
   2  * @brief Internals
   3  */
   4 /* Copyright 1999,2000,2001 BrightStation PLC
   5  * Copyright 2001,2002 Ananova Ltd
   6  * Copyright 2002,2003,2004,2005,2006,2007,2008,2009,2010,2011,2014,2015,2016 Olly Betts
   7  * Copyright 2009 Lemur Consulting Ltd
   8  * Copyright 2011 Action Without Borders
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as
  12  * published by the Free Software Foundation; either version 2 of the
  13  * License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  23  * USA
  24  */
  25
  26 #ifndef OM_HGUARD_OMENQUIREINTERNAL_H
  27 #define OM_HGUARD_OMENQUIREINTERNAL_H
  28
  29 #include "xapian/database.h"
  30 #include "xapian/document.h"
  31 #include "xapian/enquire.h"
  32 #include "xapian/query.h"
  33 #include "xapian/rset.h"
  34 #include "xapian/keymaker.h"
  35
  36 #include <algorithm>
  37 #include <cmath>
  38 #include <unordered_map>
  39
  40 #include "result.h"
  41 #include "weight/weightinternal.h"
  42
  43 using namespace std;
  44
  45 class OmExpand;
  46 class MultiMatch;
  47
  48 namespace Xapian {
  49
  50 class TermIterator;
  51
  52 /** Internals of enquire system.
  53  *  This allows the implementation of Xapian::Enquire to be hidden and reference
  54  *  counted.
  55  */
  56 class Enquire::Internal : public Xapian::Internal::intrusive_base {
  57     friend class MSet::Internal;
  58     private:
  59         /// The database which this enquire object uses.
  60         const Xapian::Database db;
  61
  62         /// The user's query.
  63         Query query;
  64
  65         /// The query length.
  66         termcount qlen;
  67
  68         /// Copy not allowed
  69         Internal(const Internal &);
  70         /// Assignment not allowed
  71         void operator=(const Internal &);
  72
  73     public:
  74         typedef enum { REL, VAL, VAL_REL, REL_VAL } sort_setting;
  75
  76         Xapian::valueno collapse_key;
  77
  78         Xapian::doccount collapse_max;
  79
  80         Xapian::Enquire::docid_order order;
  81
  82         int percent_cutoff;
  83
  84         double weight_cutoff;
  85
  86         Xapian::valueno sort_key;
  87         sort_setting sort_by;
  88         bool sort_value_forward;
  89
  90         Xapian::Internal::opt_intrusive_ptr<KeyMaker> sorter;
  91
  92         double time_limit;
  93
  94         /** The weight to use for this query.
  95          *
  96          *  This is mutable so that the default BM25Weight object can be
  97          *  created lazily when first required.
  98          */
  99         mutable Weight * weight;
 100
 101         /// The weighting scheme to use for query expansion.
 102         std::string eweightname;
 103
 104         /// The parameter required for TradWeight query expansion.
 105         double expand_k;
 106
 107         vector<Xapian::Internal::opt_intrusive_ptr<MatchSpy>> spies;
 108
 109         explicit Internal(const Xapian::Database &databases);
 110         ~Internal();
 111
 112         /** Request a document from the database.
 113          */
 114         void request_doc(Xapian::docid did) const;
 115
 116         Xapian::Document get_document(Xapian::docid did) const;
 117
 118         void set_query(const Query & query_, termcount qlen_);
 119         const Query & get_query() const;
 120         MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems,
 121                       Xapian::doccount check_at_least,
 122                       const RSet *omrset,
 123                       const MatchDecider *mdecider) const;
 124
 125         ESet get_eset(Xapian::termcount maxitems, const RSet & omrset, int flags,
 126                       const ExpandDecider *edecider, double min_wt) const;
 127
 128         TermIterator get_matching_terms(Xapian::docid did) const;
 129         TermIterator get_matching_terms(const Xapian::MSetIterator &it) const;
 130
 131         Xapian::doccount get_termfreq(const string &tname) const;
 132
 133         string get_description() const;
 134 };
 135
 136 }
 137
 138 #endif // OM_HGUARD_OMENQUIREINTERNAL_H