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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VOClient API: vocRegistry.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vocRegistry.c File Reference</h1><code>#include <stdio.h></code><br>
<code>#include <stdlib.h></code><br>
<code>#include <unistd.h></code><br>
<code>#include <signal.h></code><br>
<code>#include <errno.h></code><br>
<code>#include "VOClient.h"</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">RegResult </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#555aa2dc7ece17033e9399ed00ff4b78">voc_regSearch</a> (char *term1, char *term2, int orValues)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">High-level Registry query interface. <a href="#555aa2dc7ece17033e9399ed00ff4b78"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">RegResult </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#25e61b2c021394192ca8e74e96f45b28">voc_regSearchByService</a> (char *svc, char *term, int orValues)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search Registry using a search term and service constraint. <a href="#25e61b2c021394192ca8e74e96f45b28"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">RegQuery </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#cfd7f451139af07ff58c173d793b3962">voc_regQuery</a> (char *term, int orValues)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a RegistryQuery object. <a href="#cfd7f451139af07ff58c173d793b3962"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#eb0ee2e29939419af10cfbebc82e2110">voc_regAddSearchTerm</a> (RegQuery query, char *term, int orValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a search term to the specified query. <a href="#eb0ee2e29939419af10cfbebc82e2110"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#9b9e8c445ffb38711ef4ee345fa0f68d">voc_regRemoveSearchTerm</a> (RegQuery query, char *term)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a search term to the specified query. <a href="#9b9e8c445ffb38711ef4ee345fa0f68d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#8d63761f770b4327d44cd1c618ce186f">voc_regConstWaveband</a> (RegQuery query, char *waveband)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constrain the Registry search by waveband. <a href="#8d63761f770b4327d44cd1c618ce186f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae38f1ab3f9a3682971fd8edf339b20c"></a><!-- doxytag: member="vocRegistry.c::voc_regConstSvcType" ref="ae38f1ab3f9a3682971fd8edf339b20c" args="(RegQuery query, char *svcType)" -->
void </td><td class="memItemRight" valign="bottom"><b>voc_regConstSvcType</b> (RegQuery query, char *svcType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#494458ce877c4fa8442ff398873195b4">voc_regDALOnly</a> (RegQuery query, int value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the "DAL Only" flag. <a href="#494458ce877c4fa8442ff398873195b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#800645e5f4dc73bcf99730db9cb4d439">voc_regSortRes</a> (RegQuery query, int value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the resource "sort" flag. <a href="#800645e5f4dc73bcf99730db9cb4d439"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#4780f7c8975abf074f3b41e27c31a7e3">voc_regGetSTCount</a> (RegQuery query)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of search terms in the current query. <a href="#4780f7c8975abf074f3b41e27c31a7e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#6b8ad34f22f1c22e34b56dc0ff635355">voc_regGetQueryString</a> (RegQuery query)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current query as an http GET URL. <a href="#6b8ad34f22f1c22e34b56dc0ff635355"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">RegResult </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#cea0f3cbac1f593ad5899a5252803689">voc_regExecute</a> (RegQuery query)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the specified query. <a href="#cea0f3cbac1f593ad5899a5252803689"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#ac9bb69c156fbdae90cb33f396336995">voc_regExecuteRaw</a> (RegQuery query)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the specified query and return raw result string. <a href="#ac9bb69c156fbdae90cb33f396336995"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#b6ce658f8bb8803ad73c5c15ccdf7dd4">voc_resGetCount</a> (RegResult res)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a count of the number of results records. <a href="#b6ce658f8bb8803ad73c5c15ccdf7dd4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#c5376fa75dc000e0b820fd4e29e5cfaa">voc_resGetStr</a> (RegResult res, char *attribute, int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string-valued attribute from the result resource record. <a href="#c5376fa75dc000e0b820fd4e29e5cfaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#3dceef82335c216785372fdd9789cc0c">voc_resGetFloat</a> (RegResult res, char *attribute, int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a real-valued attribute from the result resource record. <a href="#3dceef82335c216785372fdd9789cc0c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="vocRegistry_8c.html#8b2e5aa46ad515427da01b9314434cef">voc_resGetInt</a> (RegResult res, char *attribute, int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an int-valued attribute from the result resource record. <a href="#8b2e5aa46ad515427da01b9314434cef"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8b9013ac3d6a8f93991444d8c8c5919"></a><!-- doxytag: member="vocRegistry.c::vo" ref="e8b9013ac3d6a8f93991444d8c8c5919" args="" -->
VOClient * </td><td class="memItemRight" valign="bottom"><b>vo</b></td></tr>
</table>
<hr><h2>Detailed Description</h2>
VOC_REGISTRYQUERY -- Utility code to act as a client interface to the NVO Registry service.<p>
RegistryQuery ----------------------<p>
High-Level Query:<p>
res = voc_regSearch (sql, keywords, orValues) res =voc_regSearchByService (svc, term, orValues)<p>
Programmatic Query:<p>
query = voc_regQuery (term, orValues) // OR keyword list?<p>
voc_regConstSvcType (query, svcType) // search constraints voc_regConstWaveband (query, waveband) voc_regDALOnly (query, value) voc_regSortRes (query, value)<p>
voc_regAddSearchTerm (query, term, orValue) // OR term w/ previous voc_regRemoveSearchTerm (query, term) // remove search term count = voc_regGetSTCount (query)<p>
str = voc_regGetQueryString (query) // GET form of query<p>
res = voc_regExecute (query) // return result obj str = voc_regExecuteRaw (query) // return raw XML<p>
RegistryQueryResult<p>
count = voc_resGetCount (res)<p>
str = voc_resGetStr (res, attribute, index) dval = voc_resGetFloat (res, attribute, index) ival = voc_resGetInt (res, attribute, index)<p>
For this implementation, we've chose to use the NVO Registry at JHU/STScI, specifically the QueryRegistry() method which provides a 'SimpleResource' form of the resource record. Support for the newer IVOA standard will be added later, for now we can quickly access the most commonly used fields of a resource using both a keyword and SQL form of the search.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Michael Fitzpatrick </dd></dl>
<dl class="version" compact><dt><b>Version:</b></dt><dd>July 2006 </dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="eb0ee2e29939419af10cfbebc82e2110"></a><!-- doxytag: member="vocRegistry.c::voc_regAddSearchTerm" ref="eb0ee2e29939419af10cfbebc82e2110" args="(RegQuery query, char *term, int orValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void voc_regAddSearchTerm </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>orValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a search term to the specified query.
<p>
VOC_REGADDSEARCHTERM -- Add a search term (sql predicate or keyword list) to the specified query.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>term</em> </td><td>keyword search term </td></tr>
<tr><td valign="top"></td><td valign="top"><em>orValues</em> </td><td>logically OR values? </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div><p>
<a class="anchor" name="8d63761f770b4327d44cd1c618ce186f"></a><!-- doxytag: member="vocRegistry.c::voc_regConstWaveband" ref="8d63761f770b4327d44cd1c618ce186f" args="(RegQuery query, char *waveband)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void voc_regConstWaveband </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>waveband</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constrain the Registry search by waveband.
<p>
Constrain the Registry search by service type.<p>
VOC_REGCONSTWAVEBAND -- Constrain the Registry search by waveband.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>waveband</em> </td><td>waveband string </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing</dd></dl>
VOC_REGCONSTSVCTYPE -- Constraing the Registry search by service type.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>svcType</em> </td><td>service type string </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div><p>
<a class="anchor" name="494458ce877c4fa8442ff398873195b4"></a><!-- doxytag: member="vocRegistry.c::voc_regDALOnly" ref="494458ce877c4fa8442ff398873195b4" args="(RegQuery query, int value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void voc_regDALOnly </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the "DAL Only" flag.
<p>
VOC_REGDALONLY -- Set the "DAL Only" flag. If set, we expand a resource search to break out the individual DAL services into separate results.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value of the DAL-only flag </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div><p>
<a class="anchor" name="cea0f3cbac1f593ad5899a5252803689"></a><!-- doxytag: member="vocRegistry.c::voc_regExecute" ref="cea0f3cbac1f593ad5899a5252803689" args="(RegQuery query)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RegResult voc_regExecute </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Execute the specified query.
<p>
VOC_REGEXECUTE -- Execute the specified query, returning a result object code or NULL.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>registry result object handle </dd></dl>
</div>
</div><p>
<a class="anchor" name="ac9bb69c156fbdae90cb33f396336995"></a><!-- doxytag: member="vocRegistry.c::voc_regExecuteRaw" ref="ac9bb69c156fbdae90cb33f396336995" args="(RegQuery query)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* voc_regExecuteRaw </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Execute the specified query and return raw result string.
<p>
VOC_REGEXECUTERAW -- Execute the specified query and return the raw resulting XML string.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>raw data return from data </dd></dl>
</div>
</div><p>
<a class="anchor" name="6b8ad34f22f1c22e34b56dc0ff635355"></a><!-- doxytag: member="vocRegistry.c::voc_regGetQueryString" ref="6b8ad34f22f1c22e34b56dc0ff635355" args="(RegQuery query)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* voc_regGetQueryString </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current query as an http GET URL.
<p>
VOC_REGGETQUERYSTRING -- Get the current query as an http GET URL.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>query URL </dd></dl>
</div>
</div><p>
<a class="anchor" name="4780f7c8975abf074f3b41e27c31a7e3"></a><!-- doxytag: member="vocRegistry.c::voc_regGetSTCount" ref="4780f7c8975abf074f3b41e27c31a7e3" args="(RegQuery query)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int voc_regGetSTCount </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of search terms in the current query.
<p>
VOC_REGGETSTCOUNT -- Get the number of search terms in the current query.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div><p>
<a class="anchor" name="cfd7f451139af07ff58c173d793b3962"></a><!-- doxytag: member="vocRegistry.c::voc_regQuery" ref="cfd7f451139af07ff58c173d793b3962" args="(char *term, int orValues)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RegQuery voc_regQuery </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>orValues</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a RegistryQuery object.
<p>
VOC_REGQUERY -- Create a RegistryQuery object.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>term</em> </td><td>keyword search term </td></tr>
<tr><td valign="top"></td><td valign="top"><em>orValues</em> </td><td>logically OR values? </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to Registry Query object </dd></dl>
</div>
</div><p>
<a class="anchor" name="9b9e8c445ffb38711ef4ee345fa0f68d"></a><!-- doxytag: member="vocRegistry.c::voc_regRemoveSearchTerm" ref="9b9e8c445ffb38711ef4ee345fa0f68d" args="(RegQuery query, char *term)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void voc_regRemoveSearchTerm </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>term</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a search term to the specified query.
<p>
VOC_REMOVESEARCHTERM -- Remove the search term from the query.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>term</em> </td><td>keyword search term </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div><p>
<a class="anchor" name="555aa2dc7ece17033e9399ed00ff4b78"></a><!-- doxytag: member="vocRegistry.c::voc_regSearch" ref="555aa2dc7ece17033e9399ed00ff4b78" args="(char *term1, char *term2, int orValues)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RegResult voc_regSearch </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>term1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>term2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>orValues</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
High-level Registry query interface.
<p>
VOC_REGSEARCH -- High-level procedure to form a query and execute it immediately. We allow that 'term1' may be a complex SQL WHERE predicate, and that 'term2' (or vice versa) is a search-keyword list. The 'orValues' applies to the keyword list (if present), otherwise it applies to the two search term elements. The default action if two terms are specified is to logically AND them.<p>
The thinking here is that one might want SIAP services for Quasars. This is easily expressed in an SQL form to get SIAP resources, however a Quasar may be known as a QSO, AGN, active-nuclei, etc and so we need a easy way to OR the keywords but AND that result with the SQL predicate.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>term1</em> </td><td>first search term </td></tr>
<tr><td valign="top"></td><td valign="top"><em>term2</em> </td><td>second search term </td></tr>
<tr><td valign="top"></td><td valign="top"><em>orValues</em> </td><td>logically OR values? </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to Registry result object </dd></dl>
</div>
</div><p>
<a class="anchor" name="25e61b2c021394192ca8e74e96f45b28"></a><!-- doxytag: member="vocRegistry.c::voc_regSearchByService" ref="25e61b2c021394192ca8e74e96f45b28" args="(char *svc, char *term, int orValues)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RegResult voc_regSearchByService </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>svc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>orValues</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Search Registry using a search term and service constraint.
<p>
VOC_REGSEARCHBYSERVICE -- Search the Registry using a search term and constrain by service type.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svc</em> </td><td>service type constraint </td></tr>
<tr><td valign="top"></td><td valign="top"><em>term</em> </td><td>keyword search term </td></tr>
<tr><td valign="top"></td><td valign="top"><em>orValues</em> </td><td>logically OR values? </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to Registry result object </dd></dl>
</div>
</div><p>
<a class="anchor" name="800645e5f4dc73bcf99730db9cb4d439"></a><!-- doxytag: member="vocRegistry.c::voc_regSortRes" ref="800645e5f4dc73bcf99730db9cb4d439" args="(RegQuery query, int value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void voc_regSortRes </td>
<td>(</td>
<td class="paramtype">RegQuery </td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the resource "sort" flag.
<p>
VOC_REGSORTRES -- Set the resource "sort" flag. If enabled, we try to order the resource table by some logical means.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>Registry query handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value of the sort flag </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>
</div>
</div><p>
<a class="anchor" name="b6ce658f8bb8803ad73c5c15ccdf7dd4"></a><!-- doxytag: member="vocRegistry.c::voc_resGetCount" ref="b6ce658f8bb8803ad73c5c15ccdf7dd4" args="(RegResult res)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int voc_resGetCount </td>
<td>(</td>
<td class="paramtype">RegResult </td>
<td class="paramname"> <em>res</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a count of the number of results records.
<p>
VOC_RESGETCOUNT -- Return a count of the number of results records.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>res</em> </td><td>Registry result handle </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>number of result records </dd></dl>
</div>
</div><p>
<a class="anchor" name="3dceef82335c216785372fdd9789cc0c"></a><!-- doxytag: member="vocRegistry.c::voc_resGetFloat" ref="3dceef82335c216785372fdd9789cc0c" args="(RegResult res, char *attribute, int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double voc_resGetFloat </td>
<td>(</td>
<td class="paramtype">RegResult </td>
<td class="paramname"> <em>res</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>attribute</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a real-valued attribute from the result resource record.
<p>
VOC_GETFLOAT -- Get a real-valued attribute from the result resource record. Currently recognized real-valued attributes include:<p>
MaxSR maximum search radius<p>
Attribute string are case-insensitive.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>res</em> </td><td>Registry result handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attr</em> </td><td>record attribute </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>record index </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string-valued attribute </dd></dl>
</div>
</div><p>
<a class="anchor" name="8b2e5aa46ad515427da01b9314434cef"></a><!-- doxytag: member="vocRegistry.c::voc_resGetInt" ref="8b2e5aa46ad515427da01b9314434cef" args="(RegResult res, char *attribute, int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int voc_resGetInt </td>
<td>(</td>
<td class="paramtype">RegResult </td>
<td class="paramname"> <em>res</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>attribute</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an int-valued attribute from the result resource record.
<p>
VOC_GETINT -- Get a integer-valued attribute from the result resource record. Currently recognized real-valued attributes include:<p>
MaxRecords maximum records returned by the service<p>
Attribute string are case-insensitive.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>res</em> </td><td>Registry result handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attr</em> </td><td>record attribute </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>record index </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string-valued attribute </dd></dl>
</div>
</div><p>
<a class="anchor" name="c5376fa75dc000e0b820fd4e29e5cfaa"></a><!-- doxytag: member="vocRegistry.c::voc_resGetStr" ref="c5376fa75dc000e0b820fd4e29e5cfaa" args="(RegResult res, char *attribute, int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* voc_resGetStr </td>
<td>(</td>
<td class="paramtype">RegResult </td>
<td class="paramname"> <em>res</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>attribute</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a string-valued attribute from the result resource record.
<p>
VOC_GETSTR -- Get a string-valued attribute from the result resource record. Currently recognized real-valued attributes include:<p>
Title Resource title (long version) ShortName Short name of Resource ServiceURL Service URL (if appropriate) ReferenceURL URL to reference about Resource Description Text description of resource Identifier Standard ivo identifier of resource ServiceType Service Type (Cone, Siap, etc) Type Resource Type (catalog, survey, etc) CoverageSpatial Spatial coverage (STC) CoverageTemporal Temporal coverage of data<p>
CoverageSpectral Spectral coverage (csv list of bandpasses) ContentLevel Content level (research, EPO, etc -- csv list)<p>
Attribute strings are case-insensitive.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>res</em> </td><td>Registry result handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attr</em> </td><td>record attribute </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>record index </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string-valued attribute </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:08:58 2013 for VOClient API by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
|
