enquire.h

Go to the documentation of this file.

 
/* Copyright (C) 2005,2013,2016,2017,2024 Olly Betts
 * Copyright (C) 2009 Lemur Consulting Ltd
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef XAPIAN_INCLUDED_ENQUIRE_H
#define XAPIAN_INCLUDED_ENQUIRE_H
 
#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error Never use <xapian/enquire.h> directly; include <xapian.h> instead.
#endif
 
#include <string>
 
#include <xapian/attributes.h>
#include <xapian/eset.h>
#include <xapian/intrusive_ptr.h>
#include <xapian/mset.h>
#include <xapian/types.h>
#include <xapian/termiterator.h>
#include <xapian/visibility.h>
 
namespace Xapian {
 
// Forward declarations of classes referenced below.
class Database;
class ExpandDecider;
class KeyMaker;
class MatchDecider;
class MatchSpy;
class Query;
class RSet;
class Weight;
 
class XAPIAN_VISIBILITY_DEFAULT Enquire {
  public:
    class Internal;
    Xapian::Internal::intrusive_ptr_nonnull<Internal> internal;
 
    Enquire(const Enquire& o);
 
    Enquire& operator=(const Enquire& o);
 
    Enquire(Enquire&& o);
 
    Enquire& operator=(Enquire&& o);
 
    explicit
    Enquire(const Database& db);
 
    ~Enquire();
 
    void set_query(const Query& query, termcount query_length = 0);
 
    const Query& get_query() const;
 
    void set_weighting_scheme(const Weight& weight);
 
    typedef enum {
        ASCENDING = 1,
        DESCENDING = 0,
        DONT_CARE = 2
    } docid_order;
 
    void set_docid_order(docid_order order);
 
    void set_sort_by_relevance();
 
    void set_sort_by_value(valueno sort_key, bool reverse);
 
    void set_sort_by_key(KeyMaker* sorter,
                         bool reverse) XAPIAN_NONNULL();
 
    void set_sort_by_value_then_relevance(valueno sort_key, bool reverse);
 
    void set_sort_by_key_then_relevance(KeyMaker* sorter,
                                        bool reverse) XAPIAN_NONNULL();
 
    void set_sort_by_relevance_then_value(valueno sort_key, bool reverse);
 
    void set_sort_by_relevance_then_key(KeyMaker* sorter,
                                        bool reverse) XAPIAN_NONNULL();
 
    void set_collapse_key(valueno collapse_key, doccount collapse_max = 1);
 
    void set_cutoff(int percent_threshold, double weight_threshold = 0);
 
    void add_matchspy(MatchSpy* spy) XAPIAN_NONNULL();
 
    void clear_matchspies();
 
    void set_time_limit(double time_limit);
 
    MSet get_mset(doccount first,
                  doccount maxitems,
                  doccount checkatleast = 0,
                  const RSet* rset = NULL,
                  const MatchDecider* mdecider = NULL) const;
 
    MSet get_mset(doccount first,
                  doccount maxitems,
                  const RSet* rset,
                  const MatchDecider* mdecider = NULL) const {
        return get_mset(first, maxitems, 0, rset, mdecider);
    }
 
    TermIterator get_matching_terms_begin(docid did) const;
 
    TermIterator get_matching_terms_begin(const MSetIterator& it) const {
        return get_matching_terms_begin(*it);
    }
 
    TermIterator get_matching_terms_end(docid) const noexcept {
        return TermIterator();
    }
 
    TermIterator get_matching_terms_end(const MSetIterator&) const noexcept {
        return TermIterator();
    }
 
    void set_expansion_scheme(std::string_view eweightname,
                              double expand_k = 1.0) const;
 
    static const int INCLUDE_QUERY_TERMS = 1;
 
    static const int USE_EXACT_TERMFREQ = 2;
 
    ESet get_eset(termcount maxitems,
                  const RSet& rset,
                  int flags = 0,
                  const ExpandDecider* edecider = NULL,
                  double min_weight = 0.0) const;
 
    ESet get_eset(termcount maxitems,
                  const RSet& rset,
                  const ExpandDecider* edecider) const {
        return get_eset(maxitems, rset, 0, edecider);
    }
 
    std::string get_description() const;
};
 
}
 
#endif // XAPIAN_INCLUDED_ENQUIRE_H