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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaDataModelHash</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GNOME Data Access manual">
<link rel="up" href="libgda-api.html" title="Client API Reference">
<link rel="prev" href="libgda-GdaDataModelArray.html" title="GdaDataModelArray">
<link rel="next" href="libgda-GdaDataModelList.html" title="GdaDataModelList">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="introduction.html" title="Introduction">
<link rel="chapter" href="architecture.html" title="libgda architecture">
<link rel="chapter" href="installation.html" title="Installation">
<link rel="chapter" href="connecting.html" title="Beginning">
<link rel="chapter" href="processing-queries.html" title="Processing queries">
<link rel="chapter" href="ch06.html" title="Transactions and batch processes">
<link rel="chapter" href="managing-errors.html" title="Managing errors">
<link rel="chapter" href="main_example.html" title="Full example">
<link rel="chapter" href="migration.html" title="Some formulae for migration from old version">
<link rel="chapter" href="libgda-api.html" title="Client API Reference">
<link rel="chapter" href="libgda-providers.html" title="GDA Providers">
<link rel="chapter" href="libgda-xql.html" title="XML Queries">
<link rel="chapter" href="libgda-reports.html" title="GDA Report Engine">
<link rel="appendix" href="fdl.html" title="Appendix A. GNU Free Documentation License">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgda-GdaDataModelArray.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgda-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access manual</th>
<td><a accesskey="n" href="libgda-GdaDataModelList.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgda-GdaDataModelHash.synopsis" class="shortcut">Top</a>
|
<a href="#libgda-GdaDataModelHash.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgda-GdaDataModelHash"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-GdaDataModelHash.top_of_page"></a>GdaDataModelHash</span></h2>
<p>GdaDataModelHash — An implementation of <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel"><span class="type">GdaDataModel</span></a> based on a hash table</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-GdaDataModelHash.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="libgda-GdaDataModelHash.html#GdaDataModelHashPrivate" title="GdaDataModelHashPrivate">GdaDataModelHashPrivate</a>;
<a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a>* <a class="link" href="libgda-GdaDataModelHash.html#gda-data-model-hash-new" title="gda_data_model_hash_new ()">gda_data_model_hash_new</a> (gint cols);
const <a class="link" href="libgda-gda-value.html#GdaValue" title="GdaValue">GdaValue</a>* <a class="link" href="libgda-GdaDataModelHash.html#gda-data-model-hash-get-value-at" title="gda_data_model_hash_get_value_at ()">gda_data_model_hash_get_value_at</a> (<a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model,
gint col,
gint row);
void <a class="link" href="libgda-GdaDataModelHash.html#gda-data-model-hash-clear" title="gda_data_model_hash_clear ()">gda_data_model_hash_clear</a> (GdaDataModelHash *model);
void <a class="link" href="libgda-GdaDataModelHash.html#gda-data-model-hash-set-n-columns" title="gda_data_model_hash_set_n_columns ()">gda_data_model_hash_set_n_columns</a> (GdaDataModelHash *model,
gint cols);
void <a class="link" href="libgda-GdaDataModelHash.html#gda-data-model-hash-insert-row" title="gda_data_model_hash_insert_row ()">gda_data_model_hash_insert_row</a> (GdaDataModelHash *model,
gint rownum,
<a class="link" href="libgda-gda-row.html#GdaRow" title="GdaRow">GdaRow</a> *row);
const <a class="link" href="libgda-gda-row.html#GdaRow" title="GdaRow">GdaRow</a>* <a class="link" href="libgda-GdaDataModelHash.html#gda-data-model-hash-get-row" title="gda_data_model_hash_get_row ()">gda_data_model_hash_get_row</a> (<a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model,
gint row);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libgda-GdaDataModelHash.description"></a><h2>Description</h2>
<p>
Unlike <span class="type">GdaDataModelArray</span>, this data model implementation stores the <a class="link" href="libgda-gda-row.html#GdaRow" title="GdaRow"><span class="type">GdaRow</span></a> in
a hash table. So it only retrieves from the database backend exactly the
requested rows (while in GdaDataModelArray you have to retrieve all the rows
until the one requested).
</p>
</div>
<div class="refsect1" lang="en">
<a name="libgda-GdaDataModelHash.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GdaDataModelHashPrivate"></a><h3>GdaDataModelHashPrivate</h3>
<pre class="programlisting">typedef struct _GdaDataModelHashPrivate GdaDataModelHashPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-data-model-hash-new"></a><h3>gda_data_model_hash_new ()</h3>
<pre class="programlisting"><a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a>* gda_data_model_hash_new (gint cols);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cols</code></em> :</span></p></td>
<td> number of columns for rows in this data model.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to the newly created <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel"><span class="type">GdaDataModel</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-data-model-hash-get-value-at"></a><h3>gda_data_model_hash_get_value_at ()</h3>
<pre class="programlisting">const <a class="link" href="libgda-gda-value.html#GdaValue" title="GdaValue">GdaValue</a>* gda_data_model_hash_get_value_at (<a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model,
gint col,
gint row);</pre>
<p>
Retrieves the value at a specified column and row.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td> the <span class="type">GdaDataModelHash</span> to retrieve the value from.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td> column number (starting from 0).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td> row number (starting from 0).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to a <a class="link" href="libgda-gda-value.html#GdaValue" title="GdaValue"><span class="type">GdaValue</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-data-model-hash-clear"></a><h3>gda_data_model_hash_clear ()</h3>
<pre class="programlisting">void gda_data_model_hash_clear (GdaDataModelHash *model);</pre>
<p>
Frees all the rows inserted in <em class="parameter"><code>model</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td> the model to clear.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-data-model-hash-set-n-columns"></a><h3>gda_data_model_hash_set_n_columns ()</h3>
<pre class="programlisting">void gda_data_model_hash_set_n_columns (GdaDataModelHash *model,
gint cols);</pre>
<p>
Sets the number of columns for rows inserted in this model.
<em class="parameter"><code>cols</code></em> must be greater than or equal to 0.
</p>
<p>
This function calls <a class="link" href="libgda-GdaDataModelHash.html#gda-data-model-hash-clear" title="gda_data_model_hash_clear ()"><span class="type">gda_data_model_hash_clear</span></a> to free the
existing rows if any.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td> the <span class="type">GdaDataModelHash</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cols</code></em> :</span></p></td>
<td> the number of columns for rows inserted in <em class="parameter"><code>model</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-data-model-hash-insert-row"></a><h3>gda_data_model_hash_insert_row ()</h3>
<pre class="programlisting">void gda_data_model_hash_insert_row (GdaDataModelHash *model,
gint rownum,
<a class="link" href="libgda-gda-row.html#GdaRow" title="GdaRow">GdaRow</a> *row);</pre>
<p>
Inserts a <em class="parameter"><code>row</code></em> in the <em class="parameter"><code>model</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td> the <span class="type">GdaDataModelHash</span> which is gonna hold the row.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rownum</code></em> :</span></p></td>
<td> the number of the row.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td> the row to insert. The model is responsible of freeing it!
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-data-model-hash-get-row"></a><h3>gda_data_model_hash_get_row ()</h3>
<pre class="programlisting">const <a class="link" href="libgda-gda-row.html#GdaRow" title="GdaRow">GdaRow</a>* gda_data_model_hash_get_row (<a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model,
gint row);</pre>
<p>
Retrieves a row from the underlying hash table.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td> the GdaDataModelHash
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td> row number
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="libgda-gda-row.html#GdaRow" title="GdaRow"><span class="type">GdaRow</span></a> or NULL if the requested row is not in the hash table.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
