1
<?xml version="1.0" encoding="ascii"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>vita.modules.s3xrc.s3rc.S3Vector</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="vita.modules.s3xrc-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
46
Package modules ::
47
<a href="vita.modules.s3xrc-module.html">Package s3xrc</a> ::
48
<a href="vita.modules.s3xrc.s3rc-module.html">Module s3rc</a> ::
53
<table cellpadding="0" cellspacing="0">
54
<!-- hide/show private -->
55
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56
onclick="toggle_private();">hide private</a>]</span></td></tr>
57
<tr><td align="right"><span class="options"
58
>[<a href="frames.html" target="_top">frames</a
59
>] | <a href="vita.modules.s3xrc.s3rc.S3Vector-class.html"
60
target="_top">no frames</a>]</span></td></tr>
65
<!-- ==================== CLASS DESCRIPTION ==================== -->
66
<h1 class="epydoc">Class S3Vector</h1><p class="nomargin-top"><span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector">source code</a></span></p>
67
<pre class="base-tree">
70
<strong class="uidshort">S3Vector</strong>
74
<p>Helper class for data imports</p>
76
<!-- ==================== INSTANCE METHODS ==================== -->
77
<a name="section-InstanceMethods"></a>
78
<table class="summary" border="1" cellpadding="3"
79
cellspacing="0" width="100%" bgcolor="white">
80
<tr bgcolor="#70b0f0" class="table-header">
81
<td colspan="2" class="table-header">
82
<table border="0" cellpadding="0" cellspacing="0" width="100%">
84
<td align="left"><span class="table-header">Instance Methods</span></td>
85
<td align="right" valign="top"
86
><span class="options">[<a href="#section-InstanceMethods"
87
class="privatelink" onclick="toggle_private();"
88
>hide private</a>]</span></td>
94
<td width="15%" align="right" valign="top" class="summary">
95
<span class="summary-type"> </span>
96
</td><td class="summary">
97
<table width="100%" cellpadding="0" cellspacing="0" border="0">
99
<td><span class="summary-sig"><a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
100
<span class="summary-sig-arg">manager</span>,
101
<span class="summary-sig-arg">prefix</span>,
102
<span class="summary-sig-arg">name</span>,
103
<span class="summary-sig-arg">id</span>,
104
<span class="summary-sig-arg">record</span>=<span class="summary-sig-default">None</span>,
105
<span class="summary-sig-arg">element</span>=<span class="summary-sig-default">None</span>,
106
<span class="summary-sig-arg">mtime</span>=<span class="summary-sig-default">None</span>,
107
<span class="summary-sig-arg">rmap</span>=<span class="summary-sig-default">None</span>,
108
<span class="summary-sig-arg">directory</span>=<span class="summary-sig-default">None</span>,
109
<span class="summary-sig-arg">permit</span>=<span class="summary-sig-default">None</span>,
110
<span class="summary-sig-arg">audit</span>=<span class="summary-sig-default">None</span>,
111
<span class="summary-sig-arg">sync</span>=<span class="summary-sig-default">None</span>,
112
<span class="summary-sig-arg">log</span>=<span class="summary-sig-default">None</span>,
113
<span class="summary-sig-arg">onvalidation</span>=<span class="summary-sig-default">None</span>,
114
<span class="summary-sig-arg">onaccept</span>=<span class="summary-sig-default">None</span>)</span><br />
116
<td align="right" valign="top">
117
<span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.__init__">source code</a></span>
126
<td width="15%" align="right" valign="top" class="summary">
127
<span class="summary-type"> </span>
128
</td><td class="summary">
129
<table width="100%" cellpadding="0" cellspacing="0" border="0">
131
<td><span class="summary-sig"><a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#get_resolution" class="summary-sig-name">get_resolution</a>(<span class="summary-sig-arg">self</span>,
132
<span class="summary-sig-arg">field</span>)</span><br />
133
Find Sync resolution for a particular field in this record</td>
134
<td align="right" valign="top">
135
<span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.get_resolution">source code</a></span>
144
<td width="15%" align="right" valign="top" class="summary">
145
<span class="summary-type"> </span>
146
</td><td class="summary">
147
<table width="100%" cellpadding="0" cellspacing="0" border="0">
149
<td><span class="summary-sig"><a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#commit" class="summary-sig-name">commit</a>(<span class="summary-sig-arg">self</span>)</span><br />
150
Commits the vector to the database</td>
151
<td align="right" valign="top">
152
<span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.commit">source code</a></span>
161
<td width="15%" align="right" valign="top" class="summary">
162
<span class="summary-type"> </span>
163
</td><td class="summary">
164
<table width="100%" cellpadding="0" cellspacing="0" border="0">
166
<td><span class="summary-sig"><a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#resolve" class="summary-sig-name">resolve</a>(<span class="summary-sig-arg">self</span>)</span><br />
167
Resolve references of this record</td>
168
<td align="right" valign="top">
169
<span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.resolve">source code</a></span>
178
<td width="15%" align="right" valign="top" class="summary">
179
<span class="summary-type"> </span>
180
</td><td class="summary">
181
<table width="100%" cellpadding="0" cellspacing="0" border="0">
183
<td><span class="summary-sig"><a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#writeback" class="summary-sig-name">writeback</a>(<span class="summary-sig-arg">self</span>,
184
<span class="summary-sig-arg">field</span>,
185
<span class="summary-sig-arg">value</span>)</span><br />
186
Update a field in the record</td>
187
<td align="right" valign="top">
188
<span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.writeback">source code</a></span>
197
<td colspan="2" class="summary">
198
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
199
<code>__delattr__</code>,
200
<code>__format__</code>,
201
<code>__getattribute__</code>,
202
<code>__hash__</code>,
203
<code>__new__</code>,
204
<code>__reduce__</code>,
205
<code>__reduce_ex__</code>,
206
<code>__repr__</code>,
207
<code>__setattr__</code>,
208
<code>__sizeof__</code>,
209
<code>__str__</code>,
210
<code>__subclasshook__</code>
215
<!-- ==================== CLASS VARIABLES ==================== -->
216
<a name="section-ClassVariables"></a>
217
<table class="summary" border="1" cellpadding="3"
218
cellspacing="0" width="100%" bgcolor="white">
219
<tr bgcolor="#70b0f0" class="table-header">
220
<td colspan="2" class="table-header">
221
<table border="0" cellpadding="0" cellspacing="0" width="100%">
223
<td align="left"><span class="table-header">Class Variables</span></td>
224
<td align="right" valign="top"
225
><span class="options">[<a href="#section-ClassVariables"
226
class="privatelink" onclick="toggle_private();"
227
>hide private</a>]</span></td>
233
<td width="15%" align="right" valign="top" class="summary">
234
<span class="summary-type"> </span>
235
</td><td class="summary">
236
<a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#METHOD" class="summary-name">METHOD</a> = <code title="Storage(CREATE= "create", UPDATE= "update")">Storage(CREATE= "create", UPDATE= "update")</code>
240
<td width="15%" align="right" valign="top" class="summary">
241
<span class="summary-type"> </span>
242
</td><td class="summary">
243
<a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#RESOLUTION" class="summary-name">RESOLUTION</a> = <code title="Storage(THIS= "THIS", OTHER= "OTHER", NEWER= "NEWER", MASTER= "MASTER"\
244
, MASTERCOPY= "MASTERCOPY")">Storage(THIS= "THIS", OTHER= "OTHER", NEWER= "NEW<code class="variable-ellipsis">...</code></code>
248
<td width="15%" align="right" valign="top" class="summary">
249
<span class="summary-type"> </span>
250
</td><td class="summary">
251
<a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#UID" class="summary-name">UID</a> = <code title=""uuid"">"uuid"</code>
255
<td width="15%" align="right" valign="top" class="summary">
256
<span class="summary-type"> </span>
257
</td><td class="summary">
258
<a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#MCI" class="summary-name">MCI</a> = <code title=""mci"">"mci"</code>
262
<td width="15%" align="right" valign="top" class="summary">
263
<span class="summary-type"> </span>
264
</td><td class="summary">
265
<a href="vita.modules.s3xrc.s3rc.S3Vector-class.html#MTIME" class="summary-name">MTIME</a> = <code title=""modified_on"">"modified_on"</code>
269
<!-- ==================== PROPERTIES ==================== -->
270
<a name="section-Properties"></a>
271
<table class="summary" border="1" cellpadding="3"
272
cellspacing="0" width="100%" bgcolor="white">
273
<tr bgcolor="#70b0f0" class="table-header">
274
<td colspan="2" class="table-header">
275
<table border="0" cellpadding="0" cellspacing="0" width="100%">
277
<td align="left"><span class="table-header">Properties</span></td>
278
<td align="right" valign="top"
279
><span class="options">[<a href="#section-Properties"
280
class="privatelink" onclick="toggle_private();"
281
>hide private</a>]</span></td>
287
<td colspan="2" class="summary">
288
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
289
<code>__class__</code>
294
<!-- ==================== METHOD DETAILS ==================== -->
295
<a name="section-MethodDetails"></a>
296
<table class="details" border="1" cellpadding="3"
297
cellspacing="0" width="100%" bgcolor="white">
298
<tr bgcolor="#70b0f0" class="table-header">
299
<td colspan="2" class="table-header">
300
<table border="0" cellpadding="0" cellspacing="0" width="100%">
302
<td align="left"><span class="table-header">Method Details</span></td>
303
<td align="right" valign="top"
304
><span class="options">[<a href="#section-MethodDetails"
305
class="privatelink" onclick="toggle_private();"
306
>hide private</a>]</span></td>
312
<a name="__init__"></a>
314
<table class="details" border="1" cellpadding="3"
315
cellspacing="0" width="100%" bgcolor="white">
317
<table width="100%" cellpadding="0" cellspacing="0" border="0">
318
<tr valign="top"><td>
319
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
320
<span class="sig-arg">manager</span>,
321
<span class="sig-arg">prefix</span>,
322
<span class="sig-arg">name</span>,
323
<span class="sig-arg">id</span>,
324
<span class="sig-arg">record</span>=<span class="sig-default">None</span>,
325
<span class="sig-arg">element</span>=<span class="sig-default">None</span>,
326
<span class="sig-arg">mtime</span>=<span class="sig-default">None</span>,
327
<span class="sig-arg">rmap</span>=<span class="sig-default">None</span>,
328
<span class="sig-arg">directory</span>=<span class="sig-default">None</span>,
329
<span class="sig-arg">permit</span>=<span class="sig-default">None</span>,
330
<span class="sig-arg">audit</span>=<span class="sig-default">None</span>,
331
<span class="sig-arg">sync</span>=<span class="sig-default">None</span>,
332
<span class="sig-arg">log</span>=<span class="sig-default">None</span>,
333
<span class="sig-arg">onvalidation</span>=<span class="sig-default">None</span>,
334
<span class="sig-arg">onaccept</span>=<span class="sig-default">None</span>)</span>
335
<br /><em class="fname">(Constructor)</em>
337
</td><td align="right" valign="top"
338
><span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.__init__">source code</a></span>
345
<dd><ul class="nomargin-top">
346
<li><strong class="pname"><code>manager</code></strong> - the resource controller</li>
347
<li><strong class="pname"><code>prefix</code></strong> - prefix of the resource name (=module name)</li>
348
<li><strong class="pname"><code>name</code></strong> - the resource name (=without prefix)</li>
349
<li><strong class="pname"><code>id</code></strong> - the target record ID</li>
350
<li><strong class="pname"><code>record</code></strong> - the record data to import</li>
351
<li><strong class="pname"><code>element</code></strong> - the corresponding element from the element tree</li>
352
<li><strong class="pname"><code>rmap</code></strong> - map of references for this record</li>
353
<li><strong class="pname"><code>directory</code></strong> - resource directory of the input tree</li>
354
<li><strong class="pname"><code>permit</code></strong> - permit hook (function to check table permissions)</li>
355
<li><strong class="pname"><code>audit</code></strong> - audit hook (function to audit table access)</li>
356
<li><strong class="pname"><code>sync</code></strong> - sync hook (function to resolve sync conflicts)</li>
357
<li><strong class="pname"><code>log</code></strong> - log hook (function to log imports)</li>
358
<li><strong class="pname"><code>onvalidation</code></strong> - extra function to validate records</li>
359
<li><strong class="pname"><code>onaccept</code></strong> - callback function for committed importes</li>
367
<a name="get_resolution"></a>
369
<table class="details" border="1" cellpadding="3"
370
cellspacing="0" width="100%" bgcolor="white">
372
<table width="100%" cellpadding="0" cellspacing="0" border="0">
373
<tr valign="top"><td>
374
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_resolution</span>(<span class="sig-arg">self</span>,
375
<span class="sig-arg">field</span>)</span>
377
</td><td align="right" valign="top"
378
><span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.get_resolution">source code</a></span>
382
<p>Find Sync resolution for a particular field in this record</p>
385
<dd><ul class="nomargin-top">
386
<li><strong class="pname"><code>field</code></strong> - the field name</li>
391
<a name="commit"></a>
393
<table class="details" border="1" cellpadding="3"
394
cellspacing="0" width="100%" bgcolor="white">
396
<table width="100%" cellpadding="0" cellspacing="0" border="0">
397
<tr valign="top"><td>
398
<h3 class="epydoc"><span class="sig"><span class="sig-name">commit</span>(<span class="sig-arg">self</span>)</span>
400
</td><td align="right" valign="top"
401
><span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.commit">source code</a></span>
405
<p>Commits the vector to the database</p>
408
<div class="fields"> <strong>To Do (2.3):</strong>
409
<ul class="nomargin-top">
411
propagate onvalidation errors properly to the element
414
propagate import errors properly to the importer
417
</div></td></tr></table>
419
<a name="resolve"></a>
421
<table class="details" border="1" cellpadding="3"
422
cellspacing="0" width="100%" bgcolor="white">
424
<table width="100%" cellpadding="0" cellspacing="0" border="0">
425
<tr valign="top"><td>
426
<h3 class="epydoc"><span class="sig"><span class="sig-name">resolve</span>(<span class="sig-arg">self</span>)</span>
428
</td><td align="right" valign="top"
429
><span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.resolve">source code</a></span>
433
<p>Resolve references of this record</p>
438
<a name="writeback"></a>
440
<table class="details" border="1" cellpadding="3"
441
cellspacing="0" width="100%" bgcolor="white">
443
<table width="100%" cellpadding="0" cellspacing="0" border="0">
444
<tr valign="top"><td>
445
<h3 class="epydoc"><span class="sig"><span class="sig-name">writeback</span>(<span class="sig-arg">self</span>,
446
<span class="sig-arg">field</span>,
447
<span class="sig-arg">value</span>)</span>
449
</td><td align="right" valign="top"
450
><span class="codelink"><a href="vita.modules.s3xrc.s3rc-pysrc.html#S3Vector.writeback">source code</a></span>
454
<p>Update a field in the record</p>
457
<dd><ul class="nomargin-top">
458
<li><strong class="pname"><code>field</code></strong> - field name</li>
459
<li><strong class="pname"><code>value</code></strong> - value to write</li>
465
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
466
<a name="section-ClassVariableDetails"></a>
467
<table class="details" border="1" cellpadding="3"
468
cellspacing="0" width="100%" bgcolor="white">
469
<tr bgcolor="#70b0f0" class="table-header">
470
<td colspan="2" class="table-header">
471
<table border="0" cellpadding="0" cellspacing="0" width="100%">
473
<td align="left"><span class="table-header">Class Variable Details</span></td>
474
<td align="right" valign="top"
475
><span class="options">[<a href="#section-ClassVariableDetails"
476
class="privatelink" onclick="toggle_private();"
477
>hide private</a>]</span></td>
483
<a name="METHOD"></a>
485
<table class="details" border="1" cellpadding="3"
486
cellspacing="0" width="100%" bgcolor="white">
488
<h3 class="epydoc">METHOD</h3>
494
<dd><table><tr><td><pre class="variable">
495
Storage(CREATE= "create", UPDATE= "update")
496
</pre></td></tr></table>
501
<a name="RESOLUTION"></a>
503
<table class="details" border="1" cellpadding="3"
504
cellspacing="0" width="100%" bgcolor="white">
506
<h3 class="epydoc">RESOLUTION</h3>
512
<dd><table><tr><td><pre class="variable">
513
Storage(THIS= "THIS", OTHER= "OTHER", NEWER= "NEWER", MASTER= "MASTER"<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
514
, MASTERCOPY= "MASTERCOPY")
515
</pre></td></tr></table>
522
<table class="details" border="1" cellpadding="3"
523
cellspacing="0" width="100%" bgcolor="white">
525
<h3 class="epydoc">UID</h3>
531
<dd><table><tr><td><pre class="variable">
533
</pre></td></tr></table>
540
<table class="details" border="1" cellpadding="3"
541
cellspacing="0" width="100%" bgcolor="white">
543
<h3 class="epydoc">MCI</h3>
549
<dd><table><tr><td><pre class="variable">
551
</pre></td></tr></table>
558
<table class="details" border="1" cellpadding="3"
559
cellspacing="0" width="100%" bgcolor="white">
561
<h3 class="epydoc">MTIME</h3>
567
<dd><table><tr><td><pre class="variable">
568
"modified_on"
569
</pre></td></tr></table>
575
<!-- ==================== NAVIGATION BAR ==================== -->
576
<table class="navbar" border="0" width="100%" cellpadding="0"
577
bgcolor="#a0c0ff" cellspacing="0">
580
<th> <a
581
href="vita.modules.s3xrc-module.html">Home</a> </th>
584
<th> <a
585
href="module-tree.html">Trees</a> </th>
588
<th> <a
589
href="identifier-index.html">Indices</a> </th>
592
<th> <a
593
href="help.html">Help</a> </th>
595
<!-- Project homepage -->
596
<th class="navbar" align="right" width="100%">
597
<table border="0" cellpadding="0" cellspacing="0">
598
<tr><th class="navbar" align="center"
603
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
605
<td align="left" class="footer">
606
Generated by Epydoc 3.0.1 on Fri Nov 26 22:53:52 2010
608
<td align="right" class="footer">
609
<a target="mainFrame" href="http://epydoc.sourceforge.net"
610
>http://epydoc.sourceforge.net</a>
615
<script type="text/javascript">
617
// Private objects are initially displayed (because if
618
// javascript is turned off then we want them to be
619
// visible); but by default, we want to hide them. So hide
620
// them unless we have a cookie that says to show them.