document.h

Go to the documentation of this file.

/* Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2002,2003,2004,2006,2007,2009,2010,2011,2012,2013,2014,2018,2023 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#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 <xapian/attributes.h>
#include <xapian/intrusive_ptr.h>
#include <xapian/types.h>
#include <xapian/termiterator.h>
#include <xapian/valueiterator.h>
#include <xapian/visibility.h>

namespace Xapian {

class XAPIAN_VISIBILITY_DEFAULT Document {
    public:
        class Internal;
        Xapian::Internal::intrusive_ptr<Internal> internal;

        explicit Document(Internal *internal_);

        Document(const Document &other);

        void operator=(const Document &other);

#ifdef XAPIAN_MOVE_SEMANTICS
        Document(Document&& o);

        Document& operator=(Document&& o);
#endif

        Document();

        ~Document();

        std::string get_value(Xapian::valueno slot) const;

        void add_value(Xapian::valueno slot, const std::string &value);

        void remove_value(Xapian::valueno slot);

        void clear_values();

        std::string get_data() const;

        void set_data(const std::string &data);

        void add_posting(const std::string & tname,
                         Xapian::termpos tpos,
                         Xapian::termcount wdfinc = 1);

        void add_term(const std::string & tname, Xapian::termcount wdfinc = 1);

        void add_boolean_term(const std::string & term) { add_term(term, 0); }

        void remove_posting(const std::string & tname,
                            Xapian::termpos tpos,
                            Xapian::termcount wdfdec = 1);

        Xapian::termpos remove_postings(const std::string& term,
                                        Xapian::termpos term_pos_first,
                                        Xapian::termpos term_pos_last,
                                        Xapian::termcount wdf_dec = 1);

        void remove_term(const std::string & tname);

        void clear_terms();

        Xapian::termcount termlist_count() const;

        TermIterator termlist_begin() const;

        TermIterator XAPIAN_NOTHROW(termlist_end() const) {
            return TermIterator();
        }

        Xapian::termcount values_count() const;

        ValueIterator values_begin() const;

        ValueIterator XAPIAN_NOTHROW(values_end() const) {
            return ValueIterator();
        }

        docid get_docid() const;

        std::string serialise() const;

        static Document unserialise(const std::string &serialised);

        std::string get_description() const;
};

}

#endif // XAPIAN_INCLUDED_DOCUMENT_H