Class: RDF::Vocab::HYDRA
- Inherits:
-
StrictVocabulary
- Object
- StrictVocabulary
- RDF::Vocab::HYDRA
- Defined in:
- lib/rdf/vocab/hydra.rb
Overview
Vocabulary for <www.w3.org/ns/hydra/core#>
The Hydra Core Vocabulary
A lightweight vocabulary for hypermedia-driven Web APIs
The Hydra Core Vocabulary is a lightweight vocabulary to create hypermedia-driven Web APIs. By specifying a number of concepts commonly used in Web APIs it enables the creation of generic API clients.
Instance Attribute Summary collapse
-
#ApiDocumentation ⇒ RDF::Vocabulary::Term
readonly
The Hydra API documentation class.
-
#apiDocumentation ⇒ RDF::Vocabulary::Term
readonly
A link to the API documentation.
-
#BasicRepresentation ⇒ RDF::Vocabulary::Term
readonly
A representation that serializes just the lexical form of a variable value, but omits language and type information.
-
#Class ⇒ RDF::Vocabulary::Term
readonly
The class of Hydra classes.
-
#collection ⇒ RDF::Vocabulary::Term
readonly
Collections somehow related to this resource.
-
#Collection ⇒ RDF::Vocabulary::Term
readonly
A collection holding references to a number of related resources.
-
#description ⇒ RDF::Vocabulary::Term
readonly
A description.
-
#entrypoint ⇒ RDF::Vocabulary::Term
readonly
A link to main entry point of the Web API.
-
#Error ⇒ RDF::Vocabulary::Term
readonly
A runtime error, used to report information beyond the returned status code.
-
#expects ⇒ RDF::Vocabulary::Term
readonly
The information expected by the Web API.
-
#expectsHeader ⇒ RDF::Vocabulary::Term
readonly
Specification of the header expected by the operation.
-
#ExplicitRepresentation ⇒ RDF::Vocabulary::Term
readonly
A representation that serializes a variable value including its language and type information and thus differentiating between IRIs and literals.
-
#first ⇒ RDF::Vocabulary::Term
readonly
The first resource of an interlinked set of resources.
-
#freetextQuery ⇒ RDF::Vocabulary::Term
readonly
A property representing a freetext query.
-
#IriTemplate ⇒ RDF::Vocabulary::Term
readonly
The class of IRI templates.
-
#IriTemplateMapping ⇒ RDF::Vocabulary::Term
readonly
A mapping from an IRI template variable to a property.
-
#last ⇒ RDF::Vocabulary::Term
readonly
The last resource of an interlinked set of resources.
-
#limit ⇒ RDF::Vocabulary::Term
readonly
Instructs to limit set only to N elements.
-
#Link ⇒ RDF::Vocabulary::Term
readonly
The class of properties representing links.
-
#manages ⇒ RDF::Vocabulary::Term
readonly
Semantics of each member provided by the collection.
-
#mapping ⇒ RDF::Vocabulary::Term
readonly
A variable-to-property mapping of the IRI template.
-
#member ⇒ RDF::Vocabulary::Term
readonly
A member of the collection.
-
#method ⇒ RDF::Vocabulary::Term
readonly
The HTTP method.
-
#next ⇒ RDF::Vocabulary::Term
readonly
The resource following the current instance in an interlinked set of resources.
-
#object ⇒ RDF::Vocabulary::Term
readonly
The object.
-
#offset ⇒ RDF::Vocabulary::Term
readonly
Instructs to skip N elements of the set.
-
#Operation ⇒ RDF::Vocabulary::Term
readonly
An operation.
-
#operation ⇒ RDF::Vocabulary::Term
readonly
An operation supported by the Hydra resource.
-
#pageIndex ⇒ RDF::Vocabulary::Term
readonly
Instructs to provide a specific page of the collection at a given index.
-
#pageReference ⇒ RDF::Vocabulary::Term
readonly
Instructs to provide a specific page reference of the collection.
-
#PartialCollectionView ⇒ RDF::Vocabulary::Term
readonly
A PartialCollectionView describes a partial view of a Collection.
-
#possibleStatus ⇒ RDF::Vocabulary::Term
readonly
A status that might be returned by the Web API (other statuses should be expected and properly handled as well).
-
#previous ⇒ RDF::Vocabulary::Term
readonly
The resource preceding the current instance in an interlinked set of resources.
-
#property ⇒ RDF::Vocabulary::Term
readonly
A property.
-
#readable ⇒ RDF::Vocabulary::Term
readonly
True if the client can retrieve the property’s value, false otherwise.
-
#required ⇒ RDF::Vocabulary::Term
readonly
True if the property is required, false otherwise.
-
#Resource ⇒ RDF::Vocabulary::Term
readonly
The class of dereferenceable resources.
-
#returns ⇒ RDF::Vocabulary::Term
readonly
The information returned by the Web API on success.
-
#returnsHeader ⇒ RDF::Vocabulary::Term
readonly
Name of the header returned by the operation.
-
#Rfc6570Template ⇒ RDF::Vocabulary::Term
readonly
An IRI template as defined by RFC6570.
-
#search ⇒ RDF::Vocabulary::Term
readonly
A IRI template that can be used to query a collection.
-
#Status ⇒ RDF::Vocabulary::Term
readonly
Additional information about a status code that might be returned.
-
#statusCode ⇒ RDF::Vocabulary::Term
readonly
The HTTP status code.
-
#subject ⇒ RDF::Vocabulary::Term
readonly
The subject.
-
#supportedClass ⇒ RDF::Vocabulary::Term
readonly
A class known to be supported by the Web API.
-
#supportedOperation ⇒ RDF::Vocabulary::Term
readonly
An operation supported by instances of the specific Hydra class or the target of the Hydra link.
-
#SupportedProperty ⇒ RDF::Vocabulary::Term
readonly
A property known to be supported by a Hydra class.
-
#supportedProperty ⇒ RDF::Vocabulary::Term
readonly
The properties known to be supported by a Hydra class.
-
#template ⇒ RDF::Vocabulary::Term
readonly
A templated string with placeholders.
-
#TemplatedLink ⇒ RDF::Vocabulary::Term
readonly
A templated link.
-
#title ⇒ RDF::Vocabulary::Term
readonly
A title, often used along with a description.
-
#totalItems ⇒ RDF::Vocabulary::Term
readonly
The total number of items referenced by a collection.
-
#variable ⇒ RDF::Vocabulary::Term
readonly
An IRI template variable.
-
#variableRepresentation ⇒ RDF::Vocabulary::Term
readonly
The representation format to use when expanding the IRI template.
-
#VariableRepresentation ⇒ RDF::Vocabulary::Term
readonly
A representation specifies how to serialize variable values into strings.
-
#view ⇒ RDF::Vocabulary::Term
readonly
A specific view of a resource.
-
#writeable ⇒ RDF::Vocabulary::Term
readonly
True if the client can change the property’s value, false otherwise.
Instance Attribute Details
#ApiDocumentation ⇒ RDF::Vocabulary::Term (readonly)
The Hydra API documentation class
11 12 13 |
# File 'lib/rdf/vocab/hydra.rb', line 11 def ApiDocumentation @ApiDocumentation end |
#apiDocumentation ⇒ RDF::Vocabulary::Term (readonly)
A link to the API documentation
159 160 161 |
# File 'lib/rdf/vocab/hydra.rb', line 159 def apiDocumentation @apiDocumentation end |
#BasicRepresentation ⇒ RDF::Vocabulary::Term (readonly)
A representation that serializes just the lexical form of a variable value, but omits language and type information.
151 152 153 |
# File 'lib/rdf/vocab/hydra.rb', line 151 def BasicRepresentation @BasicRepresentation end |
#Class ⇒ RDF::Vocabulary::Term (readonly)
The class of Hydra classes. Hydra classes and their instances are dereferenceable resources.
15 16 17 |
# File 'lib/rdf/vocab/hydra.rb', line 15 def Class @Class end |
#collection ⇒ RDF::Vocabulary::Term (readonly)
Collections somehow related to this resource.
163 164 165 |
# File 'lib/rdf/vocab/hydra.rb', line 163 def collection @collection end |
#Collection ⇒ RDF::Vocabulary::Term (readonly)
A collection holding references to a number of related resources.
19 20 21 |
# File 'lib/rdf/vocab/hydra.rb', line 19 def Collection @Collection end |
#description ⇒ RDF::Vocabulary::Term (readonly)
A description.
67 68 69 |
# File 'lib/rdf/vocab/hydra.rb', line 67 def description @description end |
#entrypoint ⇒ RDF::Vocabulary::Term (readonly)
A link to main entry point of the Web API
167 168 169 |
# File 'lib/rdf/vocab/hydra.rb', line 167 def entrypoint @entrypoint end |
#Error ⇒ RDF::Vocabulary::Term (readonly)
A runtime error, used to report information beyond the returned status code.
23 24 25 |
# File 'lib/rdf/vocab/hydra.rb', line 23 def Error @Error end |
#expects ⇒ RDF::Vocabulary::Term (readonly)
The information expected by the Web API.
171 172 173 |
# File 'lib/rdf/vocab/hydra.rb', line 171 def expects @expects end |
#expectsHeader ⇒ RDF::Vocabulary::Term (readonly)
Specification of the header expected by the operation.
71 72 73 |
# File 'lib/rdf/vocab/hydra.rb', line 71 def expectsHeader @expectsHeader end |
#ExplicitRepresentation ⇒ RDF::Vocabulary::Term (readonly)
A representation that serializes a variable value including its language and type information and thus differentiating between IRIs and literals.
155 156 157 |
# File 'lib/rdf/vocab/hydra.rb', line 155 def ExplicitRepresentation @ExplicitRepresentation end |
#first ⇒ RDF::Vocabulary::Term (readonly)
The first resource of an interlinked set of resources.
175 176 177 |
# File 'lib/rdf/vocab/hydra.rb', line 175 def first @first end |
#freetextQuery ⇒ RDF::Vocabulary::Term (readonly)
A property representing a freetext query.
75 76 77 |
# File 'lib/rdf/vocab/hydra.rb', line 75 def freetextQuery @freetextQuery end |
#IriTemplate ⇒ RDF::Vocabulary::Term (readonly)
The class of IRI templates.
27 28 29 |
# File 'lib/rdf/vocab/hydra.rb', line 27 def IriTemplate @IriTemplate end |
#IriTemplateMapping ⇒ RDF::Vocabulary::Term (readonly)
A mapping from an IRI template variable to a property.
31 32 33 |
# File 'lib/rdf/vocab/hydra.rb', line 31 def IriTemplateMapping @IriTemplateMapping end |
#last ⇒ RDF::Vocabulary::Term (readonly)
The last resource of an interlinked set of resources.
179 180 181 |
# File 'lib/rdf/vocab/hydra.rb', line 179 def last @last end |
#limit ⇒ RDF::Vocabulary::Term (readonly)
Instructs to limit set only to N elements.
79 80 81 |
# File 'lib/rdf/vocab/hydra.rb', line 79 def limit @limit end |
#Link ⇒ RDF::Vocabulary::Term (readonly)
The class of properties representing links.
35 36 37 |
# File 'lib/rdf/vocab/hydra.rb', line 35 def Link @Link end |
#manages ⇒ RDF::Vocabulary::Term (readonly)
Semantics of each member provided by the collection.
183 184 185 |
# File 'lib/rdf/vocab/hydra.rb', line 183 def manages @manages end |
#mapping ⇒ RDF::Vocabulary::Term (readonly)
A variable-to-property mapping of the IRI template.
83 84 85 |
# File 'lib/rdf/vocab/hydra.rb', line 83 def mapping @mapping end |
#member ⇒ RDF::Vocabulary::Term (readonly)
A member of the collection
187 188 189 |
# File 'lib/rdf/vocab/hydra.rb', line 187 def member @member end |
#method ⇒ RDF::Vocabulary::Term (readonly)
The HTTP method.
87 88 89 |
# File 'lib/rdf/vocab/hydra.rb', line 87 def method @method end |
#next ⇒ RDF::Vocabulary::Term (readonly)
The resource following the current instance in an interlinked set of resources.
191 192 193 |
# File 'lib/rdf/vocab/hydra.rb', line 191 def next @next end |
#object ⇒ RDF::Vocabulary::Term (readonly)
The object.
195 196 197 |
# File 'lib/rdf/vocab/hydra.rb', line 195 def object @object end |
#offset ⇒ RDF::Vocabulary::Term (readonly)
Instructs to skip N elements of the set.
91 92 93 |
# File 'lib/rdf/vocab/hydra.rb', line 91 def offset @offset end |
#Operation ⇒ RDF::Vocabulary::Term (readonly)
An operation.
39 40 41 |
# File 'lib/rdf/vocab/hydra.rb', line 39 def Operation @Operation end |
#operation ⇒ RDF::Vocabulary::Term (readonly)
An operation supported by the Hydra resource
199 200 201 |
# File 'lib/rdf/vocab/hydra.rb', line 199 def operation @operation end |
#pageIndex ⇒ RDF::Vocabulary::Term (readonly)
Instructs to provide a specific page of the collection at a given index.
95 96 97 |
# File 'lib/rdf/vocab/hydra.rb', line 95 def pageIndex @pageIndex end |
#pageReference ⇒ RDF::Vocabulary::Term (readonly)
Instructs to provide a specific page reference of the collection.
99 100 101 |
# File 'lib/rdf/vocab/hydra.rb', line 99 def pageReference @pageReference end |
#PartialCollectionView ⇒ RDF::Vocabulary::Term (readonly)
A PartialCollectionView describes a partial view of a Collection. Multiple PartialCollectionViews can be connected with the the next/previous properties to allow a client to retrieve all members of the collection.
43 44 45 |
# File 'lib/rdf/vocab/hydra.rb', line 43 def PartialCollectionView @PartialCollectionView end |
#possibleStatus ⇒ RDF::Vocabulary::Term (readonly)
A status that might be returned by the Web API (other statuses should be expected and properly handled as well)
203 204 205 |
# File 'lib/rdf/vocab/hydra.rb', line 203 def possibleStatus @possibleStatus end |
#previous ⇒ RDF::Vocabulary::Term (readonly)
The resource preceding the current instance in an interlinked set of resources.
207 208 209 |
# File 'lib/rdf/vocab/hydra.rb', line 207 def previous @previous end |
#property ⇒ RDF::Vocabulary::Term (readonly)
A property
103 104 105 |
# File 'lib/rdf/vocab/hydra.rb', line 103 def property @property end |
#readable ⇒ RDF::Vocabulary::Term (readonly)
True if the client can retrieve the property’s value, false otherwise.
107 108 109 |
# File 'lib/rdf/vocab/hydra.rb', line 107 def readable @readable end |
#required ⇒ RDF::Vocabulary::Term (readonly)
True if the property is required, false otherwise.
111 112 113 |
# File 'lib/rdf/vocab/hydra.rb', line 111 def required @required end |
#Resource ⇒ RDF::Vocabulary::Term (readonly)
The class of dereferenceable resources.
47 48 49 |
# File 'lib/rdf/vocab/hydra.rb', line 47 def Resource @Resource end |
#returns ⇒ RDF::Vocabulary::Term (readonly)
The information returned by the Web API on success
211 212 213 |
# File 'lib/rdf/vocab/hydra.rb', line 211 def returns @returns end |
#returnsHeader ⇒ RDF::Vocabulary::Term (readonly)
Name of the header returned by the operation.
115 116 117 |
# File 'lib/rdf/vocab/hydra.rb', line 115 def returnsHeader @returnsHeader end |
#Rfc6570Template ⇒ RDF::Vocabulary::Term (readonly)
An IRI template as defined by RFC6570.
147 148 149 |
# File 'lib/rdf/vocab/hydra.rb', line 147 def Rfc6570Template @Rfc6570Template end |
#search ⇒ RDF::Vocabulary::Term (readonly)
A IRI template that can be used to query a collection.
215 216 217 |
# File 'lib/rdf/vocab/hydra.rb', line 215 def search @search end |
#Status ⇒ RDF::Vocabulary::Term (readonly)
Additional information about a status code that might be returned.
51 52 53 |
# File 'lib/rdf/vocab/hydra.rb', line 51 def Status @Status end |
#statusCode ⇒ RDF::Vocabulary::Term (readonly)
The HTTP status code
119 120 121 |
# File 'lib/rdf/vocab/hydra.rb', line 119 def statusCode @statusCode end |
#subject ⇒ RDF::Vocabulary::Term (readonly)
The subject.
219 220 221 |
# File 'lib/rdf/vocab/hydra.rb', line 219 def subject @subject end |
#supportedClass ⇒ RDF::Vocabulary::Term (readonly)
A class known to be supported by the Web API
223 224 225 |
# File 'lib/rdf/vocab/hydra.rb', line 223 def supportedClass @supportedClass end |
#supportedOperation ⇒ RDF::Vocabulary::Term (readonly)
An operation supported by instances of the specific Hydra class or the target of the Hydra link
227 228 229 |
# File 'lib/rdf/vocab/hydra.rb', line 227 def supportedOperation @supportedOperation end |
#SupportedProperty ⇒ RDF::Vocabulary::Term (readonly)
A property known to be supported by a Hydra class.
55 56 57 |
# File 'lib/rdf/vocab/hydra.rb', line 55 def SupportedProperty @SupportedProperty end |
#supportedProperty ⇒ RDF::Vocabulary::Term (readonly)
The properties known to be supported by a Hydra class
231 232 233 |
# File 'lib/rdf/vocab/hydra.rb', line 231 def supportedProperty @supportedProperty end |
#template ⇒ RDF::Vocabulary::Term (readonly)
A templated string with placeholders. The literal’s datatype indicates the template syntax; if not specified, hydra:Rfc6570Template is assumed.
123 124 125 |
# File 'lib/rdf/vocab/hydra.rb', line 123 def template @template end |
#TemplatedLink ⇒ RDF::Vocabulary::Term (readonly)
A templated link.
59 60 61 |
# File 'lib/rdf/vocab/hydra.rb', line 59 def TemplatedLink @TemplatedLink end |
#title ⇒ RDF::Vocabulary::Term (readonly)
A title, often used along with a description.
127 128 129 |
# File 'lib/rdf/vocab/hydra.rb', line 127 def title @title end |
#totalItems ⇒ RDF::Vocabulary::Term (readonly)
The total number of items referenced by a collection.
131 132 133 |
# File 'lib/rdf/vocab/hydra.rb', line 131 def totalItems @totalItems end |
#variable ⇒ RDF::Vocabulary::Term (readonly)
An IRI template variable
135 136 137 |
# File 'lib/rdf/vocab/hydra.rb', line 135 def variable @variable end |
#variableRepresentation ⇒ RDF::Vocabulary::Term (readonly)
The representation format to use when expanding the IRI template.
139 140 141 |
# File 'lib/rdf/vocab/hydra.rb', line 139 def variableRepresentation @variableRepresentation end |
#VariableRepresentation ⇒ RDF::Vocabulary::Term (readonly)
A representation specifies how to serialize variable values into strings.
63 64 65 |
# File 'lib/rdf/vocab/hydra.rb', line 63 def VariableRepresentation @VariableRepresentation end |
#view ⇒ RDF::Vocabulary::Term (readonly)
A specific view of a resource.
235 236 237 |
# File 'lib/rdf/vocab/hydra.rb', line 235 def view @view end |
#writeable ⇒ RDF::Vocabulary::Term (readonly)
True if the client can change the property’s value, false otherwise.
143 144 145 |
# File 'lib/rdf/vocab/hydra.rb', line 143 def writeable @writeable end |