Branch data     Line data    Source code

       1                 :            : /** @file flint_modifiedpostlist.h
       2                 :            :  * @brief A FlintPostList plus pending modifications
       3                 :            :  */
       4                 :            : /* Copyright (C) 2006,2007,2009 Olly Betts
       5                 :            :  *
       6                 :            :  * This program is free software; you can redistribute it and/or modify
       7                 :            :  * it under the terms of the GNU General Public License as published by
       8                 :            :  * the Free Software Foundation; either version 2 of the License, or
       9                 :            :  * (at your option) any later version.
      10                 :            :  *
      11                 :            :  * This program is distributed in the hope that it will be useful,
      12                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      13                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      14                 :            :  * GNU General Public License for more details.
      15                 :            :  *
      16                 :            :  * You should have received a copy of the GNU General Public License
      17                 :            :  * along with this program; if not, write to the Free Software
      18                 :            :  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
      19                 :            :  */
      20                 :            : 
      21                 :            : #ifndef XAPIAN_INCLUDED_FLINT_MODIFIEDPOSTLIST_H
      22                 :            : #define XAPIAN_INCLUDED_FLINT_MODIFIEDPOSTLIST_H
      23                 :            : 
      24                 :            : #include <map>
      25                 :            : #include <string>
      26                 :            : 
      27                 :            : using namespace std;
      28                 :            : 
      29                 :            : #include "flint_database.h"
      30                 :            : #include "flint_postlist.h"
      31                 :            : 
      32                 :            : class FlintModifiedPostList : public FlintPostList {
      33                 :            :     /// Modifications to apply to the FlintPostList.
      34                 :            :     //@{
      35                 :            :     map<Xapian::docid, pair<char, Xapian::termcount> > mods;
      36                 :            :     map<Xapian::docid, pair<char, Xapian::termcount> >::const_iterator it;
      37                 :            :     //@}
      38                 :            : 
      39                 :            :     /// Pointer to PositionList returned from read_position_list to be deleted.
      40                 :            :     PositionList * poslist;
      41                 :            : 
      42                 :            :     /// Skip over deleted documents after a next() or skip_to().
      43                 :            :     void skip_deletes(Xapian::weight w_min);
      44                 :            : 
      45                 :            :   public:
      46                 :            :     /// Constructor.
      47                 :         96 :     FlintModifiedPostList(Xapian::Internal::RefCntPtr<const FlintDatabase> this_db_,
      48                 :            :                           const string & tname_,
      49                 :            :                           const map<Xapian::docid, pair<char, Xapian::termcount> > & mods_)
      50                 :            :         : FlintPostList(this_db_, tname_),
      51                 :         96 :           mods(mods_), it(mods.begin()), poslist(0)
      52                 :         96 :     { }
      53                 :            : 
      54                 :            :     ~FlintModifiedPostList();
      55                 :            : 
      56                 :            :     Xapian::doccount get_termfreq() const;
      57                 :            : 
      58                 :            :     Xapian::docid get_docid() const;
      59                 :            : 
      60                 :            :     Xapian::termcount get_doclength() const;
      61                 :            : 
      62                 :            :     Xapian::termcount get_wdf() const;
      63                 :            : 
      64                 :            :     PositionList *read_position_list();
      65                 :            : 
      66                 :            :     PositionList *open_position_list() const;
      67                 :            : 
      68                 :            :     PostList * next(Xapian::weight w_min);
      69                 :            : 
      70                 :            :     PostList * skip_to(Xapian::docid desired_did, Xapian::weight w_min);
      71                 :            : 
      72                 :            :     bool at_end() const;
      73                 :            : 
      74                 :            :     std::string get_description() const;
      75                 :            : };
      76                 :            : 
      77                 :            : #endif // XAPIAN_INCLUDED_FLINT_MODIFIEDPOSTLIST_H