include/xapian/document.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,2006 Olly Betts
00007  *
00008  * This program is free software; you can redistribute it and/or
00009  * modify it under the terms of the GNU General Public License as
00010  * published by the Free Software Foundation; either version 2 of the
00011  * License, or (at your option) any later version.
00012  *
00013  * This program is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  * GNU General Public License for more details.
00017  *
00018  * You should have received a copy of the GNU General Public License
00019  * along with this program; if not, write to the Free Software
00020  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
00021  * USA
00022  */
00023 
00024 #ifndef XAPIAN_INCLUDED_DOCUMENT_H
00025 #define XAPIAN_INCLUDED_DOCUMENT_H
00026 
00027 #include <string>
00028 
00029 #include <xapian/base.h>
00030 #include <xapian/types.h>
00031 #include <xapian/termiterator.h>
00032 
00033 namespace Xapian {
00034 
00035 class ValueIterator;
00036 
00038 class Document {
00039     public:
00040         class Internal;
00042         Xapian::Internal::RefCntPtr<Internal> internal;
00043 
00048         explicit Document(Internal *internal_);
00049 
00053         Document(const Document &other);
00054 
00058         void operator=(const Document &other);
00059 
00061         Document();
00062 
00064         ~Document();
00065 
00067         std::string get_value(Xapian::valueno value) const;
00068 
00072         void add_value(Xapian::valueno valueno, const std::string &value);
00073 
00075         void remove_value(Xapian::valueno valueno);
00076 
00078         void clear_values();
00079 
00085         std::string get_data() const;
00086 
00088         void set_data(const std::string &data);
00089 
00104         void add_posting(const std::string & tname,
00105                          Xapian::termpos tpos,
00106                          Xapian::termcount wdfinc = 1);
00107 
00117         void add_term(const std::string & tname, Xapian::termcount wdfinc = 1);
00118 
00124         XAPIAN_DEPRECATED(void add_term_nopos(const std::string & term, Xapian::termcount wdfinc = 1));
00125 
00145         void remove_posting(const std::string & tname,
00146                             Xapian::termpos tpos,
00147                             Xapian::termcount wdfdec = 1);
00148 
00156         void remove_term(const std::string & tname);
00157 
00159         void clear_terms();
00160 
00162         Xapian::termcount termlist_count() const;
00163 
00165         TermIterator termlist_begin() const;
00166 
00168         TermIterator termlist_end() const {
00169             return TermIterator(NULL);
00170         }
00171 
00173         Xapian::termcount values_count() const;
00174 
00176         ValueIterator values_begin() const;
00177 
00179         ValueIterator values_end() const;
00180 
00185         std::string get_description() const;
00186 };
00187 
00188 }
00189 
00190 #endif // XAPIAN_INCLUDED_DOCUMENT_H

Documentation for Xapian (version 0.9.6).
Generated on 15 May 2006 by Doxygen 1.4.6.