blob: a8350479ca2c2895458daa221f53b98013314a78 (
plain) (
blame)
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*
* The Mana Server
* Copyright (C) 2004 The Mana World Development Team
*
* This file is part of The Mana Server.
*
* The Mana Server 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 2 of the License, or
* any later version.
*
* The Mana Server 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 The Mana Server. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef RECORDSET_H
#define RECORDSET_H
#include <iostream>
#include <vector>
namespace dal
{
/**
* Data type for a row in a RecordSet.
*/
typedef std::vector<std::string> Row;
/**
* A RecordSet to store the result of a SQL query.
*
* Limitations:
* - the field values are stored and returned as string,
* - no information about the field data types are stored.
* - not thread-safe.
*/
class RecordSet
{
public:
/**
* Default constructor.
*/
RecordSet()
throw();
/**
* Destructor.
*/
~RecordSet()
throw();
/**
* Remove all the records.
*/
void clear();
/**
* Check if the RecordSet is empty.
*
* @return true if empty.
*/
bool isEmpty() const;
/**
* Get the number of rows.
*
* @return the number of rows.
*/
unsigned int rows() const;
/**
* Get the number of columns.
*
* @return the number of columns.
*/
unsigned int cols() const;
/**
* Set the column headers.
*
* @param headers the column headers.
*
* @exception AlreadySetException if the column headers
* are already set.
*/
void setColumnHeaders(const Row &headers);
/**
* Add a new row.
*
* This method does not check the field data types, only the number
* of columns is checked.
*
* @param row the new row.
*
* @exception RsColumnHeadersNotSet if the row is being added before
* the column headers.
* @exception std::invalid_argument if the number of columns in the
* new row is not equal to the number of column headers.
*/
void add(const Row &row);
/**
* Operator()
* Get the value of a particular field of a particular row
* by field index.
*
* @param row the row index.
* @param col the field index.
*
* @return the field value.
*
* @exception std::out_of_range if row or col are out of range.
* @exception std::invalid_argument if the recordset is empty.
*/
const std::string&
operator()(const unsigned int row,
const unsigned int col) const;
/**
* Operator()
* Get the value of a particular field of a particular row
* by field name (slower than by field index).
*
* @param row the row index.
* @param name the field name.
*
* @return the field value.
*
* @exception std::out_of_range if the row index is out of range.
* @exception std::invalid_argument if the field name is not found or
* the recordset is empty.
*/
const std::string&
operator()(const unsigned int row,
const std::string &name) const;
/**
* Operator<<
* Append the stringified RecordSet to the output stream.
*
* @param out the output stream.
* @param rhs the right hand side.
*
* @return the output stream for chaining.
*/
friend std::ostream&
operator<<(std::ostream& out, const RecordSet &rhs);
private:
/**
* Copy constructor.
*/
RecordSet(const RecordSet &rhs);
/**
* Assignment operator.
*/
RecordSet&
operator=(const RecordSet &rhs);
private:
Row mHeaders; /**< a list of field names */
typedef std::vector<Row> Rows;
Rows mRows; /**< a list of records */
};
} // namespace dal
#endif // RECORDSET_H
|
