summaryrefslogtreecommitdiffstats
path: root/reladminif/eoid.hh
blob: 968dcb50853e9d4ff1b40833080b76df06f130ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
* This file is part of rasdaman community.
*
* Rasdaman community is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Rasdaman community is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 Peter Baumann /
rasdaman GmbH.
*
* For more information please see <http://www.rasdaman.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
*/
#ifndef _EOIDIF_HH_
#define _EOIDIF_HH_
/*************************************************************
 *
 *
 * PURPOSE:
 *  EOId is optimized for maps that contain only EOId of one system/database.
 *
 *
 * COMMENTS:
 *   When true multiple connections are implemented the order of compare
 * statements in the operator"<" and ">" must be changed.
 ***************************************************************************/

class EOId;
class r_Error;

#include "oidif.hh"
#include <string>

//@ManMemo: Module: {\bf reladminif}.
/*@Doc:
EOId is optimized for maps that contain only EOId of one system/database.
when true multiple connections are implemented the order of compare
statements in the operator"<" and ">" must be changed.
*/

class EOId :	public OId
	{
	public:
		EOId(const char* systemname, const char* dbname, OId::OIdCounter id, OIdType type);
		/*@Doc: 
		constructs a complete EOId.
		*/
	
		EOId(const OId& id);
		/*@Doc: 
		uses the currently open database to get system and db name 
		systemname and database name will be null string when the
		database is not really open.
		*/
		
		EOId();
		/*@Doc: 
		uses the currently open database to get system and db name
		systemname and database name will be null string when the
		database is not really open.
		*/
		
		
		~EOId();
		/*@Doc: 
		does not do anything.
		*/
		
		EOId& operator=(const EOId& old);
		/*@Doc: 
		assignes all atributes.
		*/
		
		
		const char* getSystemName() const;
		/*@Doc: 
		returns the system name, which is the same as the
		one returned by databaseif.
		*/
		
		
		const char* getBaseName() const;
		/*@Doc: 
		returns the database name, which is the same as the
		one returned by databaseif
		*/
		
		
		OId getOId() const;
		/*@Doc: 
		returns the oid of this eoid
		*/
		
		
		void print_status(std::ostream& o) const;
		/*@Doc: 
		returns the systemname|databasename|oid
		*/

		static void allocateEOId(EOId& eoid, OId::OIdType t) throw (r_Error);
		/*@Doc: 
		Allocates a new logical MDD EOid in the currently opened base.
		throws an r_Error_DatabaseClosed when the database is not really open.
		*/

		bool operator<(const EOId& old) const;

		bool operator>(const EOId& old) const;

		bool operator<=(const EOId& old) const;

		bool operator>=(const EOId& old) const;

		bool operator== (const EOId& one) const;
		
		bool operator!= (const EOId& one) const;

	private:
	
		std::string databaseName;
		/*@Doc: 
		the name of the database the oid of this eoid is valid for.
		stl std::string was used because of the compare functionality.
		*/
		
		std::string systemName;
		/*@Doc: 
		the name of the system above mentioned database runs on
		stl std::string was used because of the compare functionality.
		*/
	};

extern std::ostream& operator<<(std::ostream& s, EOId& d);

extern std::ostream& operator<<(std::ostream& s, const EOId& d);

#endif