pho 0.2 → 0.3

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 (140) hide show
  1. data/CHANGES +19 -0
  2. data/Rakefile +6 -4
  3. data/doc/index.html +6 -0
  4. data/doc/rdoc/classes/Pho.html +250 -0
  5. data/doc/rdoc/classes/Pho/Analyzers.html +288 -0
  6. data/doc/rdoc/classes/Pho/DatatypeProperty.html +209 -0
  7. data/doc/rdoc/classes/Pho/DatatypeProperty.src/M000034.html +21 -0
  8. data/doc/rdoc/classes/Pho/DatatypeProperty.src/M000035.html +29 -0
  9. data/doc/rdoc/classes/Pho/Etags.html +238 -0
  10. data/doc/rdoc/classes/Pho/Etags.src/M000088.html +23 -0
  11. data/doc/rdoc/classes/Pho/Etags.src/M000089.html +28 -0
  12. data/doc/rdoc/classes/Pho/Etags.src/M000090.html +21 -0
  13. data/doc/rdoc/classes/Pho/Etags.src/M000091.html +18 -0
  14. data/doc/rdoc/classes/Pho/Etags.src/M000092.html +18 -0
  15. data/doc/rdoc/classes/Pho/Etags.src/M000093.html +18 -0
  16. data/doc/rdoc/classes/Pho/Facet.html +119 -0
  17. data/doc/rdoc/classes/Pho/Facet/Results.html +225 -0
  18. data/doc/rdoc/classes/Pho/Facet/Results.src/M000001.html +20 -0
  19. data/doc/rdoc/classes/Pho/Facet/Results.src/M000002.html +27 -0
  20. data/doc/rdoc/classes/Pho/Facet/Results.src/M000003.html +54 -0
  21. data/doc/rdoc/classes/Pho/Facet/Term.html +166 -0
  22. data/doc/rdoc/classes/Pho/Facet/Term.src/M000004.html +20 -0
  23. data/doc/rdoc/classes/Pho/FieldPredicateMap.html +461 -0
  24. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000005.html +38 -0
  25. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000006.html +28 -0
  26. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000007.html +20 -0
  27. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000008.html +18 -0
  28. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000009.html +23 -0
  29. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000010.html +23 -0
  30. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000011.html +18 -0
  31. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000012.html +18 -0
  32. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000013.html +18 -0
  33. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000014.html +18 -0
  34. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000015.html +18 -0
  35. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000016.html +21 -0
  36. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000017.html +21 -0
  37. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000018.html +38 -0
  38. data/doc/rdoc/classes/Pho/FieldPredicateMap.src/M000019.html +18 -0
  39. data/doc/rdoc/classes/Pho/FieldWeighting.html +202 -0
  40. data/doc/rdoc/classes/Pho/FieldWeighting.src/M000075.html +20 -0
  41. data/doc/rdoc/classes/Pho/FieldWeighting.src/M000076.html +26 -0
  42. data/doc/rdoc/classes/Pho/Job.html +147 -0
  43. data/doc/rdoc/classes/Pho/Job.src/M000074.html +21 -0
  44. data/doc/rdoc/classes/Pho/Namespaces.html +128 -0
  45. data/doc/rdoc/classes/Pho/QueryProfile.html +355 -0
  46. data/doc/rdoc/classes/Pho/QueryProfile.src/M000024.html +39 -0
  47. data/doc/rdoc/classes/Pho/QueryProfile.src/M000025.html +24 -0
  48. data/doc/rdoc/classes/Pho/QueryProfile.src/M000026.html +20 -0
  49. data/doc/rdoc/classes/Pho/QueryProfile.src/M000027.html +18 -0
  50. data/doc/rdoc/classes/Pho/QueryProfile.src/M000028.html +18 -0
  51. data/doc/rdoc/classes/Pho/QueryProfile.src/M000029.html +21 -0
  52. data/doc/rdoc/classes/Pho/QueryProfile.src/M000030.html +18 -0
  53. data/doc/rdoc/classes/Pho/QueryProfile.src/M000031.html +18 -0
  54. data/doc/rdoc/classes/Pho/QueryProfile.src/M000032.html +38 -0
  55. data/doc/rdoc/classes/Pho/QueryProfile.src/M000033.html +18 -0
  56. data/doc/rdoc/classes/Pho/RDFCollection.html +353 -0
  57. data/doc/rdoc/classes/Pho/RDFCollection.src/M000077.html +23 -0
  58. data/doc/rdoc/classes/Pho/RDFCollection.src/M000078.html +22 -0
  59. data/doc/rdoc/classes/Pho/RDFCollection.src/M000079.html +24 -0
  60. data/doc/rdoc/classes/Pho/RDFCollection.src/M000080.html +23 -0
  61. data/doc/rdoc/classes/Pho/RDFCollection.src/M000081.html +18 -0
  62. data/doc/rdoc/classes/Pho/RDFCollection.src/M000082.html +22 -0
  63. data/doc/rdoc/classes/Pho/RDFCollection.src/M000083.html +22 -0
  64. data/doc/rdoc/classes/Pho/RDFCollection.src/M000084.html +26 -0
  65. data/doc/rdoc/classes/Pho/RDFCollection.src/M000085.html +23 -0
  66. data/doc/rdoc/classes/Pho/RDFCollection.src/M000086.html +18 -0
  67. data/doc/rdoc/classes/Pho/RDFCollection.src/M000087.html +18 -0
  68. data/doc/rdoc/classes/Pho/Snapshot.html +271 -0
  69. data/doc/rdoc/classes/Pho/Snapshot.src/M000070.html +31 -0
  70. data/doc/rdoc/classes/Pho/Snapshot.src/M000071.html +21 -0
  71. data/doc/rdoc/classes/Pho/Snapshot.src/M000072.html +18 -0
  72. data/doc/rdoc/classes/Pho/Snapshot.src/M000073.html +37 -0
  73. data/doc/rdoc/classes/Pho/Status.html +245 -0
  74. data/doc/rdoc/classes/Pho/Status.src/M000020.html +20 -0
  75. data/doc/rdoc/classes/Pho/Status.src/M000021.html +31 -0
  76. data/doc/rdoc/classes/Pho/Status.src/M000022.html +18 -0
  77. data/doc/rdoc/classes/Pho/Status.src/M000023.html +18 -0
  78. data/doc/rdoc/classes/Pho/Store.html +1055 -0
  79. data/doc/rdoc/classes/Pho/Store.src/M000036.html +22 -0
  80. data/doc/rdoc/classes/Pho/Store.src/M000037.html +18 -0
  81. data/doc/rdoc/classes/Pho/Store.src/M000038.html +25 -0
  82. data/doc/rdoc/classes/Pho/Store.src/M000039.html +20 -0
  83. data/doc/rdoc/classes/Pho/Store.src/M000040.html +20 -0
  84. data/doc/rdoc/classes/Pho/Store.src/M000041.html +28 -0
  85. data/doc/rdoc/classes/Pho/Store.src/M000042.html +23 -0
  86. data/doc/rdoc/classes/Pho/Store.src/M000043.html +18 -0
  87. data/doc/rdoc/classes/Pho/Store.src/M000044.html +18 -0
  88. data/doc/rdoc/classes/Pho/Store.src/M000045.html +18 -0
  89. data/doc/rdoc/classes/Pho/Store.src/M000046.html +18 -0
  90. data/doc/rdoc/classes/Pho/Store.src/M000047.html +23 -0
  91. data/doc/rdoc/classes/Pho/Store.src/M000048.html +22 -0
  92. data/doc/rdoc/classes/Pho/Store.src/M000049.html +26 -0
  93. data/doc/rdoc/classes/Pho/Store.src/M000050.html +24 -0
  94. data/doc/rdoc/classes/Pho/Store.src/M000051.html +20 -0
  95. data/doc/rdoc/classes/Pho/Store.src/M000052.html +20 -0
  96. data/doc/rdoc/classes/Pho/Store.src/M000053.html +25 -0
  97. data/doc/rdoc/classes/Pho/Store.src/M000054.html +20 -0
  98. data/doc/rdoc/classes/Pho/Store.src/M000055.html +30 -0
  99. data/doc/rdoc/classes/Pho/Store.src/M000056.html +21 -0
  100. data/doc/rdoc/classes/Pho/Store.src/M000057.html +23 -0
  101. data/doc/rdoc/classes/Pho/Store.src/M000058.html +28 -0
  102. data/doc/rdoc/classes/Pho/Store.src/M000059.html +18 -0
  103. data/doc/rdoc/classes/Pho/Store.src/M000060.html +18 -0
  104. data/doc/rdoc/classes/Pho/Store.src/M000061.html +18 -0
  105. data/doc/rdoc/classes/Pho/Store.src/M000062.html +31 -0
  106. data/doc/rdoc/classes/Pho/Store.src/M000063.html +21 -0
  107. data/doc/rdoc/classes/Pho/Store.src/M000064.html +20 -0
  108. data/doc/rdoc/classes/Pho/Store.src/M000065.html +20 -0
  109. data/doc/rdoc/classes/Pho/Store.src/M000066.html +20 -0
  110. data/doc/rdoc/classes/Pho/Store.src/M000067.html +20 -0
  111. data/doc/rdoc/classes/Pho/Store.src/M000068.html +20 -0
  112. data/doc/rdoc/classes/Pho/Store.src/M000069.html +20 -0
  113. data/doc/rdoc/created.rid +1 -1
  114. data/doc/rdoc/files/CHANGES.html +140 -0
  115. data/doc/rdoc/files/README.html +9 -8
  116. data/doc/rdoc/files/lib/pho/etags_rb.html +108 -0
  117. data/doc/rdoc/files/lib/pho/facet_rb.html +101 -0
  118. data/doc/rdoc/files/lib/pho/field_predicate_map_rb.html +101 -0
  119. data/doc/rdoc/files/lib/pho/job_rb.html +101 -0
  120. data/doc/rdoc/files/lib/pho/query_profile_rb.html +101 -0
  121. data/doc/rdoc/files/lib/pho/rdf_collection_rb.html +101 -0
  122. data/doc/rdoc/files/lib/pho/snapshot_rb.html +108 -0
  123. data/doc/rdoc/files/lib/pho/status_rb.html +101 -0
  124. data/doc/rdoc/files/lib/pho/store_rb.html +101 -0
  125. data/doc/rdoc/files/lib/pho_rb.html +120 -0
  126. data/doc/rdoc/fr_class_index.html +16 -0
  127. data/doc/rdoc/fr_file_index.html +11 -0
  128. data/doc/rdoc/fr_method_index.html +93 -0
  129. data/examples/status.rb +3 -3
  130. data/lib/pho.rb +11 -2
  131. data/lib/pho/facet.rb +101 -0
  132. data/lib/pho/field_predicate_map.rb +4 -4
  133. data/lib/pho/query_profile.rb +170 -0
  134. data/lib/pho/status.rb +65 -0
  135. data/lib/pho/store.rb +26 -13
  136. data/tests/tc_facet.rb +91 -0
  137. data/tests/tc_query_profile.rb +196 -0
  138. data/tests/tc_status.rb +56 -0
  139. data/tests/ts_pho.rb +3 -0
  140. metadata +148 -3
