backends/flint/flint_synonym.h

Go to the documentation of this file.

/* Copyright (C) 2005,2007,2008 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 XAPIAN_INCLUDED_FLINT_SYNONYM_H
#define XAPIAN_INCLUDED_FLINT_SYNONYM_H

#include <xapian/types.h>

#include "alltermslist.h"
#include "database.h"
#include "flint_table.h"
#include "omdebug.h"
#include "termlist.h"

#include <set>
#include <string>

class FlintSynonymTable : public FlintTable {
    mutable std::string last_term;

    mutable std::set<std::string> last_synonyms;

  public:
    FlintSynonymTable(std::string dbdir, bool readonly)
        : FlintTable(dbdir + "/synonym.", readonly, Z_DEFAULT_STRATEGY, true) { }

    // Merge in batched-up changes.
    void merge_changes();

    // Discard batched-up changes.
    void discard_changes() {
        last_term.resize(0);
        last_synonyms.clear();
    }

    void add_synonym(const std::string & term, const std::string & synonym);

    void remove_synonym(const std::string & term, const std::string & synonym);

    void clear_synonyms(const std::string & term);

    TermList * open_termlist(const std::string & term);

    bool is_modified() const {
        return !last_term.empty() || FlintTable::is_modified();
    }

    void create_and_open(unsigned int blocksize) {
        // The synonym table is created lazily, but erase it in case we're
        // overwriting an existing database and it already exists.
        FlintTable::erase();
        FlintTable::set_block_size(blocksize);
    }

    void commit(flint_revision_number_t revision) {
        merge_changes();
        FlintTable::commit(revision);
    }

    void cancel() {
        discard_changes();
        FlintTable::cancel();
    }

    // @}
};

class FlintCursor;

class FlintSynonymTermList : public AllTermsList {
    FlintSynonymTermList(const FlintSynonymTermList &);

    void operator=(const FlintSynonymTermList &);

    Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> database;

    FlintCursor * cursor;

    Xapian::termcount size;

    string prefix;

  public:
    FlintSynonymTermList(Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> database_,
                      FlintCursor * cursor_,
                      Xapian::termcount size_,
                      const string & prefix_)
            : database(database_), cursor(cursor_), size(size_), prefix(prefix_)
    {
        // Position the on the highest key before the first key we want, so
        // that the first call to next() will put us on the first key we want.
        if (prefix.empty()) {
            cursor->find_entry(string());
        } else {
            // Seek to the first key before one with the desired prefix.
            cursor->find_entry_lt(prefix);
        }
    }

    ~FlintSynonymTermList();

    string get_termname() const;

    Xapian::doccount get_termfreq() const;

    Xapian::termcount get_collection_freq() const;

    TermList * next();

    TermList * skip_to(const string &tname);

    bool at_end() const;
};

#endif // XAPIAN_INCLUDED_FLINT_SYNONYM_H

---