greeve 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,613 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Greeve::Rowset
8
+
9
+ &mdash; Documentation by YARD 0.9.5
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Greeve::Rowset";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (R)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Greeve.html" title="Greeve (module)">Greeve</a></span></span>
41
+ &raquo;
42
+ <span class="title">Rowset</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame" src="../class_list.html"></iframe>
63
+
64
+ <div id="content"><h1>Class: Greeve::Rowset
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">Object</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">Greeve::Rowset</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+ <dl>
93
+ <dt>Includes:</dt>
94
+ <dd>Enumerable</dd>
95
+ </dl>
96
+
97
+
98
+
99
+
100
+
101
+
102
+ <dl>
103
+ <dt>Defined in:</dt>
104
+ <dd>lib/greeve/rowset.rb</dd>
105
+ </dl>
106
+
107
+ </div>
108
+
109
+ <h2>Overview</h2><div class="docstring">
110
+ <div class="discussion">
111
+
112
+ <p>Represents an XML `rowset` element.</p>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+
120
+ </div>
121
+
122
+
123
+
124
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
125
+ <ul class="summary">
126
+
127
+ <li class="public ">
128
+ <span class="summary_signature">
129
+
130
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Symbol </a>
131
+
132
+
133
+
134
+ </span>
135
+
136
+
137
+
138
+
139
+ <span class="note title readonly">readonly</span>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+ <span class="summary_desc"><div class='inline'>
150
+ <p>Name of the rowset.</p>
151
+ </div></span>
152
+
153
+ </li>
154
+
155
+
156
+ </ul>
157
+
158
+
159
+
160
+
161
+
162
+ <h2>
163
+ Instance Method Summary
164
+ <small><a href="#" class="summary_toggle">collapse</a></small>
165
+ </h2>
166
+
167
+ <ul class="summary">
168
+
169
+ <li class="public ">
170
+ <span class="summary_signature">
171
+
172
+ <a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong>(&amp;block) &#x21d2; Object </a>
173
+
174
+
175
+
176
+ </span>
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ <span class="summary_desc"><div class='inline'>
187
+ <p>:nodoc:.</p>
188
+ </div></span>
189
+
190
+ </li>
191
+
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, xml_element) { ... } &#x21d2; Rowset </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+ <span class="note title constructor">constructor</span>
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>A new instance of Rowset.</p>
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> &#x21d2; Object </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+ <span class="summary_desc"><div class='inline'>
237
+ <p>:nodoc:.</p>
238
+ </div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="public ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#to_a-instance_method" title="#to_a (instance method)">#<strong>to_a</strong> &#x21d2; Array </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+ <span class="summary_desc"><div class='inline'>
261
+ <p>An array of rows and their non-nil attributes.</p>
262
+ </div></span>
263
+
264
+ </li>
265
+
266
+
267
+ </ul>
268
+
269
+
270
+
271
+ <div id="constructor_details" class="method_details_list">
272
+ <h2>Constructor Details</h2>
273
+
274
+ <div class="method_details first">
275
+ <h3 class="signature first" id="initialize-instance_method">
276
+
277
+ #<strong>initialize</strong>(name, xml_element) { ... } &#x21d2; <tt><span class='object_link'><a href="" title="Greeve::Rowset (class)">Rowset</a></span></tt>
278
+
279
+
280
+
281
+
282
+
283
+ </h3><div class="docstring">
284
+ <div class="discussion">
285
+
286
+ <p>Returns a new instance of Rowset</p>
287
+
288
+
289
+ </div>
290
+ </div>
291
+ <div class="tags">
292
+ <p class="tag_title">Parameters:</p>
293
+ <ul class="param">
294
+
295
+ <li>
296
+
297
+ <span class='name'>name</span>
298
+
299
+
300
+ <span class='type'>(<tt>Symbol</tt>)</span>
301
+
302
+
303
+
304
+ &mdash;
305
+ <div class='inline'>
306
+ <p>name of the rowset</p>
307
+ </div>
308
+
309
+ </li>
310
+
311
+ <li>
312
+
313
+ <span class='name'>xml_element</span>
314
+
315
+
316
+ <span class='type'>(<tt>Ox::Element</tt>)</span>
317
+
318
+
319
+
320
+ &mdash;
321
+ <div class='inline'>
322
+ <p>the xml rowset element for this item</p>
323
+ </div>
324
+
325
+ </li>
326
+
327
+ </ul>
328
+
329
+ <p class="tag_title">Yields:</p>
330
+ <ul class="yield">
331
+
332
+ <li>
333
+
334
+
335
+ <span class='type'></span>
336
+
337
+
338
+
339
+
340
+ <div class='inline'>
341
+ <p>a block containing the attribute definitions for <span class='object_link'><a href="Row.html" title="Greeve::Row (class)">Greeve::Row</a></span></p>
342
+ </div>
343
+
344
+ </li>
345
+
346
+ </ul>
347
+
348
+ </div><table class="source_code">
349
+ <tr>
350
+ <td>
351
+ <pre class="lines">
352
+
353
+
354
+ 14
355
+ 15
356
+ 16
357
+ 17
358
+ 18
359
+ 19
360
+ 20
361
+ 21
362
+ 22
363
+ 23
364
+ 24
365
+ 25</pre>
366
+ </td>
367
+ <td>
368
+ <pre class="code"><span class="info file"># File 'lib/greeve/rowset.rb', line 14</span>
369
+
370
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_xml_element'>xml_element</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
371
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
372
+ <span class='ivar'>@xml_element</span> <span class='op'>=</span> <span class='id identifier rubyid_xml_element'>xml_element</span>
373
+ <span class='ivar'>@attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
374
+ <span class='ivar'>@rows</span> <span class='op'>=</span> <span class='kw'>nil</span>
375
+
376
+ <span class='comment'># Load the attribute configuration in the rowset block.
377
+ </span> <span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
378
+
379
+ <span class='comment'># Disable the #attribute method since the attributes have been configured.
380
+ </span> <span class='id identifier rubyid_define_singleton_method'>define_singleton_method</span><span class='lparen'>(</span><span class='symbol'>:attribute</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NoMethodError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>private method</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
381
+ <span class='kw'>end</span></pre>
382
+ </td>
383
+ </tr>
384
+ </table>
385
+ </div>
386
+
387
+ </div>
388
+
389
+ <div id="instance_attr_details" class="attr_details">
390
+ <h2>Instance Attribute Details</h2>
391
+
392
+
393
+ <span id=""></span>
394
+ <div class="method_details first">
395
+ <h3 class="signature first" id="name-instance_method">
396
+
397
+ #<strong>name</strong> &#x21d2; <tt>Symbol</tt> <span class="extras">(readonly)</span>
398
+
399
+
400
+
401
+
402
+
403
+ </h3><div class="docstring">
404
+ <div class="discussion">
405
+
406
+ <p>Returns name of the rowset</p>
407
+
408
+
409
+ </div>
410
+ </div>
411
+ <div class="tags">
412
+
413
+ <p class="tag_title">Returns:</p>
414
+ <ul class="return">
415
+
416
+ <li>
417
+
418
+
419
+ <span class='type'>(<tt>Symbol</tt>)</span>
420
+
421
+
422
+
423
+ &mdash;
424
+ <div class='inline'>
425
+ <p>name of the rowset</p>
426
+ </div>
427
+
428
+ </li>
429
+
430
+ </ul>
431
+
432
+ </div><table class="source_code">
433
+ <tr>
434
+ <td>
435
+ <pre class="lines">
436
+
437
+
438
+ 9
439
+ 10
440
+ 11</pre>
441
+ </td>
442
+ <td>
443
+ <pre class="code"><span class="info file"># File 'lib/greeve/rowset.rb', line 9</span>
444
+
445
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
446
+ <span class='ivar'>@name</span>
447
+ <span class='kw'>end</span></pre>
448
+ </td>
449
+ </tr>
450
+ </table>
451
+ </div>
452
+
453
+ </div>
454
+
455
+
456
+ <div id="instance_method_details" class="method_details_list">
457
+ <h2>Instance Method Details</h2>
458
+
459
+
460
+ <div class="method_details first">
461
+ <h3 class="signature first" id="each-instance_method">
462
+
463
+ #<strong>each</strong>(&amp;block) &#x21d2; <tt>Object</tt>
464
+
465
+
466
+
467
+
468
+
469
+ </h3><div class="docstring">
470
+ <div class="discussion">
471
+
472
+ <p>:nodoc:</p>
473
+
474
+
475
+ </div>
476
+ </div>
477
+ <div class="tags">
478
+
479
+
480
+ </div><table class="source_code">
481
+ <tr>
482
+ <td>
483
+ <pre class="lines">
484
+
485
+
486
+ 28
487
+ 29
488
+ 30</pre>
489
+ </td>
490
+ <td>
491
+ <pre class="code"><span class="info file"># File 'lib/greeve/rowset.rb', line 28</span>
492
+
493
+ <span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
494
+ <span class='id identifier rubyid_rows'>rows</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
495
+ <span class='kw'>end</span></pre>
496
+ </td>
497
+ </tr>
498
+ </table>
499
+ </div>
500
+
501
+ <div class="method_details ">
502
+ <h3 class="signature " id="inspect-instance_method">
503
+
504
+ #<strong>inspect</strong> &#x21d2; <tt>Object</tt>
505
+
506
+
507
+
508
+
509
+
510
+ </h3><div class="docstring">
511
+ <div class="discussion">
512
+
513
+ <p>:nodoc:</p>
514
+
515
+
516
+ </div>
517
+ </div>
518
+ <div class="tags">
519
+
520
+
521
+ </div><table class="source_code">
522
+ <tr>
523
+ <td>
524
+ <pre class="lines">
525
+
526
+
527
+ 38
528
+ 39
529
+ 40</pre>
530
+ </td>
531
+ <td>
532
+ <pre class="code"><span class="info file"># File 'lib/greeve/rowset.rb', line 38</span>
533
+
534
+ <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
535
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#&lt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object_id'>object_id</span><span class='embexpr_end'>}</span><span class='tstring_content'> name: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</span><span class='tstring_content'>&gt;</span><span class='tstring_end'>&quot;</span></span>
536
+ <span class='kw'>end</span></pre>
537
+ </td>
538
+ </tr>
539
+ </table>
540
+ </div>
541
+
542
+ <div class="method_details ">
543
+ <h3 class="signature " id="to_a-instance_method">
544
+
545
+ #<strong>to_a</strong> &#x21d2; <tt>Array</tt>
546
+
547
+
548
+
549
+
550
+
551
+ </h3><div class="docstring">
552
+ <div class="discussion">
553
+
554
+ <p>Returns an array of rows and their non-nil attributes</p>
555
+
556
+
557
+ </div>
558
+ </div>
559
+ <div class="tags">
560
+
561
+ <p class="tag_title">Returns:</p>
562
+ <ul class="return">
563
+
564
+ <li>
565
+
566
+
567
+ <span class='type'>(<tt>Array</tt>)</span>
568
+
569
+
570
+
571
+ &mdash;
572
+ <div class='inline'>
573
+ <p>an array of rows and their non-nil attributes</p>
574
+ </div>
575
+
576
+ </li>
577
+
578
+ </ul>
579
+
580
+ </div><table class="source_code">
581
+ <tr>
582
+ <td>
583
+ <pre class="lines">
584
+
585
+
586
+ 33
587
+ 34
588
+ 35</pre>
589
+ </td>
590
+ <td>
591
+ <pre class="code"><span class="info file"># File 'lib/greeve/rowset.rb', line 33</span>
592
+
593
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_a'>to_a</span>
594
+ <span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_h</span><span class='rparen'>)</span>
595
+ <span class='kw'>end</span></pre>
596
+ </td>
597
+ </tr>
598
+ </table>
599
+ </div>
600
+
601
+ </div>
602
+
603
+ </div>
604
+
605
+ <div id="footer">
606
+ Generated on Wed Aug 24 18:52:46 2016 by
607
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
608
+ 0.9.5 (ruby-2.1.7).
609
+ </div>
610
+
611
+ </div>
612
+ </body>
613
+ </html>