document.h

Go to the documentation of this file.

/* Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2003,2004,2005,2007,2008,2009,2010,2011 Olly Betts
 *
 * 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 OM_HGUARD_DOCUMENT_H
#define OM_HGUARD_DOCUMENT_H

#include "xapian/intrusive_ptr.h"
#include <xapian/types.h>
#include "api/termlist.h"
#include "backends/database.h"
#include "api/documentterm.h"
#include <map>
#include <string>

using std::map;
using std::string;
using std::swap;

class DocumentValueList;
class ValueStreamDocument;

class Xapian::Document::Internal : public Xapian::Internal::intrusive_base {
    friend class ::DocumentValueList;
    friend class ::ValueStreamDocument;
    public:
        typedef map<Xapian::valueno, string> document_values;

        typedef map<string, OmDocumentTerm> document_terms;

    protected:
        Xapian::Internal::intrusive_ptr<const Xapian::Database::Internal> database;

    private:
        // Prevent copying
        Internal(const Internal &);
        Internal & operator=(const Internal &);

        bool data_here;
        mutable bool values_here; // FIXME mutable is a hack
        mutable bool terms_here;
        mutable bool positions_modified;

        string data;

        mutable document_values values; // FIXME mutable is a hack

        mutable document_terms terms;

        mutable Xapian::termcount termlist_size;

    protected:
        Xapian::docid did;

    private:
        // Functions for backend to implement
        virtual string do_get_value(Xapian::valueno /*valueno*/) const { return string(); }
        virtual void do_get_all_values(map<Xapian::valueno, string> & values_) const {
            values_.clear();
        }
        virtual string do_get_data() const { return string(); }

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

        void set_all_values(map<Xapian::valueno, string> & values_) {
            // For efficiency we just swap the old and new value maps.
            swap(values, values_);
            values_here = true;
        }

        Xapian::valueno values_count() const;
        void add_value(Xapian::valueno, const string &);
        void remove_value(Xapian::valueno);
        void clear_values();
        void add_posting(const string &, Xapian::termpos, Xapian::termcount);
        void add_term(const string &, Xapian::termcount);
        void remove_posting(const string &, Xapian::termpos, Xapian::termcount);
        Xapian::termpos remove_postings(const string &,
                                        Xapian::termpos, Xapian::termpos,
                                        Xapian::termcount);
        void remove_term(const string &);
        void clear_terms();
        Xapian::termcount termlist_count() const;

        string get_data() const;

        void set_data(const string &);

        TermList * open_term_list() const;

        void need_values() const;
        void need_terms() const;

        bool data_modified() const {
            return data_here;
        }

        bool values_modified() const {
            return values_here;
        }

        bool terms_modified() const {
            return terms_here;
        }

        bool term_positions_modified() const {
            return positions_modified;
        }

        bool modified() const {
            return terms_here || values_here || data_here;
        }

        Xapian::docid get_docid() const { return did; }

        string get_description() const;

        Internal(Xapian::Internal::intrusive_ptr<const Xapian::Database::Internal> database_,
                 Xapian::docid did_)
            : database(database_), data_here(false), values_here(false),
              terms_here(false), positions_modified(false), did(did_) { }

        Internal()
            : database(), data_here(false), values_here(false),
              terms_here(false), positions_modified(false), did(0) { }

        virtual ~Internal();
};

#endif  // OM_HGUARD_DOCUMENT_H