data/doc/rdoc/classes/Pho/Store.html ADDED
@@ -0,0 +1,1055 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Pho::Store</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Pho::Store</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../files/lib/pho/store_rb.html">
59
+ lib/pho/store.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+ <div id="description">
82
+ <p>
83
+ The <a href="Store.html">Store</a> class acts as a lightweight client
84
+ interface to the Talis Platform API (<a
85
+ href="http://n2.talis.com/wiki/Platform_API">n2.talis.com/wiki/Platform_API</a>).
86
+ The class provides methods for interacting with each of the core platform
87
+ services, e.g. retrieving and storing RDF, performing searches, SPARQL
88
+ queries, etc.
89
+ </p>
90
+ <h2>Usage</h2>
91
+ <pre>
92
+ store = Pho::Store.new(&quot;http://api.talis.com/stores/testing&quot;, &quot;user&quot;, &quot;pass&quot;)
93
+ store.store_file( File.new(&quot;/tmp/example.rdf&quot;) )
94
+ store.store_url( &quot;http://www.example.org/example.rdf&quot; )
95
+ store.describe( &quot;http://www.example.org/thing&quot; )
96
+ store.reset
97
+ </pre>
98
+ <h2>Examples</h2>
99
+ <p>
100
+ See the examples directory in the distribution
101
+ </p>
102
+
103
+ </div>
104
+
105
+
106
+ </div>
107
+
108
+ <div id="method-list">
109
+ <h3 class="section-bar">Methods</h3>
110
+
111
+ <div class="name-list">
112
+ <a href="#M000052">augment</a>&nbsp;&nbsp;
113
+ <a href="#M000051">augment_uri</a>&nbsp;&nbsp;
114
+ <a href="#M000058">build_job_request</a>&nbsp;&nbsp;
115
+ <a href="#M000038">build_uri</a>&nbsp;&nbsp;
116
+ <a href="#M000053">configure_headers_for_conditional_get</a>&nbsp;&nbsp;
117
+ <a href="#M000056">delete_item</a>&nbsp;&nbsp;
118
+ <a href="#M000042">describe</a>&nbsp;&nbsp;
119
+ <a href="#M000049">facet</a>&nbsp;&nbsp;
120
+ <a href="#M000066">get_field_predicate_map</a>&nbsp;&nbsp;
121
+ <a href="#M000057">get_item</a>&nbsp;&nbsp;
122
+ <a href="#M000068">get_query_profile</a>&nbsp;&nbsp;
123
+ <a href="#M000050">get_search_params</a>&nbsp;&nbsp;
124
+ <a href="#M000065">get_snapshots</a>&nbsp;&nbsp;
125
+ <a href="#M000064">get_status</a>&nbsp;&nbsp;
126
+ <a href="#M000036">new</a>&nbsp;&nbsp;
127
+ <a href="#M000067">put_field_predicate_map</a>&nbsp;&nbsp;
128
+ <a href="#M000069">put_query_profile</a>&nbsp;&nbsp;
129
+ <a href="#M000054">record_etags</a>&nbsp;&nbsp;
130
+ <a href="#M000060">reindex</a>&nbsp;&nbsp;
131
+ <a href="#M000059">reset</a>&nbsp;&nbsp;
132
+ <a href="#M000062">restore</a>&nbsp;&nbsp;
133
+ <a href="#M000048">search</a>&nbsp;&nbsp;
134
+ <a href="#M000037">set_credentials</a>&nbsp;&nbsp;
135
+ <a href="#M000061">snapshot</a>&nbsp;&nbsp;
136
+ <a href="#M000047">sparql</a>&nbsp;&nbsp;
137
+ <a href="#M000045">sparql_ask</a>&nbsp;&nbsp;
138
+ <a href="#M000044">sparql_construct</a>&nbsp;&nbsp;
139
+ <a href="#M000043">sparql_describe</a>&nbsp;&nbsp;
140
+ <a href="#M000046">sparql_select</a>&nbsp;&nbsp;
141
+ <a href="#M000039">store_data</a>&nbsp;&nbsp;
142
+ <a href="#M000040">store_file</a>&nbsp;&nbsp;
143
+ <a href="#M000041">store_url</a>&nbsp;&nbsp;
144
+ <a href="#M000063">submit_job</a>&nbsp;&nbsp;
145
+ <a href="#M000055">upload_item</a>&nbsp;&nbsp;
146
+ </div>
147
+ </div>
148
+
149
+ </div>
150
+
151
+
152
+ <!-- if includes -->
153
+
154
+ <div id="section">
155
+
156
+
157
+
158
+
159
+
160
+ <div id="attribute-list">
161
+ <h3 class="section-bar">Attributes</h3>
162
+
163
+ <div class="name-list">
164
+ <table>
165
+ <tr class="top-aligned-row context-row">
166
+ <td class="context-item-name">client</td>
167
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
168
+ <td class="context-item-desc">
169
+ Retrieve the HTTPClient instance being used by this object
170
+
171
+ </td>
172
+ </tr>
173
+ <tr class="top-aligned-row context-row">
174
+ <td class="context-item-name">storeuri</td>
175
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
176
+ <td class="context-item-desc">
177
+ Retrieve the base uri of this store
178
+
179
+ </td>
180
+ </tr>
181
+ <tr class="top-aligned-row context-row">
182
+ <td class="context-item-name">username</td>
183
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
184
+ <td class="context-item-desc">
185
+ Retrieve the admin username configured in this instance
186
+
187
+ </td>
188
+ </tr>
189
+ </table>
190
+ </div>
191
+ </div>
192
+
193
+
194
+
195
+ <!-- if method_list -->
196
+ <div id="methods">
197
+ <h3 class="section-bar">Public Class methods</h3>
198
+
199
+ <div id="method-M000036" class="method-detail">
200
+ <a name="M000036"></a>
201
+
202
+ <div class="method-heading">
203
+ <a href="Store.src/M000036.html" target="Code" class="method-signature"
204
+ onclick="popupCode('Store.src/M000036.html');return false;">
205
+ <span class="method-name">new</span><span class="method-args">(storeuri, username=nil, password=nil, client = HTTPClient.new() )</span>
206
+ </a>
207
+ </div>
208
+
209
+ <div class="method-description">
210
+ <p>
211
+ Create an instance of the store class
212
+ </p>
213
+ <table>
214
+ <tr><td valign="top">storeuri:</td><td>base uri for the Platform store to be accessed
215
+
216
+ </td></tr>
217
+ <tr><td valign="top">username:</td><td>admin username, may be nil
218
+
219
+ </td></tr>
220
+ <tr><td valign="top">password:</td><td>admin password, may be nil
221
+
222
+ </td></tr>
223
+ <tr><td valign="top">client:</td><td>an instance of HTTPClient
224
+
225
+ </td></tr>
226
+ </table>
227
+ </div>
228
+ </div>
229
+
230
+ <h3 class="section-bar">Public Instance methods</h3>
231
+
232
+ <div id="method-M000052" class="method-detail">
233
+ <a name="M000052"></a>
234
+
235
+ <div class="method-heading">
236
+ <a href="Store.src/M000052.html" target="Code" class="method-signature"
237
+ onclick="popupCode('Store.src/M000052.html');return false;">
238
+ <span class="method-name">augment</span><span class="method-args">(data)</span>
239
+ </a>
240
+ </div>
241
+
242
+ <div class="method-description">
243
+ <p>
244
+ Augment an RSS feed against data int this store by POSTing it to the
245
+ Platform
246
+ </p>
247
+ <table>
248
+ <tr><td valign="top">data:</td><td>a String containing the RSS feed
249
+
250
+ </td></tr>
251
+ </table>
252
+ </div>
253
+ </div>
254
+
255
+ <div id="method-M000051" class="method-detail">
256
+ <a name="M000051"></a>
257
+
258
+ <div class="method-heading">
259
+ <a href="Store.src/M000051.html" target="Code" class="method-signature"
260
+ onclick="popupCode('Store.src/M000051.html');return false;">
261
+ <span class="method-name">augment_uri</span><span class="method-args">(uri)</span>
262
+ </a>
263
+ </div>
264
+
265
+ <div class="method-description">
266
+ <p>
267
+ Augment an RSS feed that can be retrieved from the specified URL, against
268
+ data in this store
269
+ </p>
270
+ <table>
271
+ <tr><td valign="top">uri:</td><td>the URL for the RSS 1.0 feed
272
+
273
+ </td></tr>
274
+ </table>
275
+ </div>
276
+ </div>
277
+
278
+ <div id="method-M000058" class="method-detail">
279
+ <a name="M000058"></a>
280
+
281
+ <div class="method-heading">
282
+ <a href="Store.src/M000058.html" target="Code" class="method-signature"
283
+ onclick="popupCode('Store.src/M000058.html');return false;">
284
+ <span class="method-name">build_job_request</span><span class="method-args">(t, joburi, label)</span>
285
+ </a>
286
+ </div>
287
+
288
+ <div class="method-description">
289
+ <p>
290
+ Construct an RDF/XML document containing a job request for submitting to
291
+ the Platform.
292
+ </p>
293
+ <table>
294
+ <tr><td valign="top">t:</td><td>a Time object, specifying the time at which the request should be carried
295
+ out
296
+
297
+ </td></tr>
298
+ <tr><td valign="top">joburi:</td><td>the URI for the JobType that should be created
299
+
300
+ </td></tr>
301
+ <tr><td valign="top">label:</td><td>a label for this job.
302
+
303
+ </td></tr>
304
+ </table>
305
+ </div>
306
+ </div>
307
+
308
+ <div id="method-M000038" class="method-detail">
309
+ <a name="M000038"></a>
310
+
311
+ <div class="method-heading">
312
+ <a href="Store.src/M000038.html" target="Code" class="method-signature"
313
+ onclick="popupCode('Store.src/M000038.html');return false;">
314
+ <span class="method-name">build_uri</span><span class="method-args">(uri)</span>
315
+ </a>
316
+ </div>
317
+
318
+ <div class="method-description">
319
+ <p>
320
+ Build a request uri, by concatenating it with the base uri of the store
321
+ </p>
322
+ <table>
323
+ <tr><td valign="top">uri:</td><td>relative URI to store service, e.g. &quot;/service/sparql&quot;
324
+
325
+ </td></tr>
326
+ </table>
327
+ </div>
328
+ </div>
329
+
330
+ <div id="method-M000053" class="method-detail">
331
+ <a name="M000053"></a>
332
+
333
+ <div class="method-heading">
334
+ <a href="Store.src/M000053.html" target="Code" class="method-signature"
335
+ onclick="popupCode('Store.src/M000053.html');return false;">
336
+ <span class="method-name">configure_headers_for_conditional_get</span><span class="method-args">(u, headers, etags, if_match)</span>
337
+ </a>
338
+ </div>
339
+
340
+ <div class="method-description">
341
+ <p>
342
+ Added appropriate http header for conditional get requests
343
+ </p>
344
+ </div>
345
+ </div>
346
+
347
+ <div id="method-M000056" class="method-detail">
348
+ <a name="M000056"></a>
349
+
350
+ <div class="method-heading">
351
+ <a href="Store.src/M000056.html" target="Code" class="method-signature"
352
+ onclick="popupCode('Store.src/M000056.html');return false;">
353
+ <span class="method-name">delete_item</span><span class="method-args">(uri)</span>
354
+ </a>
355
+ </div>
356
+
357
+ <div class="method-description">
358
+ <p>
359
+ Delete an item from the Contentbox in this <a href="Store.html">Store</a>
360
+ </p>
361
+ <table>
362
+ <tr><td valign="top">uri:</td><td>the URL of the item, can be relative
363
+
364
+ </td></tr>
365
+ </table>
366
+ <p>
367
+ TODO: conditional deletes
368
+ </p>
369
+ </div>
370
+ </div>
371
+
372
+ <div id="method-M000042" class="method-detail">
373
+ <a name="M000042"></a>
374
+
375
+ <div class="method-heading">
376
+ <a href="Store.src/M000042.html" target="Code" class="method-signature"
377
+ onclick="popupCode('Store.src/M000042.html');return false;">
378
+ <span class="method-name">describe</span><span class="method-args">(uri, format=&quot;application/rdf+xml&quot;, etags=nil, if_match=false)</span>
379
+ </a>
380
+ </div>
381
+
382
+ <div class="method-description">
383
+ <p>
384
+ Retrieve an RDF description of a specific URI. The default behaviour will
385
+ be to retrieve an RDF/XML document, but other formats can be requested, as
386
+ supported by the Talis Platform. E.g. application/json
387
+ </p>
388
+ <table>
389
+ <tr><td valign="top">uri:</td><td>the URI of the resource to <a href="Store.html#M000042">describe</a>
390
+
391
+ </td></tr>
392
+ <tr><td valign="top">format:</td><td>the preferred response format
393
+
394
+ </td></tr>
395
+ <tr><td valign="top">etags:</td><td>an instance of the <a href="Etags.html">Pho::Etags</a> class to support
396
+ conditional GETs
397
+
398
+ </td></tr>
399
+ <tr><td valign="top">if_match:</td><td>specify true to retrieve data only if the version matches a known ETag,
400
+ false to perform a Conditional GET
401
+
402
+ </td></tr>
403
+ </table>
404
+ <p>
405
+ Note that this method is different from <a
406
+ href="Store.html#M000043">sparql_describe</a> in that it is intended to be
407
+ used to generate a description of a single URI, using an separated service
408
+ exposed by the Platform. This service is optimised for retrieval of
409
+ descriptions for single resources and supports HTTP caching and conditional
410
+ retrieval. The <a href="Store.html#M000043">sparql_describe</a> method
411
+ should be used to submit more complex DESCRIBE queries to the Platform,
412
+ e.g. to generate descriptions of resources matching a particular graph
413
+ pattern.
414
+ </p>
415
+ </div>
416
+ </div>
417
+
418
+ <div id="method-M000049" class="method-detail">
419
+ <a name="M000049"></a>
420
+
421
+ <div class="method-heading">
422
+ <a href="Store.src/M000049.html" target="Code" class="method-signature"
423
+ onclick="popupCode('Store.src/M000049.html');return false;">
424
+ <span class="method-name">facet</span><span class="method-args">(query, facets, params=nil)</span>
425
+ </a>
426
+ </div>
427
+
428
+ <div class="method-description">
429
+ <p>
430
+ Perform a facetted <a href="Store.html#M000048">search</a> against the
431
+ Metabox indexes.
432
+ </p>
433
+ <table>
434
+ <tr><td valign="top">query:</td><td>the query to perform. See XXXX for query syntax
435
+
436
+ </td></tr>
437
+ <tr><td valign="top">facets:</td><td>an ordered list of facets to be used
438
+
439
+ </td></tr>
440
+ <tr><td valign="top">params:</td><td>additional query parameters (see below)
441
+
442
+ </td></tr>
443
+ </table>
444
+ <p>
445
+ The <em>params</em> hash can contain the following values:
446
+ </p>
447
+ <ul>
448
+ <li><b>top</b>: the maximum number of results to return for each <a
449
+ href="Store.html#M000049">facet</a>
450
+
451
+ </li>
452
+ <li><b>output</b>: the preferred response format, can be html or xml (the
453
+ default)
454
+
455
+ </li>
456
+ </ul>
457
+ </div>
458
+ </div>
459
+
460
+ <div id="method-M000066" class="method-detail">
461
+ <a name="M000066"></a>
462
+
463
+ <div class="method-heading">
464
+ <a href="Store.src/M000066.html" target="Code" class="method-signature"
465
+ onclick="popupCode('Store.src/M000066.html');return false;">
466
+ <span class="method-name">get_field_predicate_map</span><span class="method-args">(output=ACCEPT_JSON)</span>
467
+ </a>
468
+ </div>
469
+
470
+ <div class="method-description">
471
+ <p>
472
+ Read the field predicate map configuration for this store. The config can
473
+ be requested in any format supported by the platform, but the default will
474
+ return JSON. See <a
475
+ href="FieldPredicateMap.html#M000005">FieldPredicateMap.read_from_store</a>
476
+ for a convenient way to quickly create a <a
477
+ href="FieldPredicateMap.html">FieldPredicateMap</a> object based on a
478
+ specific stores&#8216;s configuration.
479
+ </p>
480
+ <table>
481
+ <tr><td valign="top">output:</td><td>mimetype to use in request
482
+
483
+ </td></tr>
484
+ </table>
485
+ </div>
486
+ </div>
487
+
488
+ <div id="method-M000057" class="method-detail">
489
+ <a name="M000057"></a>
490
+
491
+ <div class="method-heading">
492
+ <a href="Store.src/M000057.html" target="Code" class="method-signature"
493
+ onclick="popupCode('Store.src/M000057.html');return false;">
494
+ <span class="method-name">get_item</span><span class="method-args">(uri, etags=nil, if_match=false)</span>
495
+ </a>
496
+ </div>
497
+
498
+ <div class="method-description">
499
+ <p>
500
+ Get an item from the Contebtbox.
501
+ </p>
502
+ <table>
503
+ <tr><td valign="top">uri:</td><td>the URL of the item, can be relative.
504
+
505
+ </td></tr>
506
+ </table>
507
+ <p>
508
+ If the provided URL of the item is not in the Contentbox, then the response
509
+ will be a redirect to the RDF description of this item, as available from
510
+ the Metabox.
511
+ </p>
512
+ <p>
513
+ TODO: document etags, redirects
514
+ </p>
515
+ </div>
516
+ </div>
517
+
518
+ <div id="method-M000068" class="method-detail">
519
+ <a name="M000068"></a>
520
+
521
+ <div class="method-heading">
522
+ <a href="Store.src/M000068.html" target="Code" class="method-signature"
523
+ onclick="popupCode('Store.src/M000068.html');return false;">
524
+ <span class="method-name">get_query_profile</span><span class="method-args">(output=ACCEPT_JSON)</span>
525
+ </a>
526
+ </div>
527
+
528
+ <div class="method-description">
529
+ <p>
530
+ Read the query profile configuration for this store. The config can be
531
+ requested in any format supported by the platform, but the default will
532
+ return JSON. See <a
533
+ href="QueryProfile.html#M000024">QueryProfile.read_from_store</a> for a
534
+ convenient way to quickly create a <a
535
+ href="QueryProfile.html">QueryProfile</a> object based on a specific
536
+ stores&#8216;s configuration.
537
+ </p>
538
+ <table>
539
+ <tr><td valign="top">output:</td><td>mimetype to use in request
540
+
541
+ </td></tr>
542
+ </table>
543
+ </div>
544
+ </div>
545
+
546
+ <div id="method-M000050" class="method-detail">
547
+ <a name="M000050"></a>
548
+
549
+ <div class="method-heading">
550
+ <a href="Store.src/M000050.html" target="Code" class="method-signature"
551
+ onclick="popupCode('Store.src/M000050.html');return false;">
552
+ <span class="method-name">get_search_params</span><span class="method-args">(u, query, params)</span>
553
+ </a>
554
+ </div>
555
+
556
+ <div class="method-description">
557
+ </div>
558
+ </div>
559
+
560
+ <div id="method-M000065" class="method-detail">
561
+ <a name="M000065"></a>
562
+
563
+ <div class="method-heading">
564
+ <a href="Store.src/M000065.html" target="Code" class="method-signature"
565
+ onclick="popupCode('Store.src/M000065.html');return false;">
566
+ <span class="method-name">get_snapshots</span><span class="method-args">()</span>
567
+ </a>
568
+ </div>
569
+
570
+ <div class="method-description">
571
+ <p>
572
+ Retrieve the list of snapshots for this store
573
+ </p>
574
+ <p>
575
+ Currently the response will contain an HTML document. Use <a
576
+ href="Snapshot.html#M000070">Snapshot.parse</a> to turn this into a <a
577
+ href="Snapshot.html">Snapshot</a> object
578
+ </p>
579
+ </div>
580
+ </div>
581
+
582
+ <div id="method-M000064" class="method-detail">
583
+ <a name="M000064"></a>
584
+
585
+ <div class="method-heading">
586
+ <a href="Store.src/M000064.html" target="Code" class="method-signature"
587
+ onclick="popupCode('Store.src/M000064.html');return false;">
588
+ <span class="method-name">get_status</span><span class="method-args">()</span>
589
+ </a>
590
+ </div>
591
+
592
+ <div class="method-description">
593
+ <p>
594
+ ADMIN
595
+ </p>
596
+ </div>
597
+ </div>
598
+
599
+ <div id="method-M000067" class="method-detail">
600
+ <a name="M000067"></a>
601
+
602
+ <div class="method-heading">
603
+ <a href="Store.src/M000067.html" target="Code" class="method-signature"
604
+ onclick="popupCode('Store.src/M000067.html');return false;">
605
+ <span class="method-name">put_field_predicate_map</span><span class="method-args">(data)</span>
606
+ </a>
607
+ </div>
608
+
609
+ <div class="method-description">
610
+ <p>
611
+ Update/replace the current Field Predicate map configuration in the store.
612
+ Assumes that the provided data is valid RDF/XML. Use <a
613
+ href="FieldPredicateMap.html#M000019">FieldPredicateMap.upload</a> as a
614
+ convenience function
615
+ </p>
616
+ <table>
617
+ <tr><td valign="top">data:</td><td>a string containing an RDF/XML document
618
+
619
+ </td></tr>
620
+ </table>
621
+ </div>
622
+ </div>
623
+
624
+ <div id="method-M000069" class="method-detail">
625
+ <a name="M000069"></a>
626
+
627
+ <div class="method-heading">
628
+ <a href="Store.src/M000069.html" target="Code" class="method-signature"
629
+ onclick="popupCode('Store.src/M000069.html');return false;">
630
+ <span class="method-name">put_query_profile</span><span class="method-args">(data)</span>
631
+ </a>
632
+ </div>
633
+
634
+ <div class="method-description">
635
+ <p>
636
+ Update/replace the current Query Profile configuration in the store.
637
+ Assumes that the provided data is valid RDF/XML. Use <a
638
+ href="QueryProfile.html#M000033">QueryProfile.upload</a> as a convenience
639
+ function
640
+ </p>
641
+ <table>
642
+ <tr><td valign="top">data:</td><td>a string containing an RDF/XML document
643
+
644
+ </td></tr>
645
+ </table>
646
+ </div>
647
+ </div>
648
+
649
+ <div id="method-M000054" class="method-detail">
650
+ <a name="M000054"></a>
651
+
652
+ <div class="method-heading">
653
+ <a href="Store.src/M000054.html" target="Code" class="method-signature"
654
+ onclick="popupCode('Store.src/M000054.html');return false;">
655
+ <span class="method-name">record_etags</span><span class="method-args">(u, etags, response)</span>
656
+ </a>
657
+ </div>
658
+
659
+ <div class="method-description">
660
+ </div>
661
+ </div>
662
+
663
+ <div id="method-M000060" class="method-detail">
664
+ <a name="M000060"></a>
665
+
666
+ <div class="method-heading">
667
+ <a href="Store.src/M000060.html" target="Code" class="method-signature"
668
+ onclick="popupCode('Store.src/M000060.html');return false;">
669
+ <span class="method-name">reindex</span><span class="method-args">(t=Time.now)</span>
670
+ </a>
671
+ </div>
672
+
673
+ <div class="method-description">
674
+ </div>
675
+ </div>
676
+
677
+ <div id="method-M000059" class="method-detail">
678
+ <a name="M000059"></a>
679
+
680
+ <div class="method-heading">
681
+ <a href="Store.src/M000059.html" target="Code" class="method-signature"
682
+ onclick="popupCode('Store.src/M000059.html');return false;">
683
+ <span class="method-name">reset</span><span class="method-args">(t=Time.now)</span>
684
+ </a>
685
+ </div>
686
+
687
+ <div class="method-description">
688
+ </div>
689
+ </div>
690
+
691
+ <div id="method-M000062" class="method-detail">
692
+ <a name="M000062"></a>
693
+
694
+ <div class="method-heading">
695
+ <a href="Store.src/M000062.html" target="Code" class="method-signature"
696
+ onclick="popupCode('Store.src/M000062.html');return false;">
697
+ <span class="method-name">restore</span><span class="method-args">(snapshot_url, t=Time.now)</span>
698
+ </a>
699
+ </div>
700
+
701
+ <div class="method-description">
702
+ <p>
703
+ Restore this store from a previously generated <a
704
+ href="Snapshot.html">Snapshot</a> The Platform can <a
705
+ href="Store.html#M000062">restore</a> from any <a
706
+ href="Store.html#M000061">snapshot</a> that is web-accessible
707
+ </p>
708
+ <table>
709
+ <tr><td valign="top">snapshot_url:</td><td>the URL of the <a href="Store.html#M000061">snapshot</a>
710
+
711
+ </td></tr>
712
+ </table>
713
+ </div>
714
+ </div>
715
+
716
+ <div id="method-M000048" class="method-detail">
717
+ <a name="M000048"></a>
718
+
719
+ <div class="method-heading">
720
+ <a href="Store.src/M000048.html" target="Code" class="method-signature"
721
+ onclick="popupCode('Store.src/M000048.html');return false;">
722
+ <span class="method-name">search</span><span class="method-args">(query, params=nil)</span>
723
+ </a>
724
+ </div>
725
+
726
+ <div class="method-description">
727
+ <p>
728
+ Search the Metabox indexes.
729
+ </p>
730
+ <table>
731
+ <tr><td valign="top">query:</td><td>the query to perform. See XXXX for query syntax
732
+
733
+ </td></tr>
734
+ <tr><td valign="top">params:</td><td>additional query parameters (see below)
735
+
736
+ </td></tr>
737
+ </table>
738
+ <p>
739
+ The <em>params</em> hash can contain the following values:
740
+ </p>
741
+ <ul>
742
+ <li><b>max</b>: The maximum number of results to return (default is 10)
743
+
744
+ </li>
745
+ <li><b>offset</b>: Offset into the query results (for paging; default is 0)
746
+
747
+ </li>
748
+ <li><b>sort</b>: ordered list of fields to be used when applying sorting
749
+
750
+ </li>
751
+ <li>*xsl-uri*: URL of an XSLT transform to be applied to the results,
752
+ transforming the default RSS 1.0 results format into an alternative
753
+ representation
754
+
755
+ </li>
756
+ <li>*content-type*: when applying an XSLT transform, the content type to use
757
+ when returning the results
758
+
759
+ </li>
760
+ </ul>
761
+ <p>
762
+ Any additional entries in the <em>params</em> hash will be passed through
763
+ to the Platform. These parameters will only be used when an XSLT
764
+ transformation is being applied, in which case they will be provided as
765
+ parameters to the stylesheet.
766
+ </p>
767
+ </div>
768
+ </div>
769
+
770
+ <div id="method-M000037" class="method-detail">
771
+ <a name="M000037"></a>
772
+
773
+ <div class="method-heading">
774
+ <a href="Store.src/M000037.html" target="Code" class="method-signature"
775
+ onclick="popupCode('Store.src/M000037.html');return false;">
776
+ <span class="method-name">set_credentials</span><span class="method-args">(username, password)</span>
777
+ </a>
778
+ </div>
779
+
780
+ <div class="method-description">
781
+ <p>
782
+ Set credentials that this store will use when carrying out authorization
783
+ </p>
784
+ <table>
785
+ <tr><td valign="top">username:</td><td>admin username
786
+
787
+ </td></tr>
788
+ <tr><td valign="top">password:</td><td>admin password
789
+
790
+ </td></tr>
791
+ </table>
792
+ </div>
793
+ </div>
794
+
795
+ <div id="method-M000061" class="method-detail">
796
+ <a name="M000061"></a>
797
+
798
+ <div class="method-heading">
799
+ <a href="Store.src/M000061.html" target="Code" class="method-signature"
800
+ onclick="popupCode('Store.src/M000061.html');return false;">
801
+ <span class="method-name">snapshot</span><span class="method-args">(t=Time.now)</span>
802
+ </a>
803
+ </div>
804
+
805
+ <div class="method-description">
806
+ </div>
807
+ </div>
808
+
809
+ <div id="method-M000047" class="method-detail">
810
+ <a name="M000047"></a>
811
+
812
+ <div class="method-heading">
813
+ <a href="Store.src/M000047.html" target="Code" class="method-signature"
814
+ onclick="popupCode('Store.src/M000047.html');return false;">
815
+ <span class="method-name">sparql</span><span class="method-args">(query, format)</span>
816
+ </a>
817
+ </div>
818
+
819
+ <div class="method-description">
820
+ <p>
821
+ Perform a SPARQL query
822
+ </p>
823
+ <pre>
824
+ query:: the SPARQL query
825
+ format:: the preferred response format
826
+ </pre>
827
+ </div>
828
+ </div>
829
+
830
+ <div id="method-M000045" class="method-detail">
831
+ <a name="M000045"></a>
832
+
833
+ <div class="method-heading">
834
+ <a href="Store.src/M000045.html" target="Code" class="method-signature"
835
+ onclick="popupCode('Store.src/M000045.html');return false;">
836
+ <span class="method-name">sparql_ask</span><span class="method-args">(query, format=&quot;application/sparql-results+xml&quot;)</span>
837
+ </a>
838
+ </div>
839
+
840
+ <div class="method-description">
841
+ <p>
842
+ Perform a SPARQL ASK query.
843
+ </p>
844
+ <pre>
845
+ query:: the SPARQL query
846
+ format:: the preferred response format
847
+ </pre>
848
+ </div>
849
+ </div>
850
+
851
+ <div id="method-M000044" class="method-detail">
852
+ <a name="M000044"></a>
853
+
854
+ <div class="method-heading">
855
+ <a href="Store.src/M000044.html" target="Code" class="method-signature"
856
+ onclick="popupCode('Store.src/M000044.html');return false;">
857
+ <span class="method-name">sparql_construct</span><span class="method-args">(query, format=&quot;application/rdf+xml&quot;)</span>
858
+ </a>
859
+ </div>
860
+
861
+ <div class="method-description">
862
+ <p>
863
+ Perform a SPARQL CONSTRUCT query.
864
+ </p>
865
+ <pre>
866
+ query:: the SPARQL query
867
+ format:: the preferred response format
868
+ </pre>
869
+ </div>
870
+ </div>
871
+
872
+ <div id="method-M000043" class="method-detail">
873
+ <a name="M000043"></a>
874
+
875
+ <div class="method-heading">
876
+ <a href="Store.src/M000043.html" target="Code" class="method-signature"
877
+ onclick="popupCode('Store.src/M000043.html');return false;">
878
+ <span class="method-name">sparql_describe</span><span class="method-args">(query, format=&quot;application/rdf+xml&quot;)</span>
879
+ </a>
880
+ </div>
881
+
882
+ <div class="method-description">
883
+ <p>
884
+ Perform a SPARQL DESCRIBE query.
885
+ </p>
886
+ <pre>
887
+ query:: the SPARQL query
888
+ format:: the preferred response format
889
+ </pre>
890
+ </div>
891
+ </div>
892
+
893
+ <div id="method-M000046" class="method-detail">
894
+ <a name="M000046"></a>
895
+
896
+ <div class="method-heading">
897
+ <a href="Store.src/M000046.html" target="Code" class="method-signature"
898
+ onclick="popupCode('Store.src/M000046.html');return false;">
899
+ <span class="method-name">sparql_select</span><span class="method-args">(query, format=&quot;application/sparql-results+xml&quot;)</span>
900
+ </a>
901
+ </div>
902
+
903
+ <div class="method-description">
904
+ <p>
905
+ Perform a SPARQL SELECT query.
906
+ </p>
907
+ <pre>
908
+ query:: the SPARQL query
909
+ format:: the preferred response format
910
+ </pre>
911
+ </div>
912
+ </div>
913
+
914
+ <div id="method-M000039" class="method-detail">
915
+ <a name="M000039"></a>
916
+
917
+ <div class="method-heading">
918
+ <a href="Store.src/M000039.html" target="Code" class="method-signature"
919
+ onclick="popupCode('Store.src/M000039.html');return false;">
920
+ <span class="method-name">store_data</span><span class="method-args">(data)</span>
921
+ </a>
922
+ </div>
923
+
924
+ <div class="method-description">
925
+ <p>
926
+ <a href="Store.html">Store</a> some RDF in the Metabox associated with this
927
+ store
928
+ </p>
929
+ <table>
930
+ <tr><td valign="top">data:</td><td>a String containing the data to store
931
+
932
+ </td></tr>
933
+ </table>
934
+ </div>
935
+ </div>
936
+
937
+ <div id="method-M000040" class="method-detail">
938
+ <a name="M000040"></a>
939
+
940
+ <div class="method-heading">
941
+ <a href="Store.src/M000040.html" target="Code" class="method-signature"
942
+ onclick="popupCode('Store.src/M000040.html');return false;">
943
+ <span class="method-name">store_file</span><span class="method-args">(file)</span>
944
+ </a>
945
+ </div>
946
+
947
+ <div class="method-description">
948
+ <p>
949
+ <a href="Store.html">Store</a> the contents of a File (or any IO stream) in
950
+ the Metabox associated with this store The client does not support
951
+ streaming submissions of data, so the stream will be fully read before data
952
+ is submitted to the platform
953
+ </p>
954
+ <table>
955
+ <tr><td valign="top">file:</td><td>an IO object
956
+
957
+ </td></tr>
958
+ </table>
959
+ </div>
960
+ </div>
961
+
962
+ <div id="method-M000041" class="method-detail">
963
+ <a name="M000041"></a>
964
+
965
+ <div class="method-heading">
966
+ <a href="Store.src/M000041.html" target="Code" class="method-signature"
967
+ onclick="popupCode('Store.src/M000041.html');return false;">
968
+ <span class="method-name">store_url</span><span class="method-args">(u, parameters=nil)</span>
969
+ </a>
970
+ </div>
971
+
972
+ <div class="method-description">
973
+ <p>
974
+ Retrieve RDF data from the specified URL and store it in the <a
975
+ href="Store.html">Store</a> Metabox
976
+ </p>
977
+ <p>
978
+ An Accept header of &quot;application/rdf+xml&quot; will be sent in the
979
+ request to support retrieval of RDF from URLs that support Content
980
+ Negotiation.
981
+ </p>
982
+ <table>
983
+ <tr><td valign="top">u:</td><td>the url of the data
984
+
985
+ </td></tr>
986
+ <tr><td valign="top">parameters:</td><td>a Hash of url parameters to pass when requesting data from the specified
987
+ URL
988
+
989
+ </td></tr>
990
+ </table>
991
+ </div>
992
+ </div>
993
+
994
+ <div id="method-M000063" class="method-detail">
995
+ <a name="M000063"></a>
996
+
997
+ <div class="method-heading">
998
+ <a href="Store.src/M000063.html" target="Code" class="method-signature"
999
+ onclick="popupCode('Store.src/M000063.html');return false;">
1000
+ <span class="method-name">submit_job</span><span class="method-args">(joburi, label, t=Time.now)</span>
1001
+ </a>
1002
+ </div>
1003
+
1004
+ <div class="method-description">
1005
+ </div>
1006
+ </div>
1007
+
1008
+ <div id="method-M000055" class="method-detail">
1009
+ <a name="M000055"></a>
1010
+
1011
+ <div class="method-heading">
1012
+ <a href="Store.src/M000055.html" target="Code" class="method-signature"
1013
+ onclick="popupCode('Store.src/M000055.html');return false;">
1014
+ <span class="method-name">upload_item</span><span class="method-args">(f, mimetype, uri=nil)</span>
1015
+ </a>
1016
+ </div>
1017
+
1018
+ <div class="method-description">
1019
+ <p>
1020
+ <a href="Store.html">Store</a> an item in the Contentbox for this store
1021
+ </p>
1022
+ <table>
1023
+ <tr><td valign="top">f:</td><td>a File or other IO object from which data will be read
1024
+
1025
+ </td></tr>
1026
+ <tr><td valign="top">mimetype:</td><td>the mimetype of the object to record in the Platform
1027
+
1028
+ </td></tr>
1029
+ <tr><td valign="top">uri:</td><td>the URI at which to store the item (relative to base uri for the store). If
1030
+ nil, then a URI will be assigned by the Platform
1031
+
1032
+ </td></tr>
1033
+ </table>
1034
+ <p>
1035
+ When a <em>uri</em> is not specified, then the Platform will return a 201
1036
+ Created response with a Location header containing the URI of the newly
1037
+ stored item. If a URI is specified then a successful request will result in
1038
+ a 200 OK response.
1039
+ </p>
1040
+ </div>
1041
+ </div>
1042
+
1043
+
1044
+ </div>
1045
+
1046
+
1047
+ </div>
1048
+
1049
+
1050
+ <div id="validator-badges">
1051
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
1052
+ </div>
1053
+
1054
+ </body>
1055
+ </html>