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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Cinisis Database Reader: IsisMap Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>IsisMap Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="IsisMap" --><!-- doxytag: inherits="IsisReader" --><div class="dynheader">
Inheritance diagram for IsisMap:</div>
<div class="dyncontent">
<div class="center">
<img src="classIsisMap.png" usemap="#IsisMap_map" alt=""/>
<map id="IsisMap_map" name="IsisMap_map">
<area href="classIsisReader.html" alt="IsisReader" shape="rect" coords="0,0,89,24"/>
<area href="classIsisConnector.html" alt="IsisConnector" shape="rect" coords="0,112,89,136"/>
<area href="classIsisFinder.html" alt="IsisFinder" shape="rect" coords="0,168,89,192"/>
<area href="classIsisAudit.html" alt="IsisAudit" shape="rect" coords="0,224,89,248"/>
</map>
</div>
<p><a href="classIsisMap-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#af689f27e67b0b38a3e880ead17a487f5">getMainItemName</a> ($field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#ad0b61ec2fbfb011db4bf89c5f54efab4">getSubfieldList</a> ($field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a29eb2c45b51f95fdfb9ff7af770ca6ce">getMap</a> ($field, $subfield=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a62b933be483fb6704e12e41f10286cd5">getMapType</a> ($field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#af94e1fc5d73a6272f04a60c0acaeb409">fieldHasMap</a> ($field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#ab5493af644e529c11a3c3e6edc37c3b9">subfieldHasMap</a> ($field, $subfield)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#ae5d904b8407b38751656715fb9efd7cf">getSubfieldKey</a> ($field, $subfield)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a994934784caa4149737bda55160a459f">getItemKey</a> ($field, $item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#ac6a4eed048ddfa62c76e6d813754af81">getFieldKey</a> ($field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#aee1953b6e46b1612c725b2da82414d14">getFieldArray</a> ($field_key)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a58d739ea1f014befdafef7035d46c074">getSubfieldName</a> ($field, $subfield_key, $by_key=FALSE)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a1f30d131831b036271b0a1ff6d5d9d68">getSubfieldNames</a> ($field_key)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#ae41313537e399f15ff16a4db887cf5b9">getFieldName</a> ($field_key)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a157fffbdb6c533a66e3f73674bfd8ea4">getFieldNames</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a2ca9d83aad166eed936f6f9ef8df05e3">getFullMap</a> ($field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a64c7193dd61a21c1af3624152d31ee51">getAttributes</a> ($field, $subfield=null)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a57808b2ac5892d71308c629b6ae990ff">getDeniedCombinations</a> ($field)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#af80aedabfeca623a9022dfcbc95d591c">methodName</a> ($type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#ae2abf0591a4862f537fa23537ffca705">normalizeFieldName</a> ($name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classIsisMap.html#a7f1b9b1cce7a02dea704a40ca85e2117">mapName</a> ($name)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provides mappings and schema functionalities around <a class="el" href="classCinisis.html">Cinisis</a>. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af94e1fc5d73a6272f04a60c0acaeb409"></a><!-- doxytag: member="IsisMap::fieldHasMap" ref="af94e1fc5d73a6272f04a60c0acaeb409" args="($field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::fieldHasMap </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check on an ISIS schema whether a field has a map.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if field has a map, FALSE otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a64c7193dd61a21c1af3624152d31ee51"></a><!-- doxytag: member="IsisMap::getAttributes" ref="a64c7193dd61a21c1af3624152d31ee51" args="($field, $subfield=null)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getAttributes </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>subfield</em> = <code>null</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get attributes based on field and subfield.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field data from ISIS database schema.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Attributes. </dd></dl>
</div>
</div>
<a class="anchor" id="a57808b2ac5892d71308c629b6ae990ff"></a><!-- doxytag: member="IsisMap::getDeniedCombinations" ref="a57808b2ac5892d71308c629b6ae990ff" args="($field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getDeniedCombinations </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Defines the denied field combinations.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field data from ISIS database schema.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Denied field combinations. </dd></dl>
<p><p>Sample denied combination.</p>
<p>$sample = array( 0 => array('a', 'b', 'c'), // a AND b AND c OR 1 => array('a', 'c', '!d'), // a AND b BUT WITHOUT d OR 2 => array('a', 'b', '*'), // a AND b AND any other item OR 3 => array('*2'), // ANY two items together OR 4 => array('main', '*'), // main AND ANY other item OR );</p>
</p>
</div>
</div>
<a class="anchor" id="aee1953b6e46b1612c725b2da82414d14"></a><!-- doxytag: member="IsisMap::getFieldArray" ref="aee1953b6e46b1612c725b2da82414d14" args="($field_key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getFieldArray </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field_key</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the array which defines a field.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field_key</em> </td><td>Field key.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Field array. </dd></dl>
</div>
</div>
<a class="anchor" id="ac6a4eed048ddfa62c76e6d813754af81"></a><!-- doxytag: member="IsisMap::getFieldKey" ref="ac6a4eed048ddfa62c76e6d813754af81" args="($field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getFieldKey </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the key of a field entry.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Field key. </dd></dl>
</div>
</div>
<a class="anchor" id="ae41313537e399f15ff16a4db887cf5b9"></a><!-- doxytag: member="IsisMap::getFieldName" ref="ae41313537e399f15ff16a4db887cf5b9" args="($field_key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getFieldName </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field_key</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a field name.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field_key</em> </td><td>Field key.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Field name. </dd></dl>
</div>
</div>
<a class="anchor" id="a157fffbdb6c533a66e3f73674bfd8ea4"></a><!-- doxytag: member="IsisMap::getFieldNames" ref="a157fffbdb6c533a66e3f73674bfd8ea4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getFieldNames </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get all field names.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with field names. </dd></dl>
</div>
</div>
<a class="anchor" id="a2ca9d83aad166eed936f6f9ef8df05e3"></a><!-- doxytag: member="IsisMap::getFullMap" ref="a2ca9d83aad166eed936f6f9ef8df05e3" args="($field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getFullMap </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the full map.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field key.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with full map or false if there is no map. </dd></dl>
</div>
</div>
<a class="anchor" id="a994934784caa4149737bda55160a459f"></a><!-- doxytag: member="IsisMap::getItemKey" ref="a994934784caa4149737bda55160a459f" args="($field, $item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getItemKey </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>item</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the item key.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$item</em> </td><td>Item name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Item key. </dd></dl>
</div>
</div>
<a class="anchor" id="af689f27e67b0b38a3e880ead17a487f5"></a><!-- doxytag: member="IsisMap::getMainItemName" ref="af689f27e67b0b38a3e880ead17a487f5" args="($field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getMainItemName </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the main field name.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field data from ISIS database schema.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Main field name. </dd></dl>
</div>
</div>
<a class="anchor" id="a29eb2c45b51f95fdfb9ff7af770ca6ce"></a><!-- doxytag: member="IsisMap::getMap" ref="a29eb2c45b51f95fdfb9ff7af770ca6ce" args="($field, $subfield=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getMap </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>subfield</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine which model field an ISIS db field should be mapped to. When importing an ISIS database to another system, a mapping provided in the database schema can be used to put the originating entries (fields and subfields) in the right place at the destination database.</p>
<p>Map format:</p>
<p>map: type: relation</p>
<p>map: type: value field: dest subfields: a: dest b: dest</p>
<p>Examples:</p>
<p>map: type: Performer</p>
<p>map: type: value field: title subfields: a: subtitle</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A map destination to the field or subfield. </dd></dl>
</div>
</div>
<a class="anchor" id="a62b933be483fb6704e12e41f10286cd5"></a><!-- doxytag: member="IsisMap::getMapType" ref="a62b933be483fb6704e12e41f10286cd5" args="($field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getMapType </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the mapping type of a given field.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The mapping type. </dd></dl>
</div>
</div>
<a class="anchor" id="ae5d904b8407b38751656715fb9efd7cf"></a><!-- doxytag: member="IsisMap::getSubfieldKey" ref="ae5d904b8407b38751656715fb9efd7cf" args="($field, $subfield)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getSubfieldKey </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>subfield</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the key of a subfield entry.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Subfield key. </dd></dl>
</div>
</div>
<a class="anchor" id="ad0b61ec2fbfb011db4bf89c5f54efab4"></a><!-- doxytag: member="IsisMap::getSubfieldList" ref="ad0b61ec2fbfb011db4bf89c5f54efab4" args="($field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getSubfieldList </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the list of subfields from a given field.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a58d739ea1f014befdafef7035d46c074"></a><!-- doxytag: member="IsisMap::getSubfieldName" ref="a58d739ea1f014befdafef7035d46c074" args="($field, $subfield_key, $by_key=FALSE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getSubfieldName </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>subfield_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>by_key</em> = <code>FALSE</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a subfield name.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field name or key.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$subfield_key</em> </td><td>Subfield key.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$by_key</em> </td><td>Set to true if you're passing the field key instead of it's name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Subfield name. </dd></dl>
</div>
</div>
<a class="anchor" id="a1f30d131831b036271b0a1ff6d5d9d68"></a><!-- doxytag: member="IsisMap::getSubfieldNames" ref="a1f30d131831b036271b0a1ff6d5d9d68" args="($field_key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::getSubfieldNames </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field_key</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get all subfield names.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field_key</em> </td><td>Field key.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with subfield names. </dd></dl>
</div>
</div>
<a class="anchor" id="a7f1b9b1cce7a02dea704a40ca85e2117"></a><!-- doxytag: member="IsisMap::mapName" ref="a7f1b9b1cce7a02dea704a40ca85e2117" args="($name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static IsisMap::mapName </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a map name.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>Field name</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Map name </dd></dl>
</div>
</div>
<a class="anchor" id="af80aedabfeca623a9022dfcbc95d591c"></a><!-- doxytag: member="IsisMap::methodName" ref="af80aedabfeca623a9022dfcbc95d591c" args="($type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static IsisMap::methodName </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>type</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Guess a method name from a type.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$type</em> </td><td>Mapping type.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Method name. </dd></dl>
</div>
</div>
<a class="anchor" id="ae2abf0591a4862f537fa23537ffca705"></a><!-- doxytag: member="IsisMap::normalizeFieldName" ref="ae2abf0591a4862f537fa23537ffca705" args="($name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static IsisMap::normalizeFieldName </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Normalize field names.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>Field name</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Normalized field name </dd></dl>
</div>
</div>
<a class="anchor" id="ab5493af644e529c11a3c3e6edc37c3b9"></a><!-- doxytag: member="IsisMap::subfieldHasMap" ref="ab5493af644e529c11a3c3e6edc37c3b9" args="($field, $subfield)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsisMap::subfieldHasMap </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>subfield</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check on an ISIS schema whether a subfield has a map.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>$field</em> </td><td>Field array.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>$subfield</em> </td><td>Subfield name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if subfield has a map, FALSE otherwise. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>classes/IsisMap.php</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 23 2011 11:44:10 for Cinisis Database Reader by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
|
