Branch data     Line data    Source code

       1                 :            : /** @file remote-document.h
       2                 :            :  * @brief A document read from a RemoteDatabase.
       3                 :            :  */
       4                 :            : /* Copyright (C) 2008 Olly Betts
       5                 :            :  *
       6                 :            :  * This program is free software; you can redistribute it and/or
       7                 :            :  * modify it under the terms of the GNU General Public License as
       8                 :            :  * published by the Free Software Foundation; either version 2 of the
       9                 :            :  * License, or (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_REMOTE_DOCUMENT_H
      22                 :            : #define XAPIAN_INCLUDED_REMOTE_DOCUMENT_H
      23                 :            : 
      24                 :            : #include "database.h"
      25                 :            : #include "document.h"
      26                 :            : 
      27                 :            : /// A document read from a RemoteDatabase.
      28 [ +  - ][ #  # ]:     450950 : class RemoteDocument : public Xapian::Document::Internal {
      29                 :            :     /// Don't allow assignment.
      30                 :            :     void operator=(const RemoteDocument &);
      31                 :            : 
      32                 :            :     /// Don't allow copying.
      33                 :            :     RemoteDocument(const RemoteDocument &);
      34                 :            : 
      35                 :            :     /// RemoteDocument::open_document() needs to call our private constructor.
      36                 :            :     friend class RemoteDatabase;
      37                 :            : 
      38                 :            :     /** Private constructor - only called by RemoteDocument::open_document().
      39                 :            :      *
      40                 :            :      *  @param values_  The values to set - passed by non-const reference, and
      41                 :            :      *                  may be modified by the call.
      42                 :            :      */
      43                 :     450950 :     RemoteDocument(const Xapian::Database::Internal *db, Xapian::docid did_,
      44                 :            :                    const string & data_,
      45                 :            :                    map<Xapian::valueno, string> &values_)
      46                 :     450950 :         : Xapian::Document::Internal(db, did_)
      47                 :            :     {
      48                 :     450950 :         set_data(data_);
      49                 :     450950 :         set_all_values(values_);
      50                 :     450950 :     }
      51                 :            : 
      52                 :            :   public:
      53                 :            :     /** Implementation of virtual methods @{ */
      54                 :            :     string do_get_value(Xapian::valueno slot) const;
      55                 :            :     void do_get_all_values(map<Xapian::valueno, string> & values_) const;
      56                 :            :     string do_get_data() const;
      57                 :            :     /** @} */
      58                 :            : };
      59                 :            : 
      60                 :            : #endif // XAPIAN_INCLUDED_REMOTE_DOCUMENT_H