← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to include/OpenMS/FORMAT/DB/PersistentObject.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/FORMAT/DB/PersistentObject.h
1
 
// -*- mode: C++; tab-width: 2; -*-
2
 
// vi: set ts=2:
3
 
//
4
 
// --------------------------------------------------------------------------
5
 
//                   OpenMS Mass Spectrometry Framework
6
 
// --------------------------------------------------------------------------
7
 
//  Copyright (C) 2003-2011 -- Oliver Kohlbacher, Knut Reinert
8
 
//
9
 
//  This library is free software; you can redistribute it and/or
10
 
//  modify it under the terms of the GNU Lesser General Public
11
 
//  License as published by the Free Software Foundation; either
12
 
//  version 2.1 of the License, or (at your option) any later version.
13
 
//
14
 
//  This library is distributed in the hope that it will be useful,
15
 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17
 
//  Lesser General Public License for more details.
18
 
//
19
 
//  You should have received a copy of the GNU Lesser General Public
20
 
//  License along with this library; if not, write to the Free Software
21
 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
1
// --------------------------------------------------------------------------
 
2
//                   OpenMS -- Open-Source Mass Spectrometry
 
3
// --------------------------------------------------------------------------
 
4
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
 
5
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
 
6
//
 
7
// This software is released under a three-clause BSD license:
 
8
//  * Redistributions of source code must retain the above copyright
 
9
//    notice, this list of conditions and the following disclaimer.
 
10
//  * Redistributions in binary form must reproduce the above copyright
 
11
//    notice, this list of conditions and the following disclaimer in the
 
12
//    documentation and/or other materials provided with the distribution.
 
13
//  * Neither the name of any author or any participating institution
 
14
//    may be used to endorse or promote products derived from this software
 
15
//    without specific prior written permission.
 
16
// For a full list of authors, refer to the file AUTHORS.
 
17
// --------------------------------------------------------------------------
 
18
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 
19
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 
20
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 
21
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
 
22
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 
23
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
24
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
25
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
26
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 
27
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 
28
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22
29
//
23
30
// --------------------------------------------------------------------------
24
31
// $Maintainer: $
34
41
#include <iostream>
35
42
 
36
43
namespace OpenMS
37
 
{ 
 
44
{
38
45
  /**
39
 
        @brief Base class for all persistent objects.
40
 
        
41
 
        Interface for all classes that can be stored persistently in the OpenMS DB.
42
 
 
43
 
        @ingroup DatabaseIO
 
46
    @brief Base class for all persistent objects.
 
47
 
 
48
    Interface for all classes that can be stored persistently in the OpenMS DB.
 
49
 
 
50
    @ingroup DatabaseIO
44
51
  */
45
52
  class OPENMS_DLLAPI PersistentObject
46
53
  {
47
54
 
48
 
    public:
49
 
      /// Default constructor
50
 
      PersistentObject();
51
 
 
52
 
      /// Destructor
53
 
      virtual ~PersistentObject();
54
 
                        
55
 
      /// Assignment operator
56
 
      PersistentObject& operator= (const PersistentObject& rhs);
57
 
                        
58
 
      /**
59
 
        @brief Returns the persistence id
60
 
        
61
 
        This id is only used in the DBAdapter the id is used to connect the object to the data stored in the DB.
62
 
      */
63
 
      const UID& getPersistenceId() const;
64
 
 
65
 
      /**
66
 
        @brief Sets the persistence id
67
 
        
68
 
        This id is only used in the DBAdapter the id is used to connect the object to the data stored in the DB.
69
 
        <BR>
70
 
        Do not set the persistence id unless you know what you are doing!
71
 
      */
72
 
      void setPersistenceId(const UID& persistence_id);
73
 
 
74
 
      /**
75
 
        @brief Clears the persistence id
76
 
        
77
 
        Sets the id to 0.<br>
78
 
        @param deep determines which ids are cleared. <tt>false</tt> means that only the id of the current object is reset. 
79
 
        <tt>true</tt> means that the ids of all sub-objects are reset as well (default).
80
 
      */
81
 
      void clearId(bool deep = true);
82
 
 
83
 
    protected:
84
 
    
85
 
      ///A persistence id used to refer the data back to the source
86
 
      UID persistence_id_;
87
 
 
88
 
      /**
89
 
        @brief Clears the persistence id of all sub-objects.
90
 
        
91
 
        
92
 
      */
93
 
      virtual void clearChildIds_() =0;
 
55
public:
 
56
    /// Default constructor
 
57
    PersistentObject();
 
58
 
 
59
    /// Destructor
 
60
    virtual ~PersistentObject();
 
61
 
 
62
    /// Assignment operator
 
63
    PersistentObject & operator=(const PersistentObject & rhs);
 
64
 
 
65
    /**
 
66
      @brief Returns the persistence id
 
67
 
 
68
      This id is only used in the DBAdapter the id is used to connect the object to the data stored in the DB.
 
69
    */
 
70
    const UID & getPersistenceId() const;
 
71
 
 
72
    /**
 
73
      @brief Sets the persistence id
 
74
 
 
75
      This id is only used in the DBAdapter the id is used to connect the object to the data stored in the DB.
 
76
      <BR>
 
77
      Do not set the persistence id unless you know what you are doing!
 
78
    */
 
79
    void setPersistenceId(const UID & persistence_id);
 
80
 
 
81
    /**
 
82
      @brief Clears the persistence id
 
83
 
 
84
      Sets the id to 0.<br>
 
85
      @param deep determines which ids are cleared. <tt>false</tt> means that only the id of the current object is reset.
 
86
      <tt>true</tt> means that the ids of all sub-objects are reset as well (default).
 
87
    */
 
88
    void clearId(bool deep = true);
 
89
 
 
90
protected:
 
91
 
 
92
    ///A persistence id used to refer the data back to the source
 
93
    UID persistence_id_;
 
94
 
 
95
    /**
 
96
      @brief Clears the persistence id of all sub-objects.
 
97
 
 
98
 
 
99
    */
 
100
    virtual void clearChildIds_() = 0;
94
101
  };
95
102
 
96
103
}