Class: RDF::Vocab::HYDRA

Inherits:
StrictVocabulary show all
Defined in:
vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb

Overview

Vocabulary for http://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

Method Summary

Methods inherited from StrictVocabulary

[], strict?

Methods inherited from RDF::Vocabulary

[], #[], __prefix__, _orig_each, _orig_from_sym, camelize, each, each_statement, enum_for, expand_pname, find, find_term, from_graph, from_sym, imported_from, imports, #initialize, #inspect, inspect, limit_vocabs, list, method_missing, #method_missing, ontology, properties, property, register, strict?, to_html, to_iri, to_jsonld, #to_s, to_s, to_ttl, #to_uri, to_uri, value_to_html, vocab_map

Constructor Details

This class inherits a constructor from RDF::Vocabulary

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class RDF::Vocabulary

Instance Attribute Details

#ApiDocumentationRDF::Vocabulary::Term (readonly)

The Hydra API documentation class



11
12
13
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 11

def ApiDocumentation
  @ApiDocumentation
end

#apiDocumentationRDF::Vocabulary::Term (readonly)

A link to the API documentation



174
175
176
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 174

def apiDocumentation
  @apiDocumentation
end

#BaseUriSourceRDF::Vocabulary::Term (readonly)

Provides a base abstract for base Uri source for Iri template resolution.



15
16
17
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 15

def BaseUriSource
  @BaseUriSource
end

#BasicRepresentationRDF::Vocabulary::Term (readonly)

A representation that serializes just the lexical form of a variable value, but omits language and type information.



158
159
160
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 158

def BasicRepresentation
  @BasicRepresentation
end

#ClassRDF::Vocabulary::Term (readonly)

The class of Hydra classes.



19
20
21
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 19

def Class
  @Class
end

#collectionRDF::Vocabulary::Term (readonly)

Collections somehow related to this resource.



178
179
180
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 178

def collection
  @collection
end

#CollectionRDF::Vocabulary::Term (readonly)

A collection holding references to a number of related resources.



23
24
25
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 23

def Collection
  @Collection
end

#descriptionRDF::Vocabulary::Term (readonly)

A description.



71
72
73
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 71

def description
  @description
end

#entrypointRDF::Vocabulary::Term (readonly)

A link to main entry point of the Web API



182
183
184
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 182

def entrypoint
  @entrypoint
end

#ErrorRDF::Vocabulary::Term (readonly)

A runtime error, used to report information beyond the returned status code.



27
28
29
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 27

def Error
  @Error
end

#expectsRDF::Vocabulary::Term (readonly)

The information expected by the Web API.



186
187
188
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 186

def expects
  @expects
end

#expectsHeaderRDF::Vocabulary::Term (readonly)

Specification of the header expected by the operation.



75
76
77
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 75

def expectsHeader
  @expectsHeader
end

#ExplicitRepresentationRDF::Vocabulary::Term (readonly)

A representation that serializes a variable value including its language and type information and thus differentiating between IRIs and literals.



162
163
164
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 162

def ExplicitRepresentation
  @ExplicitRepresentation
end

#firstRDF::Vocabulary::Term (readonly)

The first resource of an interlinked set of resources.



190
191
192
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 190

def first
  @first
end

#freetextQueryRDF::Vocabulary::Term (readonly)

A property representing a freetext query.



79
80
81
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 79

def freetextQuery
  @freetextQuery
end

#IriTemplateRDF::Vocabulary::Term (readonly)

The class of IRI templates.



31
32
33
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 31

def IriTemplate
  @IriTemplate
end

#IriTemplateMappingRDF::Vocabulary::Term (readonly)

A mapping from an IRI template variable to a property.



35
36
37
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 35

def IriTemplateMapping
  @IriTemplateMapping
end

#lastRDF::Vocabulary::Term (readonly)

The last resource of an interlinked set of resources.



194
195
196
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 194

def last
  @last
end

#limitRDF::Vocabulary::Term (readonly)

Instructs to limit set only to N elements.



83
84
85
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 83

def limit
  @limit
end

The class of properties representing links.



39
40
41
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 39

def Link
  @Link
end

#LinkContextRDF::Vocabulary::Term (readonly)

States that the link's context IRI, as defined in RFC 5988, should be used as the base Uri



166
167
168
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 166

def LinkContext
  @LinkContext
end

#managesRDF::Vocabulary::Term (readonly)

This predicate is left for compatibility purposes and hydra:memberAssertion should be used instead.



198
199
200
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 198

def manages
  @manages
end

#mappingRDF::Vocabulary::Term (readonly)

A variable-to-property mapping of the IRI template.



87
88
89
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 87

def mapping
  @mapping
end

#memberRDF::Vocabulary::Term (readonly)

A member of the collection



202
203
204
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 202

def member
  @member
end

#memberAssertionRDF::Vocabulary::Term (readonly)

Semantics of each member provided by the collection.



206
207
208
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 206

def memberAssertion
  @memberAssertion
end

#methodRDF::Vocabulary::Term (readonly)

The HTTP method.



91
92
93
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 91

def method
  @method
end

#nextRDF::Vocabulary::Term (readonly)

The resource following the current instance in an interlinked set of resources.



210
211
212
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 210

def next
  @next
end

#objectRDF::Vocabulary::Term (readonly)

The object.



214
215
216
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 214

def object
  @object
end

#offsetRDF::Vocabulary::Term (readonly)

Instructs to skip N elements of the set.



95
96
97
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 95

def offset
  @offset
end

#OperationRDF::Vocabulary::Term (readonly)

