pho 0.7.5 → 0.7.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. data/CHANGES +21 -0
  2. data/Rakefile +1 -1
  3. data/doc/rdoc/classes/Pho.html +0 -5
  4. data/doc/rdoc/classes/Pho/CommandLine.html +108 -108
  5. data/doc/rdoc/classes/Pho/DatatypeProperty.html +15 -15
  6. data/doc/rdoc/classes/Pho/Enrichment/StoreEnricher.html +3 -3
  7. data/doc/rdoc/classes/Pho/Etags.html +36 -36
  8. data/doc/rdoc/classes/Pho/Facet/Results.html +1 -1
  9. data/doc/rdoc/classes/Pho/FieldPredicateMap.html +106 -106
  10. data/doc/rdoc/classes/Pho/FieldWeighting.html +14 -14
  11. data/doc/rdoc/classes/Pho/Job.html +67 -68
  12. data/doc/rdoc/classes/Pho/Jobs.html +62 -62
  13. data/doc/rdoc/classes/Pho/OAI/Records.html +7 -6
  14. data/doc/rdoc/classes/Pho/OAI/Statistics.html +194 -0
  15. data/doc/rdoc/classes/Pho/QueryProfile.html +86 -81
  16. data/doc/rdoc/classes/Pho/ResourceHash.html +1 -1
  17. data/doc/rdoc/classes/Pho/ResourceHash/Converter.html +36 -35
  18. data/doc/rdoc/classes/Pho/ResourceHash/SetAlgebra.html +2 -3
  19. data/doc/rdoc/classes/Pho/Snapshot.html +36 -36
  20. data/doc/rdoc/classes/Pho/Sparql/SparqlClient.html +3 -4
  21. data/doc/rdoc/classes/Pho/Status.html +26 -26
  22. data/doc/rdoc/classes/Pho/Store.html +257 -254
  23. data/doc/rdoc/classes/Pho/StoreSparqlClient.html +14 -14
  24. data/doc/rdoc/classes/Pho/Update/Changeset.html +5 -6
  25. data/doc/rdoc/classes/Pho/Update/Changesets.html +2 -3
  26. data/doc/rdoc/classes/Pho/Update/Statement.html +3 -4
  27. data/doc/rdoc/classes/String.html +1 -1
  28. data/doc/rdoc/created.rid +1 -1
  29. data/doc/rdoc/files/CHANGES.html +33 -4
  30. data/doc/rdoc/files/lib/pho/converter_rb.html +1 -8
  31. data/doc/rdoc/files/lib/pho/oai_rb.html +1 -1
  32. data/doc/rdoc/files/lib/pho/query_profile_rb.html +1 -1
  33. data/doc/rdoc/files/lib/pho/store_rb.html +1 -1
  34. data/doc/rdoc/files/lib/pho_rb.html +5 -3
  35. data/doc/rdoc/fr_class_index.html +0 -2
  36. data/doc/rdoc/fr_file_index.html +0 -1
  37. data/doc/rdoc/fr_method_index.html +132 -136
  38. data/lib/pho.rb +7 -3
  39. data/lib/pho/converter.rb +23 -30
  40. data/lib/pho/oai.rb +5 -4
  41. data/lib/pho/query_profile.rb +6 -1
  42. data/lib/pho/store.rb +17 -12
  43. data/tests/tc_changeset_builder.rb +2 -2
  44. data/tests/tc_converter.rb +3 -3
  45. data/tests/tc_oai.rb +1 -1
  46. data/tests/tc_query_profile.rb +37 -1
  47. data/tests/ts_pho.rb +0 -1
  48. metadata +5 -9
  49. data/doc/rdoc/classes/Pho/RDF.html +0 -120
  50. data/doc/rdoc/classes/Pho/RDF/Parser.html +0 -279
  51. data/doc/rdoc/files/lib/pho/rdf_rb.html +0 -108
  52. data/lib/pho/rdf.rb +0 -76
  53. data/tests/tc_rdf_parser.rb +0 -37
@@ -93,8 +93,8 @@ href="QueryProfile.html">QueryProfile</a>
93
93
  <h3 class="section-bar">Methods</h3>
94
94
 
95
95
  <div class="name-list">
96
- <a href="#M000199">new</a>&nbsp;&nbsp;
97
- <a href="#M000200">to_rdf</a>&nbsp;&nbsp;
96
+ <a href="#M000195">new</a>&nbsp;&nbsp;
97
+ <a href="#M000196">to_rdf</a>&nbsp;&nbsp;
98
98
  </div>
99
99
  </div>
100
100
 
@@ -148,19 +148,19 @@ The weighting applied to the field
148
148
  <div id="methods">
149
149
  <h3 class="section-bar">Public Class methods</h3>
150
150
 
