pho 0.7.2 → 0.7.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.
- data/CHANGES +5 -0
- data/Rakefile +1 -1
- data/lib/pho/snapshot.rb +6 -1
- data/lib/pho/sparql.rb +4 -1
- data/tests/tc_snapshots.rb +14 -1
- data/tests/tc_sparql_helper.rb +23 -0
- metadata +60 -160
- data/doc/rdoc/classes/Pho/Analyzers.html +0 -310
- data/doc/rdoc/classes/Pho/CommandLine.html +0 -770
- data/doc/rdoc/classes/Pho/DatatypeProperty.html +0 -241
- data/doc/rdoc/classes/Pho/Enrichment/StoreEnricher.html +0 -410
- data/doc/rdoc/classes/Pho/Enrichment.html +0 -119
- data/doc/rdoc/classes/Pho/Etags.html +0 -310
- data/doc/rdoc/classes/Pho/Facet/Results.html +0 -299
- data/doc/rdoc/classes/Pho/Facet/Term.html +0 -177
- data/doc/rdoc/classes/Pho/Facet.html +0 -119
- data/doc/rdoc/classes/Pho/FieldPredicateMap.html +0 -668
- data/doc/rdoc/classes/Pho/FieldWeighting.html +0 -230
- data/doc/rdoc/classes/Pho/FileManagement/AbstractFileManager.html +0 -478
- data/doc/rdoc/classes/Pho/FileManagement/FileManager.html +0 -264
- data/doc/rdoc/classes/Pho/FileManagement/RDFManager.html +0 -259
- data/doc/rdoc/classes/Pho/FileManagement.html +0 -121
- data/doc/rdoc/classes/Pho/Job.html +0 -627
- data/doc/rdoc/classes/Pho/JobUpdate.html +0 -141
- data/doc/rdoc/classes/Pho/Jobs.html +0 -538
- data/doc/rdoc/classes/Pho/Namespaces.html +0 -164
- data/doc/rdoc/classes/Pho/OAI/Record.html +0 -165
- data/doc/rdoc/classes/Pho/OAI/Records.html +0 -331
- data/doc/rdoc/classes/Pho/OAI.html +0 -118
- data/doc/rdoc/classes/Pho/QueryProfile.html +0 -497
- data/doc/rdoc/classes/Pho/RDF/Parser.html +0 -279
- data/doc/rdoc/classes/Pho/RDF.html +0 -120
- data/doc/rdoc/classes/Pho/RDFCollection.html +0 -119
- data/doc/rdoc/classes/Pho/ResourceHash/Converter.html +0 -325
- data/doc/rdoc/classes/Pho/ResourceHash/SetAlgebra.html +0 -241
- data/doc/rdoc/classes/Pho/ResourceHash.html +0 -123
- data/doc/rdoc/classes/Pho/Snapshot.html +0 -397
- data/doc/rdoc/classes/Pho/Sparql/SparqlClient.html +0 -594
- data/doc/rdoc/classes/Pho/Sparql/SparqlHelper.html +0 -692
- data/doc/rdoc/classes/Pho/Sparql.html +0 -187
- data/doc/rdoc/classes/Pho/Status.html +0 -296
- data/doc/rdoc/classes/Pho/Store.html +0 -1560
- data/doc/rdoc/classes/Pho/StoreSparqlClient.html +0 -183
- data/doc/rdoc/classes/Pho/Update/Changeset.html +0 -521
- data/doc/rdoc/classes/Pho/Update/ChangesetBuilder.html +0 -330
- data/doc/rdoc/classes/Pho/Update/ChangesetHelper.html +0 -159
- data/doc/rdoc/classes/Pho/Update/Changesets.html +0 -205
- data/doc/rdoc/classes/Pho/Update/LiteralStatement.html +0 -257
- data/doc/rdoc/classes/Pho/Update/ResourceStatement.html +0 -237
- data/doc/rdoc/classes/Pho/Update/Statement.html +0 -303
- data/doc/rdoc/classes/Pho/Update.html +0 -128
- data/doc/rdoc/classes/Pho.html +0 -283
- data/doc/rdoc/classes/String.html +0 -146
- data/doc/rdoc/created.rid +0 -1
- data/doc/rdoc/files/CHANGES.html +0 -351
- data/doc/rdoc/files/README.html +0 -191
- data/doc/rdoc/files/lib/pho/changeset_builder_rb.html +0 -108
- data/doc/rdoc/files/lib/pho/changeset_rb.html +0 -108
- data/doc/rdoc/files/lib/pho/command_line_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/converter_rb.html +0 -108
- data/doc/rdoc/files/lib/pho/enrichment_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/etags_rb.html +0 -108
- data/doc/rdoc/files/lib/pho/facet_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/field_predicate_map_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/file_management_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/file_manager_rb.html +0 -108
- data/doc/rdoc/files/lib/pho/job_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/oai_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/query_profile_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/rdf_collection_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/rdf_rb.html +0 -108
- data/doc/rdoc/files/lib/pho/resource_hash_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/snapshot_rb.html +0 -109
- data/doc/rdoc/files/lib/pho/sparql_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/status_rb.html +0 -101
- data/doc/rdoc/files/lib/pho/store_rb.html +0 -108
- data/doc/rdoc/files/lib/pho_rb.html +0 -133
- data/doc/rdoc/fr_class_index.html +0 -72
- data/doc/rdoc/fr_file_index.html +0 -49
- data/doc/rdoc/fr_method_index.html +0 -237
- data/doc/rdoc/index.html +0 -24
- data/doc/rdoc/rdoc-style.css +0 -208
|
@@ -1,187 +0,0 @@
|
|
|
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>Module: Pho::Sparql</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>Module</strong></td>
|
|
53
|
-
<td class="class-name-in-header">Pho::Sparql</td>
|
|
54
|
-
</tr>
|
|
55
|
-
<tr class="top-aligned-row">
|
|
56
|
-
<td><strong>In:</strong></td>
|
|
57
|
-
<td>
|
|
58
|
-
<a href="../../files/lib/pho/sparql_rb.html">
|
|
59
|
-
lib/pho/sparql.rb
|
|
60
|
-
</a>
|
|
61
|
-
<br />
|
|
62
|
-
</td>
|
|
63
|
-
</tr>
|
|
64
|
-
|
|
65
|
-
</table>
|
|
66
|
-
</div>
|
|
67
|
-
<!-- banner header -->
|
|
68
|
-
|
|
69
|
-
<div id="bodyContent">
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
<div id="contextContent">
|
|
74
|
-
|
|
75
|
-
<div id="description">
|
|
76
|
-
<p>
|
|
77
|
-
Module providing a SPARQL client library, support for parsing SPARQL query
|
|
78
|
-
responses into Ruby objects and other useful behaviour
|
|
79
|
-
</p>
|
|
80
|
-
|
|
81
|
-
</div>
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
</div>
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
</div>
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
<!-- if includes -->
|
|
91
|
-
|
|
92
|
-
<div id="section">
|
|
93
|
-
|
|
94
|
-
<div id="class-list">
|
|
95
|
-
<h3 class="section-bar">Classes and Modules</h3>
|
|
96
|
-
|
|
97
|
-
Class <a href="Sparql/SparqlClient.html" class="link">Pho::Sparql::SparqlClient</a><br />
|
|
98
|
-
Class <a href="Sparql/SparqlHelper.html" class="link">Pho::Sparql::SparqlHelper</a><br />
|
|
99
|
-
|
|
100
|
-
</div>
|
|
101
|
-
|
|
102
|
-
<div id="constants-list">
|
|
103
|
-
<h3 class="section-bar">Constants</h3>
|
|
104
|
-
|
|
105
|
-
<div class="name-list">
|
|
106
|
-
<table summary="Constants">
|
|
107
|
-
<tr class="top-aligned-row context-row">
|
|
108
|
-
<td class="context-item-name">SPARQL_RESULTS_XML</td>
|
|
109
|
-
<td>=</td>
|
|
110
|
-
<td class="context-item-value">"application/sparql-results+xml"</td>
|
|
111
|
-
</tr>
|
|
112
|
-
<tr class="top-aligned-row context-row">
|
|
113
|
-
<td class="context-item-name">SPARQL_RESULTS_JSON</td>
|
|
114
|
-
<td>=</td>
|
|
115
|
-
<td class="context-item-value">"application/sparql-results+json"</td>
|
|
116
|
-
</tr>
|
|
117
|
-
<tr class="top-aligned-row context-row">
|
|
118
|
-
<td class="context-item-name">SYMMETRIC_BOUNDED_DESCRIPTION</td>
|
|
119
|
-
<td>=</td>
|
|
120
|
-
<td class="context-item-value"><<-EOL CONSTRUCT {?uri ?p ?o . ?s ?p2 ?uri .} WHERE { {?uri ?p ?o .} UNION {?s ?p2 ?uri .} } EOL</td>
|
|
121
|
-
<td width="3em"> </td>
|
|
122
|
-
<td class="context-item-desc">
|
|
123
|
-
Includes all statements along both in-bound and out-bound arc paths
|
|
124
|
-
|
|
125
|
-
<p>
|
|
126
|
-
See <a
|
|
127
|
-
href="http://n2.talis.com/wiki/Bounded_Descriptions_in_RDF">n2.talis.com/wiki/Bounded_Descriptions_in_RDF</a>
|
|
128
|
-
</p>
|
|
129
|
-
</td>
|
|
130
|
-
</tr>
|
|
131
|
-
<tr class="top-aligned-row context-row">
|
|
132
|
-
<td class="context-item-name">LABELLED_BOUNDED_DESCRIPTION</td>
|
|
133
|
-
<td>=</td>
|
|
134
|
-
<td class="context-item-value"><<-EOL PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#> CONSTRUCT { ?uri ?p ?o . ?o rdfs:label ?label . ?o rdfs:comment ?comment . ?o <http://www.w3.org/2004/02/skos/core#prefLabel> ?plabel . ?o rdfs:seeAlso ?seealso. } WHERE { ?uri ?p ?o . OPTIONAL { ?o rdfs:label ?label . } OPTIONAL { ?o <http://www.w3.org/2004/02/skos/core#prefLabel> ?plabel . } OPTIONAL { ?o rdfs:comment ?comment . } OPTIONAL { ?o rdfs:seeAlso ?seealso. } } EOL</td>
|
|
135
|
-
<td width="3em"> </td>
|
|
136
|
-
<td class="context-item-desc">
|
|
137
|
-
Similar to Concise Bounded Description but includes labels for referenced
|
|
138
|
-
resources
|
|
139
|
-
|
|
140
|
-
<p>
|
|
141
|
-
See <a
|
|
142
|
-
href="http://n2.talis.com/wiki/Bounded_Descriptions_in_RDF">n2.talis.com/wiki/Bounded_Descriptions_in_RDF</a>
|
|
143
|
-
</p>
|
|
144
|
-
</td>
|
|
145
|
-
</tr>
|
|
146
|
-
<tr class="top-aligned-row context-row">
|
|
147
|
-
<td class="context-item-name">SYMMETRIC_LABELLED_BOUNDED_DESCRIPTION</td>
|
|
148
|
-
<td>=</td>
|
|
149
|
-
<td class="context-item-value"><<-EOL PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#> CONSTRUCT { ?uri ?p ?o . ?o rdfs:label ?label . ?o rdfs:comment ?comment . ?o rdfs:seeAlso ?seealso. ?s ?p2 ?uri . ?s rdfs:label ?label . ?s rdfs:comment ?comment . ?s rdfs:seeAlso ?seealso. } WHERE { { ?uri ?p ?o . OPTIONAL { ?o rdfs:label ?label . } OPTIONAL { ?o rdfs:comment ?comment . } OPTIONAL { ?o rdfs:seeAlso ?seealso. } } UNION { ?s ?p2 ?uri . OPTIONAL { ?s rdfs:label ?label . } OPTIONAL { ?s rdfs:comment ?comment . } OPTIONAL { ?s rdfs:seeAlso ?seealso. } } } EOL</td>
|
|
150
|
-
<td width="3em"> </td>
|
|
151
|
-
<td class="context-item-desc">
|
|
152
|
-
Derived from both the Symmetric and Labelled Bounded Descriptions. Includes
|
|
153
|
-
all in-bound and out-bound arc paths, with labels for any referenced
|
|
154
|
-
resources.
|
|
155
|
-
|
|
156
|
-
<p>
|
|
157
|
-
See <a
|
|
158
|
-
href="http://n2.talis.com/wiki/Bounded_Descriptions_in_RDF">n2.talis.com/wiki/Bounded_Descriptions_in_RDF</a>
|
|
159
|
-
</p>
|
|
160
|
-
</td>
|
|
161
|
-
</tr>
|
|
162
|
-
<tr class="top-aligned-row context-row">
|
|
163
|
-
<td class="context-item-name">DESCRIPTIONS</td>
|
|
164
|
-
<td>=</td>
|
|
165
|
-
<td class="context-item-value">{ :cbd => "DESCRIBE ?uri", :scbd => SYMMETRIC_BOUNDED_DESCRIPTION, :lcbd => LABELLED_BOUNDED_DESCRIPTION, :slcbd => SYMMETRIC_LABELLED_BOUNDED_DESCRIPTION</td>
|
|
166
|
-
</tr>
|
|
167
|
-
</table>
|
|
168
|
-
</div>
|
|
169
|
-
</div>
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
<!-- if method_list -->
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
</div>
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
<div id="validator-badges">
|
|
183
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
184
|
-
</div>
|
|
185
|
-
|
|
186
|
-
</body>
|
|
187
|
-
</html>
|
|
@@ -1,296 +0,0 @@
|
|
|
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::Status</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::Status</td>
|
|
54
|
-
</tr>
|
|
55
|
-
<tr class="top-aligned-row">
|
|
56
|
-
<td><strong>In:</strong></td>
|
|
57
|
-
<td>
|
|
58
|
-
<a href="../../files/lib/pho/status_rb.html">
|
|
59
|
-
lib/pho/status.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
|
-
Captures status information relating to a store
|
|
84
|
-
</p>
|
|
85
|
-
|
|
86
|
-
</div>
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
</div>
|
|
90
|
-
|
|
91
|
-
<div id="method-list">
|
|
92
|
-
<h3 class="section-bar">Methods</h3>
|
|
93
|
-
|
|
94
|
-
<div class="name-list">
|
|
95
|
-
<a href="#M000109">new</a>
|
|
96
|
-
<a href="#M000110">read_from_store</a>
|
|
97
|
-
<a href="#M000111">readable?</a>
|
|
98
|
-
<a href="#M000112">writeable?</a>
|
|
99
|
-
</div>
|
|
100
|
-
</div>
|
|
101
|
-
|
|
102
|
-
</div>
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
<!-- if includes -->
|
|
106
|
-
|
|
107
|
-
<div id="section">
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
<div id="attribute-list">
|
|
114
|
-
<h3 class="section-bar">Attributes</h3>
|
|
115
|
-
|
|
116
|
-
<div class="name-list">
|
|
117
|
-
<table>
|
|
118
|
-
<tr class="top-aligned-row context-row">
|
|
119
|
-
<td class="context-item-name">access_mode</td>
|
|
120
|
-
<td class="context-item-value"> [R] </td>
|
|
121
|
-
<td class="context-item-desc">
|
|
122
|
-
Current access mode uri
|
|
123
|
-
|
|
124
|
-
<p>
|
|
125
|
-
This will be one of Pho::READ_ONLY, Pho::READ_WRITE, or Pho::UNAVAILABLE.
|
|
126
|
-
Use the readable and writeable methods to test for the different modes
|
|
127
|
-
</p>
|
|
128
|
-
</td>
|
|
129
|
-
</tr>
|
|
130
|
-
<tr class="top-aligned-row context-row">
|
|
131
|
-
<td class="context-item-name">retry_interval</td>
|
|
132
|
-
<td class="context-item-value"> [R] </td>
|
|
133
|
-
<td class="context-item-desc">
|
|
134
|
-
Interval before status should be requested again.
|
|
135
|
-
|
|
136
|
-
</td>
|
|
137
|
-
</tr>
|
|
138
|
-
<tr class="top-aligned-row context-row">
|
|
139
|
-
<td class="context-item-name">status_message</td>
|
|
140
|
-
<td class="context-item-value"> [R] </td>
|
|
141
|
-
<td class="context-item-desc">
|
|
142
|
-
<a href="Status.html">Status</a> message
|
|
143
|
-
|
|
144
|
-
</td>
|
|
145
|
-
</tr>
|
|
146
|
-
</table>
|
|
147
|
-
</div>
|
|
148
|
-
</div>
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
<!-- if method_list -->
|
|
153
|
-
<div id="methods">
|
|
154
|
-
<h3 class="section-bar">Public Class methods</h3>
|
|
155
|
-
|
|
156
|
-
<div id="method-M000109" class="method-detail">
|
|
157
|
-
<a name="M000109"></a>
|
|
158
|
-
|
|
159
|
-
<div class="method-heading">
|
|
160
|
-
<a href="#M000109" class="method-signature">
|
|
161
|
-
<span class="method-name">new</span><span class="method-args">(retry_interval, status_message, access_mode)</span>
|
|
162
|
-
</a>
|
|
163
|
-
</div>
|
|
164
|
-
|
|
165
|
-
<div class="method-description">
|
|
166
|
-
<p><a class="source-toggle" href="#"
|
|
167
|
-
onclick="toggleCode('M000109-source');return false;">[Source]</a></p>
|
|
168
|
-
<div class="method-source-code" id="M000109-source">
|
|
169
|
-
<pre>
|
|
170
|
-
<span class="ruby-comment cmt"># File lib/pho/status.rb, line 25</span>
|
|
171
|
-
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">retry_interval</span>, <span class="ruby-identifier">status_message</span>, <span class="ruby-identifier">access_mode</span>)
|
|
172
|
-
<span class="ruby-ivar">@retry_interval</span> = <span class="ruby-identifier">retry_interval</span>
|
|
173
|
-
<span class="ruby-ivar">@status_message</span> = <span class="ruby-identifier">status_message</span>
|
|
174
|
-
<span class="ruby-ivar">@access_mode</span> = <span class="ruby-identifier">access_mode</span>
|
|
175
|
-
<span class="ruby-keyword kw">end</span>
|
|
176
|
-
</pre>
|
|
177
|
-
</div>
|
|
178
|
-
</div>
|
|
179
|
-
</div>
|
|
180
|
-
|
|
181
|
-
<div id="method-M000110" class="method-detail">
|
|
182
|
-
<a name="M000110"></a>
|
|
183
|
-
|
|
184
|
-
<div class="method-heading">
|
|
185
|
-
<a href="#M000110" class="method-signature">
|
|
186
|
-
<span class="method-name">read_from_store</span><span class="method-args">(store)</span>
|
|
187
|
-
</a>
|
|
188
|
-
</div>
|
|
189
|
-
|
|
190
|
-
<div class="method-description">
|
|
191
|
-
<p>
|
|
192
|
-
Create a <a href="Status.html">Status</a> object by reading the response
|
|
193
|
-
from a store access status request
|
|
194
|
-
</p>
|
|
195
|
-
<p>
|
|
196
|
-
The code parses the JSON output from the Platform API to create a <a
|
|
197
|
-
href="Status.html">Status</a> object.
|
|
198
|
-
</p>
|
|
199
|
-
<table>
|
|
200
|
-
<tr><td valign="top">store:</td><td>the store whose status is to be read
|
|
201
|
-
|
|
202
|
-
</td></tr>
|
|
203
|
-
</table>
|
|
204
|
-
<p><a class="source-toggle" href="#"
|
|
205
|
-
onclick="toggleCode('M000110-source');return false;">[Source]</a></p>
|
|
206
|
-
<div class="method-source-code" id="M000110-source">
|
|
207
|
-
<pre>
|
|
208
|
-
<span class="ruby-comment cmt"># File lib/pho/status.rb, line 36</span>
|
|
209
|
-
<span class="ruby-keyword kw">def</span> <span class="ruby-constant">Status</span>.<span class="ruby-identifier">read_from_store</span>(<span class="ruby-identifier">store</span>)
|
|
210
|
-
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">store</span>.<span class="ruby-identifier">get_status</span>()
|
|
211
|
-
<span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">response</span>.<span class="ruby-identifier">status</span> <span class="ruby-operator">!=</span> <span class="ruby-value">200</span>)
|
|
212
|
-
<span class="ruby-identifier">raise</span> <span class="ruby-value str">"Cannot read store status"</span>
|
|
213
|
-
<span class="ruby-keyword kw">end</span>
|
|
214
|
-
|
|
215
|
-
<span class="ruby-identifier">u</span> = <span class="ruby-identifier">store</span>.<span class="ruby-identifier">build_uri</span>(<span class="ruby-value str">"/config/access-status"</span>)
|
|
216
|
-
<span class="ruby-identifier">json</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>( <span class="ruby-identifier">response</span>.<span class="ruby-identifier">content</span> )
|
|
217
|
-
<span class="ruby-identifier">retry_interval</span> = <span class="ruby-identifier">json</span>[<span class="ruby-identifier">u</span>][<span class="ruby-value str">"http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#retryInterval"</span>][<span class="ruby-value">0</span>][<span class="ruby-value str">"value"</span>]
|
|
218
|
-
<span class="ruby-identifier">status_message</span> = <span class="ruby-identifier">json</span>[<span class="ruby-identifier">u</span>][<span class="ruby-value str">"http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#statusMessage"</span>][<span class="ruby-value">0</span>][<span class="ruby-value str">"value"</span>]
|
|
219
|
-
<span class="ruby-identifier">access_mode</span> = <span class="ruby-identifier">json</span>[<span class="ruby-identifier">u</span>][<span class="ruby-value str">"http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#accessMode"</span>][<span class="ruby-value">0</span>][<span class="ruby-value str">"value"</span>]
|
|
220
|
-
|
|
221
|
-
<span class="ruby-identifier">state</span> = <span class="ruby-constant">Status</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">retry_interval</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">status_message</span>, <span class="ruby-identifier">access_mode</span>)
|
|
222
|
-
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">state</span>
|
|
223
|
-
|
|
224
|
-
<span class="ruby-keyword kw">end</span>
|
|
225
|
-
</pre>
|
|
226
|
-
</div>
|
|
227
|
-
</div>
|
|
228
|
-
</div>
|
|
229
|
-
|
|
230
|
-
<h3 class="section-bar">Public Instance methods</h3>
|
|
231
|
-
|
|
232
|
-
<div id="method-M000111" class="method-detail">
|
|
233
|
-
<a name="M000111"></a>
|
|
234
|
-
|
|
235
|
-
<div class="method-heading">
|
|
236
|
-
<a href="#M000111" class="method-signature">
|
|
237
|
-
<span class="method-name">readable?</span><span class="method-args">()</span>
|
|
238
|
-
</a>
|
|
239
|
-
</div>
|
|
240
|
-
|
|
241
|
-
<div class="method-description">
|
|
242
|
-
<p>
|
|
243
|
-
Is the store <a href="Status.html#M000111">readable?</a>
|
|
244
|
-
</p>
|
|
245
|
-
<p><a class="source-toggle" href="#"
|
|
246
|
-
onclick="toggleCode('M000111-source');return false;">[Source]</a></p>
|
|
247
|
-
<div class="method-source-code" id="M000111-source">
|
|
248
|
-
<pre>
|
|
249
|
-
<span class="ruby-comment cmt"># File lib/pho/status.rb, line 54</span>
|
|
250
|
-
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">readable?</span>
|
|
251
|
-
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@access_mode</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">Pho</span><span class="ruby-operator">::</span><span class="ruby-constant">UNAVAILABLE</span>
|
|
252
|
-
<span class="ruby-keyword kw">end</span>
|
|
253
|
-
</pre>
|
|
254
|
-
</div>
|
|
255
|
-
</div>
|
|
256
|
-
</div>
|
|
257
|
-
|
|
258
|
-
<div id="method-M000112" class="method-detail">
|
|
259
|
-
<a name="M000112"></a>
|
|
260
|
-
|
|
261
|
-
<div class="method-heading">
|
|
262
|
-
<a href="#M000112" class="method-signature">
|
|
263
|
-
<span class="method-name">writeable?</span><span class="method-args">()</span>
|
|
264
|
-
</a>
|
|
265
|
-
</div>
|
|
266
|
-
|
|
267
|
-
<div class="method-description">
|
|
268
|
-
<p>
|
|
269
|
-
Is the store <a href="Status.html#M000112">writeable?</a>
|
|
270
|
-
</p>
|
|
271
|
-
<p><a class="source-toggle" href="#"
|
|
272
|
-
onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
|
|
273
|
-
<div class="method-source-code" id="M000112-source">
|
|
274
|
-
<pre>
|
|
275
|
-
<span class="ruby-comment cmt"># File lib/pho/status.rb, line 59</span>
|
|
276
|
-
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">writeable?</span>
|
|
277
|
-
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@access_mode</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Pho</span><span class="ruby-operator">::</span><span class="ruby-constant">READ_WRITE</span>
|
|
278
|
-
<span class="ruby-keyword kw">end</span>
|
|
279
|
-
</pre>
|
|
280
|
-
</div>
|
|
281
|
-
</div>
|
|
282
|
-
</div>
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
</div>
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
</div>
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
<div id="validator-badges">
|
|
292
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
293
|
-
</div>
|
|
294
|
-
|
|
295
|
-
</body>
|
|
296
|
-
</html>
|