xapian-core/api/document.cc

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