Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

include/xapian/termiterator.h

Go to the documentation of this file.
00001 00004 /* ----START-LICENCE---- 00005 * Copyright 1999,2000,2001 BrightStation PLC 00006 * Copyright 2002 Ananova Ltd 00007 * Copyright 2003,2004 Olly Betts 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 00022 * USA 00023 * -----END-LICENCE----- 00024 */ 00025 00026 #ifndef XAPIAN_INCLUDED_TERMITERATOR_H 00027 #define XAPIAN_INCLUDED_TERMITERATOR_H 00028 00029 #include <iterator> 00030 #include <string> 00031 00032 #include <xapian/base.h> 00033 #include <xapian/types.h> 00034 00035 namespace Xapian { 00036 00037 class Database; 00038 class PositionIterator; 00039 00043 class TermNameWrapper { 00044 private: 00045 std::string tname; 00046 public: 00047 TermNameWrapper(const std::string & tname_) : tname(tname_) { } 00048 std::string operator*() const { return tname; } 00049 }; 00050 00053 class TermIterator { 00054 private: 00055 // friend classes which need to be able to construct us 00056 friend class Database; 00057 friend class Document; 00058 00059 public: 00060 class Internal; 00062 Xapian::Internal::RefCntPtr<Internal> internal; 00063 00064 friend bool operator==(const TermIterator &a, const TermIterator &b); 00065 00066 public: 00067 // FIXME: better if this was private... 00068 explicit TermIterator(Internal *internal_); 00069 00071 TermIterator(); 00072 00074 ~TermIterator(); 00075 00079 TermIterator(const TermIterator &other); 00080 00084 void operator=(const TermIterator &other); 00085 00086 std::string operator *() const; 00087 00088 TermIterator & operator++(); 00089 00090 TermNameWrapper operator++(int) { 00091 std::string tmp = **this; 00092 operator++(); 00093 return TermNameWrapper(tmp); 00094 } 00095 00096 // extra method, not required for an input_iterator 00097 void skip_to(const std::string & tname); 00098 00099 Xapian::termcount get_wdf() const; 00100 Xapian::doccount get_termfreq() const; 00101 00102 // allow iteration of positionlist for current document 00103 PositionIterator positionlist_begin(); 00104 PositionIterator positionlist_end(); 00105 00109 std::string get_description() const; 00110 00112 00113 typedef std::input_iterator_tag iterator_category; 00114 typedef std::string value_type; 00115 typedef Xapian::termcount_diff difference_type; 00116 typedef std::string * pointer; 00117 typedef std::string & reference; 00119 }; 00120 00121 inline bool 00122 operator==(const TermIterator &a, const TermIterator &b) 00123 { 00124 return (a.internal.get() == b.internal.get()); 00125 } 00126 00127 inline bool 00128 operator!=(const TermIterator &a, const TermIterator &b) 00129 { 00130 return !(a == b); 00131 } 00132 00133 } 00134 00135 #endif /* XAPIAN_INCLUDED_TERMITERATOR_H */

Documentation for Xapian (version 0.8.5).
Generated on 23 Dec 2004 by Doxygen 1.3.8.