xapian-core/api/document.cc

   1 /** @file
   2  * @brief Class representing a document
   3  */
   4 /* Copyright 2008,2017,2018,2024 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 #include <config.h>
  22
  23 #include "xapian/document.h"
  24
  25 #include <string>
  26 #include <string_view>
  27
  28 #include "backends/documentinternal.h"
  29 #include "net/serialise.h"
  30 #include "str.h"
  31
  32 #include "xapian/error.h"
  33
  34 using namespace std;
  35
  36 [[noreturn]]
  37 static void
  38 throw_invalid_arg_empty_term()
  39 {
  40     throw Xapian::InvalidArgumentError("Empty termnames are invalid");
  41 }
  42
  43 namespace Xapian {
  44
  45 Document::Document(Document::Internal* internal_)
  46     : internal(internal_)
  47 {
  48 }
  49
  50 Document::Document(const Document&) = default;
  51
  52 Document&
  53 Document::operator=(const Document&) = default;
  54
  55 Document::Document(Document&&) = default;
  56
  57 Document&
  58 Document::operator=(Document&&) = default;
  59
  60 Document::Document() : internal(new Xapian::Document::Internal)
  61 {
  62 }
  63
  64 Document::~Document()
  65 {
  66 }
  67
  68 Xapian::docid
  69 Document::get_docid() const
  70 {
  71     return internal->get_docid();
  72 }
  73
  74 string
  75 Document::get_data() const
  76 {
  77     return internal->get_data();
  78 }
  79
  80 void
  81 Document::set_data(string_view data)
  82 {
  83     internal->set_data(data);
  84 }
  85
  86 void
  87 Document::add_term(string_view term, Xapian::termcount wdf_inc)
  88 {
  89     if (term.empty()) {
  90         throw_invalid_arg_empty_term();
  91     }
  92     internal->add_term(term, wdf_inc);
  93 }
  94
  95 void
  96 Document::remove_term(string_view term)
  97 {
  98     if (term.empty()) {
  99         throw_invalid_arg_empty_term();
 100     }
 101     if (!internal->remove_term(term)) {
 102         string m;
 103         m = "Document::remove_term() failed - term '";
 104         m += term;
 105         m += "' not present";
 106         throw Xapian::InvalidArgumentError(m);
 107     }
 108 }
 109
 110 void
 111 Document::add_posting(string_view term,
 112                       Xapian::termpos term_pos,
 113                       Xapian::termcount wdf_inc)
 114 {
 115     if (term.empty()) {
 116         throw_invalid_arg_empty_term();
 117     }
 118     internal->add_posting(term, term_pos, wdf_inc);
 119 }
 120
 121 void
 122 Document::remove_posting(string_view term,
 123                          Xapian::termpos term_pos,
 124                          Xapian::termcount wdf_dec)
 125 {
 126     if (term.empty()) {
 127         throw_invalid_arg_empty_term();
 128     }
 129     auto res = internal->remove_posting(term, term_pos, wdf_dec);
 130     if (res != Document::Internal::OK) {
 131         string m = "Document::remove_posting() failed - term '";
 132         m += term;
 133         if (res == Document::Internal::NO_TERM) {
 134             m += "' not present";
 135         } else {
 136             m += "' not present at position ";
 137             m += str(term_pos);
 138         }
 139         throw Xapian::InvalidArgumentError(m);
 140     }
 141 }
 142
 143 Xapian::termpos
 144 Document::remove_postings(string_view term,
 145                           Xapian::termpos term_pos_first,
 146                           Xapian::termpos term_pos_last,
 147                           Xapian::termcount wdf_dec)
 148 {
 149     if (term.empty()) {
 150         throw_invalid_arg_empty_term();
 151     }
 152     if (rare(term_pos_first > term_pos_last)) {
 153         return 0;
 154     }
 155     Xapian::termpos n_removed;
 156     auto res = internal->remove_postings(term, term_pos_first, term_pos_last,
 157                                          wdf_dec, n_removed);
 158     if (res != Document::Internal::OK) {
 159         string m = "Document::remove_postings() failed - term '";
 160         m += term;
 161         m += "' not present";
 162         throw Xapian::InvalidArgumentError(m);
 163     }
 164     return n_removed;
 165 }
 166
 167 void
 168 Document::clear_terms()
 169 {
 170     internal->clear_terms();
 171 }
 172
 173 Xapian::termcount
 174 Document::termlist_count() const {
 175     return internal->termlist_count();
 176 }
 177
 178 TermIterator
 179 Document::termlist_begin() const
 180 {
 181     return TermIterator(internal->open_term_list());
 182 }
 183
 184 string
 185 Document::get_value(Xapian::valueno slot) const
 186 {
 187     return internal->get_value(slot);
 188 }
 189
 190 void
 191 Document::add_value(Xapian::valueno slot, string_view value)
 192 {
 193     internal->add_value(slot, value);
 194 }
 195
 196 void
 197 Document::clear_values()
 198 {
 199     internal->clear_values();
 200 }
 201
 202 Xapian::valueno
 203 Document::values_count() const {
 204     return internal->values_count();
 205 }
 206
 207 ValueIterator
 208 Document::values_begin() const
 209 {
 210     return internal->values_begin();
 211 }
 212
 213 string
 214 Document::serialise() const
 215 {
 216     return serialise_document(*this);
 217 }
 218
 219 Document
 220 Document::unserialise(string_view serialised)
 221 {
 222     return unserialise_document(serialised);
 223 }
 224
 225 string
 226 Document::get_description() const
 227 {
 228     return internal->get_description();
 229 }
 230
 231 }