151
- <div id="method-M000199" class="method-detail">
152
- <a name="M000199"></a>
151
+ <div id="method-M000195" class="method-detail">
152
+ <a name="M000195"></a>
153
153
 
154
154
  <div class="method-heading">
155
- <a href="#M000199" class="method-signature">
155
+ <a href="#M000195" class="method-signature">
156
156
  <span class="method-name">new</span><span class="method-args">(uri, name, weight)</span>
157
157
  </a>
158
158
  </div>
159
159
 
160
160
  <div class="method-description">
161
161
  <p><a class="source-toggle" href="#"
162
- onclick="toggleCode('M000199-source');return false;">[Source]</a></p>
163
- <div class="method-source-code" id="M000199-source">
162
+ onclick="toggleCode('M000195-source');return false;">[Source]</a></p>
163
+ <div class="method-source-code" id="M000195-source">
164
164
  <pre>
165
165
  <span class="ruby-comment cmt"># File lib/pho/query_profile.rb, line 15</span>
166
166
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">weight</span>)
@@ -175,19 +175,19 @@ The weighting applied to the field
175
175
 
176
176
  <h3 class="section-bar">Public Instance methods</h3>
177
177
 
178
- <div id="method-M000200" class="method-detail">
179
- <a name="M000200"></a>
178
+ <div id="method-M000196" class="method-detail">
179
+ <a name="M000196"></a>
180
180
 
181
181
  <div class="method-heading">
182
- <a href="#M000200" class="method-signature">
182
+ <a href="#M000196" class="method-signature">
183
183
  <span class="method-name">to_rdf</span><span class="method-args">(ns=true)</span>
184
184
  </a>
185
185
  </div>
186
186
 
187
187
  <div class="method-description">
188
188
  <p>
189
- Convert this object into an <a href="RDF.html">RDF</a> representation.
190
- Generates a simple rdf:Description, optionally including namespaces
189
+ Convert this object into an RDF representation. Generates a simple
190
+ rdf:Description, optionally including namespaces
191
191
  </p>
192
192
  <table>
193
193
  <tr><td valign="top">ns:</td><td>include namespace declarations
@@ -195,8 +195,8 @@ Generates a simple rdf:Description, optionally including namespaces
195
195
  </td></tr>
196
196
  </table>
197
197
  <p><a class="source-toggle" href="#"
198
- onclick="toggleCode('M000200-source');return false;">[Source]</a></p>
199
- <div class="method-source-code" id="M000200-source">
198
+ onclick="toggleCode('M000196-source');return false;">[Source]</a></p>
199
+ <div class="method-source-code" id="M000196-source">
200
200
  <pre>
201
201
  <span class="ruby-comment cmt"># File lib/pho/query_profile.rb, line 23</span>
202
202
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_rdf</span>(<span class="ruby-identifier">ns</span>=<span class="ruby-keyword kw">true</span>)
@@ -101,16 +101,16 @@ about a specific <a href="Job.html">Job</a> from a platform store
101
101
  <h3 class="section-bar">Methods</h3>
102
102
 
103
103
  <div class="name-list">
104
- <a href="#M000206">completed?</a>&nbsp;&nbsp;
105
- <a href="#M000201">new</a>&nbsp;&nbsp;
106
- <a href="#M000203">parse</a>&nbsp;&nbsp;
107
- <a href="#M000204">progress_updates</a>&nbsp;&nbsp;
108
- <a href="#M000202">read_from_store</a>&nbsp;&nbsp;
109
- <a href="#M000208">running?</a>&nbsp;&nbsp;
110
- <a href="#M000205">started?</a>&nbsp;&nbsp;
111
- <a href="#M000207">successful?</a>&nbsp;&nbsp;
112
- <a href="#M000210">with_each</a>&nbsp;&nbsp;
113
- <a href="#M000209">with_first</a>&nbsp;&nbsp;
104
+ <a href="#M000202">completed?</a>&nbsp;&nbsp;
105
+ <a href="#M000197">new</a>&nbsp;&nbsp;
106
+ <a href="#M000199">parse</a>&nbsp;&nbsp;
107
+ <a href="#M000200">progress_updates</a>&nbsp;&nbsp;
108
+ <a href="#M000198">read_from_store</a>&nbsp;&nbsp;
109
+ <a href="#M000204">running?</a>&nbsp;&nbsp;
110
+ <a href="#M000201">started?</a>&nbsp;&nbsp;
111
+ <a href="#M000203">successful?</a>&nbsp;&nbsp;
112
+ <a href="#M000206">with_each</a>&nbsp;&nbsp;
113
+ <a href="#M000205">with_first</a>&nbsp;&nbsp;
114
114
  </div>
115
115
  </div>
116
116
 
@@ -255,11 +255,11 @@ URI of the job
255
255
  <div id="methods">
256
256
  <h3 class="section-bar">Public Class methods</h3>
257
257
 
