include/xapian/database.h

Go to the documentation of this file.
00001 
00004 /* Copyright 1999,2000,2001 BrightStation PLC
00005  * Copyright 2002 Ananova Ltd
00006  * Copyright 2002,2003,2004,2005,2006,2007 Olly Betts
00007  * Copyright 2006 Richard Boulton
00008  *
00009  * This program is free software; you can redistribute it and/or
00010  * modify it under the terms of the GNU General Public License as
00011  * published by the Free Software Foundation; either version 2 of the
00012  * License, or (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
00022  * USA
00023  */
00024 
00025 #ifndef XAPIAN_INCLUDED_DATABASE_H
00026 #define XAPIAN_INCLUDED_DATABASE_H
00027 
00028 #include <string>
00029 #include <vector>
00030 
00031 #include <xapian/base.h>
00032 #include <xapian/types.h>
00033 #include <xapian/positioniterator.h>
00034 #include <xapian/postingiterator.h>
00035 #include <xapian/termiterator.h>
00036 #include <xapian/visibility.h>
00037 
00039 namespace Xapian {
00040 
00041 class Document;
00042 
00057 class XAPIAN_VISIBILITY_DEFAULT Database {
00058     public:
00059         class Internal;
00061         std::vector<Xapian::Internal::RefCntPtr<Internal> > internal;
00062 
00068         void add_database(const Database & database);
00069 
00072         Database();
00073 
00079         explicit Database(const std::string &path);
00080 
00083         explicit Database(Internal *internal);
00084 
00090         virtual ~Database();
00091 
00095         Database(const Database &other);
00096 
00100         void operator=(const Database &other);
00101 
00107         void reopen();
00108 
00113         virtual std::string get_description() const;
00114 
00123         PostingIterator postlist_begin(const std::string &tname) const;
00124 
00127         PostingIterator postlist_end(const std::string &) const {
00128             return PostingIterator(NULL);
00129         }
00130 
00134         TermIterator termlist_begin(Xapian::docid did) const;
00135 
00138         TermIterator termlist_end(Xapian::docid) const {
00139             return TermIterator(NULL);
00140         }
00141 
00143         bool has_positions() const;
00144 
00148         PositionIterator positionlist_begin(Xapian::docid did, const std::string &tname) const;
00149 
00152         PositionIterator positionlist_end(Xapian::docid, const std::string &) const {
00153             return PositionIterator(NULL);
00154         }
00155 
00158         TermIterator allterms_begin() const;
00159 
00162         TermIterator allterms_end() const {
00163             return TermIterator(NULL);
00164         }
00165 
00177         TermIterator allterms_begin(const std::string & prefix) const;
00178 
00181         TermIterator allterms_end(const std::string &) const {
00182             return TermIterator(NULL);
00183         }
00184 
00186         Xapian::doccount get_doccount() const;
00187 
00189         Xapian::docid get_lastdocid() const;
00190 
00192         Xapian::doclength get_avlength() const;
00193 
00195         Xapian::doccount get_termfreq(const std::string & tname) const;
00196 
00203         bool term_exists(const std::string & tname) const;
00204 
00214         Xapian::termcount get_collection_freq(const std::string & tname) const;
00215 
00218         Xapian::doclength get_doclength(Xapian::docid did) const;
00219 
00223         void keep_alive();
00224 
00237         Xapian::Document get_document(Xapian::docid did) const;
00238 
00247         std::string get_spelling_suggestion(const std::string &word,
00248                                             unsigned max_edit_distance = 2) const;
00249 
00257         Xapian::TermIterator spellings_begin() const;
00258 
00260         Xapian::TermIterator spellings_end() const {
00261             return Xapian::TermIterator(NULL);
00262         }
00263 
00268         Xapian::TermIterator synonyms_begin(const std::string &term) const;
00269 
00271         Xapian::TermIterator synonyms_end(const std::string &) const {
00272             return Xapian::TermIterator(NULL);
00273         }
00274 
00280         Xapian::TermIterator synonym_keys_begin(const std::string &prefix = "") const;
00281 
00283         Xapian::TermIterator synonym_keys_end(const std::string & = "") const {
00284             return Xapian::TermIterator(NULL);
00285         }
00286 
00306         std::string get_metadata(const std::string & key) const;
00307 };
00308 
00311 class XAPIAN_VISIBILITY_DEFAULT WritableDatabase : public Database {
00312     public:
00319         virtual ~WritableDatabase();
00320 
00323         WritableDatabase();
00324 
00341         WritableDatabase(const std::string &path, int action);
00342 
00345         explicit WritableDatabase(Database::Internal *internal);
00346 
00350         WritableDatabase(const WritableDatabase &other);
00351 
00359         void operator=(const WritableDatabase &other);
00360 
00397         void flush();
00398 
00438         void begin_transaction(bool flushed=true);
00439 
00465         void commit_transaction();
00466 
00485         void cancel_transaction();
00486 
00515         Xapian::docid add_document(const Xapian::Document & document);
00516 
00538         void delete_document(Xapian::docid did);
00539 
00557         void delete_document(const std::string & unique_term);
00558 
00590         void replace_document(Xapian::docid did,
00591                               const Xapian::Document & document);
00592 
00624         Xapian::docid replace_document(const std::string & unique_term,
00625                                        const Xapian::Document & document);
00626 
00634         void add_spelling(const std::string & word,
00635                           Xapian::termcount freqinc = 1) const;
00636 
00645         void remove_spelling(const std::string & word,
00646                              Xapian::termcount freqdec = 1) const;
00647 
00653         void add_synonym(const std::string & term,
00654                          const std::string & synonym) const;
00655 
00660         void remove_synonym(const std::string & term,
00661                             const std::string & synonym) const;
00662 
00667         void clear_synonyms(const std::string & term) const;
00668 
00709         void set_metadata(const std::string & key, const std::string & value);
00710 
00715         std::string get_description() const;
00716 };
00717 
00719 const int DB_CREATE_OR_OPEN = 1;
00721 const int DB_CREATE = 2;
00723 const int DB_CREATE_OR_OVERWRITE = 3;
00725 const int DB_OPEN = 4;
00726 // Can't see any sensible use for this one
00727 // const int DB_OVERWRITE = XXX;
00728 
00729 }
00730 
00731 #endif /* XAPIAN_INCLUDED_DATABASE_H */

Documentation for Xapian (version 1.0.3).
Generated on 29 Sep 2007 by Doxygen 1.5.2.