document.h

Go to the documentation of this file.

 
/* Copyright (C) 2010,2015,2016,2017,2018,2019,2023,2024 Olly Betts
 * Copyright 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_DOCUMENT_H
#define XAPIAN_INCLUDED_DOCUMENT_H
 
#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error Never use <xapian/document.h> directly; include <xapian.h> instead.
#endif
 
#include <string>
#include <string_view>
 
#include <xapian/attributes.h>
#include <xapian/intrusive_ptr.h>
#include <xapian/termiterator.h>
#include <xapian/types.h>
#include <xapian/valueiterator.h>
#include <xapian/visibility.h>
 
namespace Xapian {
 
class XAPIAN_VISIBILITY_DEFAULT Document {
  public:
    class Internal;
    Xapian::Internal::intrusive_ptr_nonnull<Internal> internal;
 
    XAPIAN_VISIBILITY_INTERNAL
    explicit Document(Internal*);
 
    Document(const Document& o);
 
    Document& operator=(const Document& o);
 
    Document(Document&& o);
 
    Document& operator=(Document&& o);
 
    Document();
 
    ~Document();
 
    Xapian::docid get_docid() const;
 
    std::string get_data() const;
 
    void set_data(std::string_view data);
 
    void add_term(std::string_view term, Xapian::termcount wdf_inc = 1);
 
    void add_boolean_term(std::string_view term) { add_term(term, 0); }
 
    void remove_term(std::string_view term);
 
    void add_posting(std::string_view term,
                     Xapian::termpos term_pos,
                     Xapian::termcount wdf_inc = 1);
 
    void remove_posting(std::string_view term,
                        Xapian::termpos term_pos,
                        Xapian::termcount wdf_dec = 1);
 
    Xapian::termpos remove_postings(std::string_view term,
                                    Xapian::termpos term_pos_first,
                                    Xapian::termpos term_pos_last,
                                    Xapian::termcount wdf_dec = 1);
 
    void clear_terms();
 
    Xapian::termcount termlist_count() const;
 
    TermIterator termlist_begin() const;
 
    TermIterator termlist_end() const noexcept {
        return TermIterator();
    }
 
    std::string get_value(Xapian::valueno slot) const;
 
    void add_value(Xapian::valueno slot, std::string_view value);
 
    void remove_value(Xapian::valueno slot) {
        add_value(slot, {});
    }
 
    void clear_values();
 
    Xapian::valueno values_count() const;
 
    ValueIterator values_begin() const;
 
    ValueIterator values_end() const noexcept {
        return ValueIterator();
    }
 
    void swap(Document& o) { internal.swap(o.internal); }
 
    std::string serialise() const;
 
    static Document unserialise(std::string_view serialised);
 
    std::string get_description() const;
};
 
}
 
#endif // XAPIAN_INCLUDED_DOCUMENT_H