258
- <div id="method-M000201" class="method-detail">
259
- <a name="M000201"></a>
258
+ <div id="method-M000197" class="method-detail">
259
+ <a name="M000197"></a>
260
260
 
261
261
  <div class="method-heading">
262
- <a href="#M000201" class="method-signature">
262
+ <a href="#M000197" class="method-signature">
263
263
  <span class="method-name">new</span><span class="method-args">(uri, label, type, start_time, created=nil)</span>
264
264
  </a>
265
265
  </div>
@@ -286,8 +286,8 @@ Constructor. Used in the reading/parsing code
286
286
  </td></tr>
287
287
  </table>
288
288
  <p><a class="source-toggle" href="#"
289
- onclick="toggleCode('M000201-source');return false;">[Source]</a></p>
290
- <div class="method-source-code" id="M000201-source">
289
+ onclick="toggleCode('M000197-source');return false;">[Source]</a></p>
290
+ <div class="method-source-code" id="M000197-source">
291
291
  <pre>
292
292
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 214</span>
293
293
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">label</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">start_time</span>, <span class="ruby-identifier">created</span>=<span class="ruby-keyword kw">nil</span>)
@@ -303,32 +303,31 @@ Constructor. Used in the reading/parsing code
303
303
  </div>
304
304
  </div>
305
305
 
306
- <div id="method-M000203" class="method-detail">
307
- <a name="M000203"></a>
306
+ <div id="method-M000199" class="method-detail">
307
+ <a name="M000199"></a>
308
308
 
309
309
  <div class="method-heading">
310
- <a href="#M000203" class="method-signature">
310
+ <a href="#M000199" class="method-signature">
311
311
  <span class="method-name">parse</span><span class="method-args">(uri, xml)</span>
312
312
  </a>
313
313
  </div>
314
314
 
315
315
  <div class="method-description">
316
316
  <p>
317
- Parses job metadata returned from the platform as <a
318
- href="RDF.html">RDF</a>/XML, creating a fully populated <a
319
- href="Job.html">Job</a> instance
317
+ Parses job metadata returned from the platform as RDF/XML, creating a fully
318
+ populated <a href="Job.html">Job</a> instance
320
319
  </p>
321
320
  <table>
322
321
  <tr><td valign="top">uri:</td><td>uri of the job to be parsed
323
322
 
324
323
  </td></tr>
325
- <tr><td valign="top">xml:</td><td>the <a href="RDF.html">RDF</a>/XML text to be parsed
324
+ <tr><td valign="top">xml:</td><td>the RDF/XML text to be parsed
326
325
 
327
326
  </td></tr>
328
327
  </table>
329
328
  <p><a class="source-toggle" href="#"
330
- onclick="toggleCode('M000203-source');return false;">[Source]</a></p>
331
- <div class="method-source-code" id="M000203-source">
329
+ onclick="toggleCode('M000199-source');return false;">[Source]</a></p>
330
+ <div class="method-source-code" id="M000199-source">
332
331
  <pre>
333
332
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 241</span>
334
333
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Job</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">xml</span>)
@@ -385,11 +384,11 @@ href="Job.html">Job</a> instance
385
384
  </div>
386
385
  </div>
387
386
 
388
- <div id="method-M000202" class="method-detail">
389
- <a name="M000202"></a>
387
+ <div id="method-M000198" class="method-detail">
388
+ <a name="M000198"></a>
390
389
 
391
390
  <div class="method-heading">
392
- <a href="#M000202" class="method-signature">
391
+ <a href="#M000198" class="method-signature">
393
392
  <span class="method-name">read_from_store</span><span class="method-args">(uri, store)</span>
394
393
  </a>
395
394
  </div>
@@ -407,8 +406,8 @@ Read a job from a store
407
406
  </td></tr>
408
407
  </table>
409
408
  <p><a class="source-toggle" href="#"
410
- onclick="toggleCode('M000202-source');return false;">[Source]</a></p>
411
- <div class="method-source-code" id="M000202-source">
409
+ onclick="toggleCode('M000198-source');return false;">[Source]</a></p>
410
+ <div class="method-source-code" id="M000198-source">
412
411
  <pre>
413
412
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 227</span>
414
413
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Job</span>.<span class="ruby-identifier">read_from_store</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">store</span>)
@@ -426,19 +425,19 @@ Read a job from a store
426
425
 
427
426
  <h3 class="section-bar">Protected Class methods</h3>
428
427
 
429
- <div id="method-M000210" class="method-detail">
430
- <a name="M000210"></a>
428
+ <div id="method-M000206" class="method-detail">
429
+ <a name="M000206"></a>
431
430
 
432
431
  <div class="method-heading">
433
- <a href="#M000210" class="method-signature">
432
+ <a href="#M000206" class="method-signature">
434
433
  <span class="method-name">with_each</span><span class="method-args">(el, xpath) {|ref_el| ...}</span>
