Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

include/om/omtermlistiterator.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  *
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00021  * USA
00022  * -----END-LICENCE-----
00023  */
00024 
00025 #ifndef OM_HGUARD_OMTERMLISTITERATOR_H
00026 #define OM_HGUARD_OMTERMLISTITERATOR_H
00027 
00028 #include <iterator>
00029 #include "om/omtypes.h"
00030 
00031 class OmDatabase;
00032 class OmPositionListIterator;
00033 
00036 class OmTermIterator {
00037     private:
00038         // friend classes which need to be able to construct us
00039         friend class OmDatabase;
00040         friend class OmDocument;
00041 
00042     public:
00043         class Internal;
00045         Internal *internal;
00046 
00047         friend bool operator==(const OmTermIterator &a,
00048                                const OmTermIterator &b);
00049 
00050     public:
00051         // FIXME: better if this was private...
00052         OmTermIterator(Internal *internal_);
00053 
00055         OmTermIterator();
00056 
00058         ~OmTermIterator();
00059 
00063         OmTermIterator(const OmTermIterator &other);
00064 
00068         void operator=(const OmTermIterator &other);
00069 
00070         om_termname operator *() const;
00071 
00072         OmTermIterator & operator++();
00073 
00074         void operator++(int);
00075 
00076         // extra method, not required for an input_iterator
00077         void skip_to(const om_termname & tname);
00078 
00079         om_termcount get_wdf() const;
00080         om_doccount get_termfreq() const;
00081 
00082         // allow iteration of positionlist for current document
00083         OmPositionListIterator positionlist_begin();
00084         OmPositionListIterator positionlist_end();
00085     
00089         std::string get_description() const;
00090 
00092 
00093         typedef std::input_iterator_tag iterator_category;
00094         typedef om_termname value_type;
00095         typedef om_termcount_diff difference_type;
00096         typedef om_termname * pointer;
00097         typedef om_termname & reference;
00099 };
00100 
00101 inline bool
00102 operator!=(const OmTermIterator &a, const OmTermIterator &b)
00103 {
00104     return !(a == b);
00105 }
00106 
00107 #endif /* OM_HGUARD_OMTERMLISTITERATOR_H */

Documentation for Xapian (version 0.6.1).
Generated on 7 Dec 2002 by Doxygen 1.2.15.