← Back to branch summary

~ubuntu-branches/ubuntu/trusty/mongodb/trusty-proposed

« back to all changes in this revision

Viewing changes to client/model.h

  • Committer: Bazaar Package Importer
  • Author(s): Antonin Kral
  • Date: 2010-01-29 19:48:45 UTC
  • Revision ID: james.westby@ubuntu.com-20100129194845-8wbmkf626fwcavc9
Tags: upstream-1.3.1
Import upstream version 1.3.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
client/model.h
 
1
/** @file model.h */
 
2
 
 
3
/*    Copyright 2009 10gen
 
4
 *
 
5
 *    Licensed under the Apache License, Version 2.0 (the "License");
 
6
 *    you may not use this file except in compliance with the License.
 
7
 *    You may obtain a copy of the License at
 
8
 *
 
9
 *    http://www.apache.org/licenses/LICENSE-2.0
 
10
 *
 
11
 *    Unless required by applicable law or agreed to in writing, software
 
12
 *    distributed under the License is distributed on an "AS IS" BASIS,
 
13
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
14
 *    See the License for the specific language governing permissions and
 
15
 *    limitations under the License.
 
16
 */
 
17
 
 
18
#pragma once
 
19
 
 
20
#include "dbclient.h"
 
21
 
 
22
namespace mongo {
 
23
 
 
24
    /** Model is a base class for defining objects which are serializable to the Mongo
 
25
       database via the database driver.
 
26
 
 
27
       Definition
 
28
       Your serializable class should inherit from Model and implement the abstract methods
 
29
       below.
 
30
 
 
31
       Loading
 
32
       To load, first construct an (empty) object.  Then call load().  Do not load an object
 
33
       more than once.
 
34
    */
 
35
    class Model {
 
36
    public:
 
37
        Model() { }
 
38
        virtual ~Model() { }
 
39
 
 
40
        virtual const char * getNS() = 0;
 
41
        virtual void serialize(BSONObjBuilder& to) = 0;
 
42
        virtual void unserialize(const BSONObj& from) = 0;
 
43
 
 
44
        virtual string modelServer() = 0;
 
45
        
 
46
        /** Load a single object. 
 
47
            @return true if successful.
 
48
        */
 
49
        virtual bool load(BSONObj& query);
 
50
        virtual void save( bool safe=false );
 
51
        virtual void remove( bool safe=false );
 
52
        
 
53
    protected:
 
54
        BSONObj _id;
 
55
    };
 
56
 
 
57
} // namespace mongo