435
434
  </a>
436
435
  </div>
437
436
 
438
437
  <div class="method-description">
439
438
  <p><a class="source-toggle" href="#"
440
- onclick="toggleCode('M000210-source');return false;">[Source]</a></p>
441
- <div class="method-source-code" id="M000210-source">
439
+ onclick="toggleCode('M000206-source');return false;">[Source]</a></p>
440
+ <div class="method-source-code" id="M000206-source">
442
441
  <pre>
443
442
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 327</span>
444
443
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Job</span>.<span class="ruby-identifier">with_each</span>(<span class="ruby-identifier">el</span>, <span class="ruby-identifier">xpath</span>)
@@ -454,19 +453,19 @@ Read a job from a store
454
453
  </div>
455
454
  </div>
456
455
 
457
- <div id="method-M000209" class="method-detail">
458
- <a name="M000209"></a>
456
+ <div id="method-M000205" class="method-detail">
457
+ <a name="M000205"></a>
459
458
 
460
459
  <div class="method-heading">
461
- <a href="#M000209" class="method-signature">
460
+ <a href="#M000205" class="method-signature">
462
461
  <span class="method-name">with_first</span><span class="method-args">(el, xpath) {|found_el| ...}</span>
463
462
  </a>
464
463
  </div>
465
464
 
466
465
  <div class="method-description">
467
466
  <p><a class="source-toggle" href="#"
468
- onclick="toggleCode('M000209-source');return false;">[Source]</a></p>
469
- <div class="method-source-code" id="M000209-source">
467
+ onclick="toggleCode('M000205-source');return false;">[Source]</a></p>
468
+ <div class="method-source-code" id="M000205-source">
470
469
  <pre>
471
470
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 320</span>
472
471
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Job</span>.<span class="ruby-identifier">with_first</span>(<span class="ruby-identifier">el</span>, <span class="ruby-identifier">xpath</span>)
@@ -482,22 +481,22 @@ Read a job from a store
482
481
 
483
482
  <h3 class="section-bar">Public Instance methods</h3>
484
483
 
485
- <div id="method-M000206" class="method-detail">
486
- <a name="M000206"></a>
484
+ <div id="method-M000202" class="method-detail">
485
+ <a name="M000202"></a>
487
486
 
488
487
  <div class="method-heading">
489
- <a href="#M000206" class="method-signature">
488
+ <a href="#M000202" class="method-signature">
490
489
  <span class="method-name">completed?</span><span class="method-args">()</span>
491
490
  </a>
492
491
  </div>
493
492
 
494
493
  <div class="method-description">
495
494
  <p>
496
- Has the job <a href="Job.html#M000206">completed?</a>
495
+ Has the job <a href="Job.html#M000202">completed?</a>
497
496
  </p>
498
497
  <p><a class="source-toggle" href="#"
499
- onclick="toggleCode('M000206-source');return false;">[Source]</a></p>
500
- <div class="method-source-code" id="M000206-source">
498
+ onclick="toggleCode('M000202-source');return false;">[Source]</a></p>
499
+ <div class="method-source-code" id="M000202-source">
501
500
  <pre>
502
501
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 304</span>
503
502
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">completed?</span>
@@ -508,19 +507,19 @@ Has the job <a href="Job.html#M000206">completed?</a>
508
507
  </div>
509
508
  </div>
510
509
 
511
- <div id="method-M000204" class="method-detail">
512
- <a name="M000204"></a>
510
+ <div id="method-M000200" class="method-detail">
511
+ <a name="M000200"></a>
513
512
 
514
513
  <div class="method-heading">
515
- <a href="#M000204" class="method-signature">
514
+ <a href="#M000200" class="method-signature">
516
515
  <span class="method-name">progress_updates</span><span class="method-args">()</span>
517
516
  </a>
518
517
  </div>
519
518
 
520
519
  <div class="method-description">
521
520
  <p><a class="source-toggle" href="#"
522
- onclick="toggleCode('M000204-source');return false;">[Source]</a></p>
523
- <div class="method-source-code" id="M000204-source">
521
+ onclick="toggleCode('M000200-source');return false;">[Source]</a></p>
522
+ <div class="method-source-code" id="M000200-source">
524
523
  <pre>
525
524
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 291</span>
526
525
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">progress_updates</span>()
@@ -534,22 +533,22 @@ Has the job <a href="Job.html#M000206">completed?</a>
534
533
  </div>
535
534
  </div>
536
535
 
537
- <div id="method-M000208" class="method-detail">
538
- <a name="M000208"></a>
536
+ <div id="method-M000204" class="method-detail">
537
+ <a name="M000204"></a>
539
538
 
540
539
  <div class="method-heading">
541
- <a href="#M000208" class="method-signature">
540
+ <a href="#M000204" class="method-signature">
542
541
  <span class="method-name">running?</span><span class="method-args">()</span>
