backends/quartz/quartz_record.h

Go to the documentation of this file.

/* quartz_record.h: Records in quartz databases
 *
 * ----START-LICENCE----
 * Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2002,2003,2004 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 * -----END-LICENCE-----
 */

#ifndef OM_HGUARD_QUARTZ_RECORD_H
#define OM_HGUARD_QUARTZ_RECORD_H

#include <string>

#include <xapian/types.h>
#include "quartz_types.h"
#include "btree.h"

using namespace std;

class QuartzRecordTable : public Btree {
    public:
        QuartzRecordTable(string path_, bool readonly_)
            : Btree(path_ + "/record_", readonly_) { }

        string get_record(Xapian::docid did) const;

        Xapian::doccount get_doccount() const;

        quartz_totlen_t get_total_length() const;

        Xapian::docid get_lastdocid() const;

        void set_total_length_and_lastdocid(quartz_totlen_t totlen,
                                            Xapian::docid did);

        /* Add a new record to the table, or replace an existing record.
         *
         * @param did   The document ID to use.
         */
        void replace_record(const string & data, Xapian::docid did);

        void delete_record(Xapian::docid did);
};

#endif /* OM_HGUARD_QUARTZ_RECORD_H */

---