An operation.



43
44
45
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 43

def Operation
  @Operation
end

#operationRDF::Vocabulary::Term (readonly)

An operation supported by the Hydra resource



218
219
220
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 218

def operation
  @operation
end

#pageIndexRDF::Vocabulary::Term (readonly)

Instructs to provide a specific page of the collection at a given index.



99
100
101
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 99

def pageIndex
  @pageIndex
end

#pageReferenceRDF::Vocabulary::Term (readonly)

Instructs to provide a specific page reference of the collection.



103
104
105
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 103

def pageReference
  @pageReference
end

#PartialCollectionViewRDF::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.



47
48
49
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 47

def PartialCollectionView
  @PartialCollectionView
end

#possibleStatusRDF::Vocabulary::Term (readonly)

A status that might be returned by the Web API (other statuses should be expected and properly handled as well)



222
223
224
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 222

def possibleStatus
  @possibleStatus
end

#previousRDF::Vocabulary::Term (readonly)

The resource preceding the current instance in an interlinked set of resources.



226
227
228
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 226

def previous
  @previous
end

#propertyRDF::Vocabulary::Term (readonly)

A property



107
108
109
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 107

def property
  @property
end

#readableRDF::Vocabulary::Term (readonly)

True if the client can retrieve the property's value, false otherwise.



111
112
113
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 111

def readable
  @readable
end

#requiredRDF::Vocabulary::Term (readonly)

True if the property is required, false otherwise.



115
116
117
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 115

def required
  @required
end

#resolveRelativeUsingRDF::Vocabulary::Term (readonly)



118
119
120
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 118

def resolveRelativeUsing
  @resolveRelativeUsing
end

#ResourceRDF::Vocabulary::Term (readonly)

The class of dereferenceable resources by means a client can attempt to dereference; however, the received responses should still be verified.



51
52
53
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 51

def Resource
  @Resource
end

#returnsRDF::Vocabulary::Term (readonly)

The information returned by the Web API on success



230
231
232
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 230

def returns
  @returns
end

#returnsHeaderRDF::Vocabulary::Term (readonly)

Name of the header returned by the operation.



122
123
124
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 122

def returnsHeader
  @returnsHeader
end

#Rfc3986RDF::Vocabulary::Term (readonly)

States that the base Uri should be established using RFC 3986 reference resolution algorithm specified in section 5.



170
171
172
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 170

def Rfc3986
  @Rfc3986
end

#Rfc6570TemplateRDF::Vocabulary::Term (readonly)

An IRI template as defined by RFC6570.



154
155
156
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 154

def Rfc6570Template
  @Rfc6570Template
end

#searchRDF::Vocabulary::Term (readonly)

A IRI template that can be used to query a collection.



234
235
236
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 234

def search
  @search
end

#StatusRDF::Vocabulary::Term (readonly)

Additional information about a status code that might be returned.



55
56
57
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 55

def Status
  @Status
end

#statusCodeRDF::Vocabulary::Term (readonly)

The HTTP status code



126
127
128
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 126

def statusCode
  @statusCode
end

#subjectRDF::Vocabulary::Term (readonly)

The subject.



238
239
240
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 238

def subject
  @subject
end

#supportedClassRDF::Vocabulary::Term (readonly)

A class known to be supported by the Web API



242
243
244
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 242

def supportedClass
  @supportedClass
end

#supportedOperationRDF::Vocabulary::Term (readonly)

An operation supported by instances of the specific Hydra class or the target of the Hydra link



246
247
248
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 246

def supportedOperation
  @supportedOperation
end

#supportedPropertyRDF::Vocabulary::Term (readonly)

The properties known to be supported by a Hydra class



250
251
252
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 250

def supportedProperty
  @supportedProperty
end

#SupportedPropertyRDF::Vocabulary::Term (readonly)

A property known to be supported by a Hydra class.



59
60
61
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 59

def SupportedProperty
  @SupportedProperty
end

#templateRDF::Vocabulary::Term (readonly)

A templated string with placeholders. The literal's datatype indicates the template syntax; if not specified, hydra:Rfc6570Template is assumed.



130
131
132
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 130

def template
  @template
end

A templated link.



63
64
65
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 63

def TemplatedLink
  @TemplatedLink
end

#titleRDF::Vocabulary::Term (readonly)

A title, often used along with a description.



134
135
136
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 134

def title
  @title
end

#totalItemsRDF::Vocabulary::Term (readonly)

The total number of items referenced by a collection.



138
139
140
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 138

def totalItems
  @totalItems
end

#variableRDF::Vocabulary::Term (readonly)

An IRI template variable



142
143
144
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 142

def variable
  @variable
end

#VariableRepresentationRDF::Vocabulary::Term (readonly)

A representation specifies how to serialize variable values into strings.



67
68
69
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 67

def VariableRepresentation
  @VariableRepresentation
end

#variableRepresentationRDF::Vocabulary::Term (readonly)

The representation format to use when expanding the IRI template.



146
147
148
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 146

def variableRepresentation
  @variableRepresentation
end

#viewRDF::Vocabulary::Term (readonly)

A specific view of a resource.



254
255
256
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 254

def view
  @view
end

#writableRDF::Vocabulary::Term (readonly)

True if the client can change the property's value, false otherwise.



150
151
152
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 150

def writable
  @writable
end

#writeableRDF::Vocabulary::Term (readonly)

This property is left for compatibility purposes and hydra:writable should be used instead.



258
259
260
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-4431c6a28a93/lib/rdf/vocab/hydra.rb', line 258

def writeable
  @writeable
end