543
542
  </a>
544
543
  </div>
545
544
 
546
545
  <div class="method-description">
547
546
  <p>
548
- Is the job still <a href="Job.html#M000208">running?</a>
547
+ Is the job still <a href="Job.html#M000204">running?</a>
549
548
  </p>
550
549
  <p><a class="source-toggle" href="#"
551
- onclick="toggleCode('M000208-source');return false;">[Source]</a></p>
552
- <div class="method-source-code" id="M000208-source">
550
+ onclick="toggleCode('M000204-source');return false;">[Source]</a></p>
551
+ <div class="method-source-code" id="M000204-source">
553
552
  <pre>
554
553
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 314</span>
555
554
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">running?</span>
@@ -560,22 +559,22 @@ Is the job still <a href="Job.html#M000208">running?</a>
560
559
  </div>
561
560
  </div>
562
561
 
563
- <div id="method-M000205" class="method-detail">
564
- <a name="M000205"></a>
562
+ <div id="method-M000201" class="method-detail">
563
+ <a name="M000201"></a>
565
564
 
566
565
  <div class="method-heading">
567
- <a href="#M000205" class="method-signature">
566
+ <a href="#M000201" class="method-signature">
568
567
  <span class="method-name">started?</span><span class="method-args">()</span>
569
568
  </a>
570
569
  </div>
571
570
 
572
571
  <div class="method-description">
573
572
  <p>
574
- Has the job <a href="Job.html#M000205">started?</a>
573
+ Has the job <a href="Job.html#M000201">started?</a>
575
574
  </p>
576
575
  <p><a class="source-toggle" href="#"
577
- onclick="toggleCode('M000205-source');return false;">[Source]</a></p>
578
- <div class="method-source-code" id="M000205-source">
576
+ onclick="toggleCode('M000201-source');return false;">[Source]</a></p>
577
+ <div class="method-source-code" id="M000201-source">
579
578
  <pre>
580
579
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 299</span>
581
580
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">started?</span>
@@ -586,22 +585,22 @@ Has the job <a href="Job.html#M000205">started?</a>
586
585
  </div>
587
586
  </div>
588
587
 
589
- <div id="method-M000207" class="method-detail">
590
- <a name="M000207"></a>
588
+ <div id="method-M000203" class="method-detail">
589
+ <a name="M000203"></a>
591
590
 
592
591
  <div class="method-heading">
593
- <a href="#M000207" class="method-signature">
592
+ <a href="#M000203" class="method-signature">
594
593
  <span class="method-name">successful?</span><span class="method-args">()</span>
595
594
  </a>
596
595
  </div>
597
596
 
598
597
  <div class="method-description">
599
598
  <p>
600
- Was the job <a href="Job.html#M000207">successful?</a>
599
+ Was the job <a href="Job.html#M000203">successful?</a>
601
600
  </p>
602
601
  <p><a class="source-toggle" href="#"
603
- onclick="toggleCode('M000207-source');return false;">[Source]</a></p>
604
- <div class="method-source-code" id="M000207-source">
602
+ onclick="toggleCode('M000203-source');return false;">[Source]</a></p>
603
+ <div class="method-source-code" id="M000203-source">
605
604
  <pre>
606
605
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 309</span>
607
606
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">successful?</span>
@@ -92,16 +92,16 @@ TODO job deletion
92
92
  <h3 class="section-bar">Methods</h3>
93
93
 
94
94
  <div class="name-list">
95
- <a href="#M000152">build_job_request</a>&nbsp;&nbsp;
96
- <a href="#M000146">read_from_store</a>&nbsp;&nbsp;
97
- <a href="#M000151">submit_job</a>&nbsp;&nbsp;
98
- <a href="#M000148">submit_reindex</a>&nbsp;&nbsp;
99
- <a href="#M000147">submit_reset</a>&nbsp;&nbsp;
100
- <a href="#M000150">submit_restore</a>&nbsp;&nbsp;
101
- <a href="#M000149">submit_snapshot</a>&nbsp;&nbsp;
102
- <a href="#M000154">wait_for</a>&nbsp;&nbsp;
103
- <a href="#M000153">wait_for_submitted</a>&nbsp;&nbsp;
104
- <a href="#M000155">yield_job_update</a>&nbsp;&nbsp;
95
+ <a href="#M000148">build_job_request</a>&nbsp;&nbsp;
96
+ <a href="#M000142">read_from_store</a>&nbsp;&nbsp;
97
+ <a href="#M000147">submit_job</a>&nbsp;&nbsp;
98
+ <a href="#M000144">submit_reindex</a>&nbsp;&nbsp;
99
+ <a href="#M000143">submit_reset</a>&nbsp;&nbsp;
100
+ <a href="#M000146">submit_restore</a>&nbsp;&nbsp;
101
+ <a href="#M000145">submit_snapshot</a>&nbsp;&nbsp;
102
+ <a href="#M000150">wait_for</a>&nbsp;&nbsp;
103
+ <a href="#M000149">wait_for_submitted</a>&nbsp;&nbsp;
104
+ <a href="#M000151">yield_job_update</a>&nbsp;&nbsp;
105
105
  </div>
106
106
  </div>
107
107
 
@@ -151,19 +151,19 @@ TODO job deletion
151
151
  <div id="methods">
152
152
  <h3 class="section-bar">Public Class methods</h3>
153
153
 
154
- <div id="method-M000152" class="method-detail">
155
- <a name="M000152"></a>
154
+ <div id="method-M000148" class="method-detail">
155
+ <a name="M000148"></a>
156
156
 
157
157
  <div class="method-heading">
158
- <a href="#M000152" class="method-signature">
158
+ <a href="#M000148" class="method-signature">
159
159
  <span class="method-name">build_job_request</span><span class="method-args">(type, label, t=Time.now, snapshot_uri=nil)</span>
160
160
  </a>
161
161
  </div>
162
162
 
163
163
  <div class="method-description">
164
164
  <p>
165
- Construct an <a href="RDF.html">RDF</a>/XML document containing a job
166
- request for submitting to the Platform.
165
+ Construct an RDF/XML document containing a job request for submitting to
166
+ the Platform.
167
167
  </p>
168
168
  <table>
169
169
  <tr><td valign="top">t:</td><td>a Time object, specifying the time at which the request should be carried
@@ -172,8 +172,8 @@ out
172
172
  </td></tr>
173
173
  </table>
174
174
  <p><a class="source-toggle" href="#"
175
- onclick="toggleCode('M000152-source');return false;">[Source]</a></p>
176
- <div class="method-source-code" id="M000152-source">
175
+ onclick="toggleCode('M000148-source');return false;">[Source]</a></p>
176
+ <div class="method-source-code" id="M000148-source">
177
177
  <pre>
178
178
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 79</span>
179
179
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">build_job_request</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">label</span>, <span class="ruby-identifier">t</span>=<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>, <span class="ruby-identifier">snapshot_uri</span>=<span class="ruby-keyword kw">nil</span>)
@@ -200,11 +200,11 @@ out
200
200
  </div>
201
201
  </div>
202
202
 
203
- <div id="method-M000146" class="method-detail">
204
- <a name="M000146"></a>
203
+ <div id="method-M000142" class="method-detail">
204
+ <a name="M000142"></a>
205
205
 
206
206
  <div class="method-heading">
207
- <a href="#M000146" class="method-signature">
207
+ <a href="#M000142" class="method-signature">
208
208
  <span class="method-name">read_from_store</span><span class="method-args">(store)</span>
209
209
  </a>
210
210
  </div>
@@ -218,8 +218,8 @@ an array of job names
218
218
  store:: store from which to read the scheduled job list
219
219
  </pre>
220
220
  <p><a class="source-toggle" href="#"
221
- onclick="toggleCode('M000146-source');return false;">[Source]</a></p>
222
- <div class="method-source-code" id="M000146-source">
221
+ onclick="toggleCode('M000142-source');return false;">[Source]</a></p>
222
+ <div class="method-source-code" id="M000142-source">
223
223
  <pre>
224
224
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 16</span>
225
225
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">read_from_store</span>(<span class="ruby-identifier">store</span>)
@@ -241,11 +241,11 @@ an array of job names
241
241
  </div>
242
242
  </div>
243
243
 
244
- <div id="method-M000151" class="method-detail">
245
- <a name="M000151"></a>
244
+ <div id="method-M000147" class="method-detail">
245
+ <a name="M000147"></a>
246
246
 
247
247
  <div class="method-heading">
248
- <a href="#M000151" class="method-signature">
248
+ <a href="#M000147" class="method-signature">
249
249
  <span class="method-name">submit_job</span><span class="method-args">(store, jobtype, label, t=Time.now, snapshot_uri=nil)</span>
250
250
  </a>
251
251
  </div>
@@ -255,8 +255,8 @@ an array of job names
255
255
  Generic submit job method
256
256
  </p>
257
257
  <p><a class="source-toggle" href="#"
258
- onclick="toggleCode('M000151-source');return false;">[Source]</a></p>
259
- <div class="method-source-code" id="M000151-source">
258
+ onclick="toggleCode('M000147-source');return false;">[Source]</a></p>
259
+ <div class="method-source-code" id="M000147-source">
260
260
  <pre>
261
261
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 72</span>
262
262
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">submit_job</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">jobtype</span>, <span class="ruby-identifier">label</span>, <span class="ruby-identifier">t</span>=<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>, <span class="ruby-identifier">snapshot_uri</span>=<span class="ruby-keyword kw">nil</span>)
@@ -267,11 +267,11 @@ Generic submit job method
267
267
  </div>
268
268
  </div>
269
269
 
270
- <div id="method-M000148" class="method-detail">
271
- <a name="M000148"></a>
270
+ <div id="method-M000144" class="method-detail">
271
+ <a name="M000144"></a>
272
272
 
273
273
  <div class="method-heading">
274
- <a href="#M000148" class="method-signature">
274
+ <a href="#M000144" class="method-signature">
275
275
  <span class="method-name">submit_reindex</span><span class="method-args">(store, label=&quot;Reindex my store&quot;, t=Time.now)</span>
276
276
  </a>
277
277
  </div>
@@ -288,8 +288,8 @@ the newly created job and then monitor the jobs status if they need to wait
288
288
  for the job to finish.
289
289
  </p>
290
290
  <p><a class="source-toggle" href="#"
291
- onclick="toggleCode('M000148-source');return false;">[Source]</a></p>
292
- <div class="method-source-code" id="M000148-source">
291
+ onclick="toggleCode('M000144-source');return false;">[Source]</a></p>
292
+ <div class="method-source-code" id="M000144-source">
293
293
  <pre>
294
294
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 47</span>
295
295
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">submit_reindex</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">label</span>=<span class="ruby-value str">&quot;Reindex my store&quot;</span>, <span class="ruby-identifier">t</span>=<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>)
@@ -300,11 +300,11 @@ for the job to finish.
300
300
  </div>
301
301
  </div>
302
302
 
303
- <div id="method-M000147" class="method-detail">
304
- <a name="M000147"></a>
303
+ <div id="method-M000143" class="method-detail">
304
+ <a name="M000143"></a>
305
305
 
306
306
  <div class="method-heading">
307
- <a href="#M000147" class="method-signature">
307
+ <a href="#M000143" class="method-signature">
308
308
  <span class="method-name">submit_reset</span><span class="method-args">(store, label=&quot;Reset my store&quot;, t=Time.now)</span>
309
309
  </a>
310
310
  </div>
@@ -321,8 +321,8 @@ the newly created job and then monitor the jobs status if they need to wait
321
321
  for the job to finish.
322
322
  </p>
323
323
  <p><a class="source-toggle" href="#"
324
- onclick="toggleCode('M000147-source');return false;">[Source]</a></p>
325
- <div class="method-source-code" id="M000147-source">
324
+ onclick="toggleCode('M000143-source');return false;">[Source]</a></p>
325
+ <div class="method-source-code" id="M000143-source">
326
326
  <pre>
327
327
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 37</span>
328
328
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">submit_reset</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">label</span>=<span class="ruby-value str">&quot;Reset my store&quot;</span>, <span class="ruby-identifier">t</span>=<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>)
@@ -333,11 +333,11 @@ for the job to finish.
333
333
  </div>
334
334
  </div>
335
335
 
336
- <div id="method-M000150" class="method-detail">
337
- <a name="M000150"></a>
336
+ <div id="method-M000146" class="method-detail">
337
+ <a name="M000146"></a>
338
338
 
339
339
  <div class="method-heading">
340
- <a href="#M000150" class="method-signature">
340
+ <a href="#M000146" class="method-signature">
341
341
  <span class="method-name">submit_restore</span><span class="method-args">(store, snapshot_uri, label=&quot;Restore my snapshot&quot;, t=Time.now)</span>
342
342
  </a>
343
343
  </div>
@@ -354,8 +354,8 @@ the newly created job and then monitor the jobs status if they need to wait
354
354
  for the job to finish.
355
355
  </p>
356
356
  <p><a class="source-toggle" href="#"
357
- onclick="toggleCode('M000150-source');return false;">[Source]</a></p>
358
- <div class="method-source-code" id="M000150-source">
357
+ onclick="toggleCode('M000146-source');return false;">[Source]</a></p>
358
+ <div class="method-source-code" id="M000146-source">
359
359
  <pre>
360
360
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 67</span>
361
361
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">submit_restore</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">snapshot_uri</span>, <span class="ruby-identifier">label</span>=<span class="ruby-value str">&quot;Restore my snapshot&quot;</span>, <span class="ruby-identifier">t</span>=<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>)
@@ -366,11 +366,11 @@ for the job to finish.
366
366
  </div>
367
367
  </div>
368
368
 
369
- <div id="method-M000149" class="method-detail">
370
- <a name="M000149"></a>
369
+ <div id="method-M000145" class="method-detail">
370
+ <a name="M000145"></a>
371
371
 
372
372
  <div class="method-heading">
373
- <a href="#M000149" class="method-signature">
373
+ <a href="#M000145" class="method-signature">
374
374
  <span class="method-name">submit_snapshot</span><span class="method-args">(store, label=&quot;Snapshot my store&quot;, t=Time.now)</span>
375
375
  </a>
376
376
  </div>
@@ -387,8 +387,8 @@ the newly created job and then monitor the jobs status if they need to wait
387
387
  for the job to finish.
388
388
  </p>
389
389
  <p><a class="source-toggle" href="#"
390
- onclick="toggleCode('M000149-source');return false;">[Source]</a></p>
391
- <div class="method-source-code" id="M000149-source">
390
+ onclick="toggleCode('M000145-source');return false;">[Source]</a></p>
391
+ <div class="method-source-code" id="M000145-source">
392
392
  <pre>
393
393
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 57</span>
394
394
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">submit_snapshot</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">label</span>=<span class="ruby-value str">&quot;Snapshot my store&quot;</span>, <span class="ruby-identifier">t</span>=<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>)
@@ -399,11 +399,11 @@ for the job to finish.
399
399
  </div>
400
400
  </div>
401
401
 
402
- <div id="method-M000154" class="method-detail">
403
- <a name="M000154"></a>
402
+ <div id="method-M000150" class="method-detail">
403
+ <a name="M000150"></a>
404
404
 
405
405
  <div class="method-heading">
406
- <a href="#M000154" class="method-signature">
406
+ <a href="#M000150" class="method-signature">
407
407
  <span class="method-name">wait_for</span><span class="method-args">(uri, store, interval=1, &amp;block)</span>
408
408
  </a>
409
409
  </div>
@@ -426,8 +426,8 @@ returned once completed.
426
426
  interval:: the interval at which checks will be made, in minutes. Default is 1
427
427
  </pre>
428
428
  <p><a class="source-toggle" href="#"
429
- onclick="toggleCode('M000154-source');return false;">[Source]</a></p>
430
- <div class="method-source-code" id="M000154-source">
429
+ onclick="toggleCode('M000150-source');return false;">[Source]</a></p>
430
+ <div class="method-source-code" id="M000150-source">
431
431
  <pre>
432
432
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 118</span>
433
433
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">wait_for</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">store</span>, <span class="ruby-identifier">interval</span>=<span class="ruby-value">1</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
@@ -446,11 +446,11 @@ returned once completed.
446
446
  </div>
447
447
  </div>
448
448
 
449
- <div id="method-M000153" class="method-detail">
450
- <a name="M000153"></a>
449
+ <div id="method-M000149" class="method-detail">
450
+ <a name="M000149"></a>
451
451
 
452
452
  <div class="method-heading">
453
- <a href="#M000153" class="method-signature">
453
+ <a href="#M000149" class="method-signature">
454
454
  <span class="method-name">wait_for_submitted</span><span class="method-args">(resp, store, interval=1, &amp;block)</span>
455
455
  </a>
456
456
  </div>
@@ -460,8 +460,8 @@ returned once completed.
460
460
  Wait for a newly submitted job to finish
461
461
  </p>
462
462
  <p><a class="source-toggle" href="#"
463
- onclick="toggleCode('M000153-source');return false;">[Source]</a></p>
464
- <div class="method-source-code" id="M000153-source">
463
+ onclick="toggleCode('M000149-source');return false;">[Source]</a></p>
464
+ <div class="method-source-code" id="M000149-source">
465
465
  <pre>
466
466
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 100</span>
467
467
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">wait_for_submitted</span>(<span class="ruby-identifier">resp</span>, <span class="ruby-identifier">store</span>, <span class="ruby-identifier">interval</span>=<span class="ruby-value">1</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
@@ -478,19 +478,19 @@ Wait for a newly submitted job to finish
478
478
 
479
479
  <h3 class="section-bar">Protected Class methods</h3>
480
480
 
481
- <div id="method-M000155" class="method-detail">
482
- <a name="M000155"></a>
481
+ <div id="method-M000151" class="method-detail">
482
+ <a name="M000151"></a>
483
483
 
484
484
  <div class="method-heading">
485
- <a href="#M000155" class="method-signature">
485
+ <a href="#M000151" class="method-signature">
486
486
  <span class="method-name">yield_job_update</span><span class="method-args">(job, updates) {|job, job.start_message, job.actual_start_time| ...}</span>
487
487
  </a>
488
488
  </div>
489
489
 
490
490
  <div class="method-description">
491
491
  <p><a class="source-toggle" href="#"
492
- onclick="toggleCode('M000155-source');return false;">[Source]</a></p>
493
- <div class="method-source-code" id="M000155-source">
492
+ onclick="toggleCode('M000151-source');return false;">[Source]</a></p>
493
+ <div class="method-source-code" id="M000151-source">
494
494
  <pre>
495
495
  <span class="ruby-comment cmt"># File lib/pho/job.rb, line 132</span>
496
496
  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Jobs</span>.<span class="ruby-identifier">yield_job_update</span>(<span class="ruby-identifier">job</span>, <span class="ruby-identifier">updates</span>)