Class: RDF::Vocab::HYDRA

Inherits:
StrictVocabulary show all
Defined in:
vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/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, 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)

A link to the API documentation



159
160
161
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 159

def apiDocumentation
  @apiDocumentation
end

#ApiDocumentationRDF::Vocabulary::Term (readonly)

The Hydra API documentation class



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

def ApiDocumentation
  @ApiDocumentation
end

#BasicRepresentationRDF::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 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 151

def BasicRepresentation
  @BasicRepresentation
end

#ClassRDF::Vocabulary::Term (readonly)

The class of Hydra classes. Hydra classes and their instances are dereferenceable resources.



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

def Class
  @Class
end

#CollectionRDF::Vocabulary::Term (readonly)

A collection holding references to a number of related resources.



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

def Collection
  @Collection
end

#collectionRDF::Vocabulary::Term (readonly)

Collections somehow related to this resource.



163
164
165
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 163

def collection
  @collection
end

#descriptionRDF::Vocabulary::Term (readonly)

A description.



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

def description
  @description
end

#entrypointRDF::Vocabulary::Term (readonly)

A link to main entry point of the Web API



167
168
169
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 167

def entrypoint
  @entrypoint
end

#ErrorRDF::Vocabulary::Term (readonly)

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



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

def Error
  @Error
end

#expectsRDF::Vocabulary::Term (readonly)

The information expected by the Web API.



171
172
173
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 171

def expects
  @expects
end

#expectsHeaderRDF::Vocabulary::Term (readonly)

Specification of the header expected by the operation.



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

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.



155
156
157
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 155

def ExplicitRepresentation
  @ExplicitRepresentation
end

#firstRDF::Vocabulary::Term (readonly)

The first resource of an interlinked set of resources.



175
176
177
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 175

def first
  @first
end

#freetextQueryRDF::Vocabulary::Term (readonly)

A property representing a freetext query.



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

def freetextQuery
  @freetextQuery
end

#IriTemplateRDF::Vocabulary::Term (readonly)

The class of IRI templates.



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

def IriTemplate
  @IriTemplate
end

#IriTemplateMappingRDF::Vocabulary::Term (readonly)

A mapping from an IRI template variable to a property.



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

def IriTemplateMapping
  @IriTemplateMapping
end

#lastRDF::Vocabulary::Term (readonly)

The last resource of an interlinked set of resources.



179
180
181
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 179

def last
  @last
end

#limitRDF::Vocabulary::Term (readonly)

Instructs to limit set only to N elements.



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

def limit
  @limit
end

The class of properties representing links.



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

def Link
  @Link
end

#managesRDF::Vocabulary::Term (readonly)

Semantics of each member provided by the collection.



183
184
185
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 183

def manages
  @manages
end

#mappingRDF::Vocabulary::Term (readonly)

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



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

def mapping
  @mapping
end

#memberRDF::Vocabulary::Term (readonly)

A member of the collection



187
188
189
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 187

def member
  @member
end

#methodRDF::Vocabulary::Term (readonly)

The HTTP method.



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

def method
  @method
end

#nextRDF::Vocabulary::Term (readonly)

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



191
192
193
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 191

def next
  @next
end

#objectRDF::Vocabulary::Term (readonly)

The object.



195
196
197
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 195

def object
  @object
end

#offsetRDF::Vocabulary::Term (readonly)

Instructs to skip N elements of the set.



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

def offset
  @offset
end

#OperationRDF::Vocabulary::Term (readonly)

An operation.



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

def Operation
  @Operation
end

#operationRDF::Vocabulary::Term (readonly)

An operation supported by the Hydra resource



199
200
201
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 199

def operation
  @operation
end

#pageIndexRDF::Vocabulary::Term (readonly)

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



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

def pageIndex
  @pageIndex
end

#pageReferenceRDF::Vocabulary::Term (readonly)

Instructs to provide a specific page reference of the collection.



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

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.



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

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)



203
204
205
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 203

def possibleStatus
  @possibleStatus
end

#previousRDF::Vocabulary::Term (readonly)

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



207
208
209
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 207

def previous
  @previous
end

#propertyRDF::Vocabulary::Term (readonly)

A property



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

def property
  @property
end

#readableRDF::Vocabulary::Term (readonly)

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



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

def readable
  @readable
end

#requiredRDF::Vocabulary::Term (readonly)

True if the property is required, false otherwise.



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

def required
  @required
end

#ResourceRDF::Vocabulary::Term (readonly)

The class of dereferenceable resources.



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

def Resource
  @Resource
end

#returnsRDF::Vocabulary::Term (readonly)

The information returned by the Web API on success



211
212
213
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 211

def returns
  @returns
end

#returnsHeaderRDF::Vocabulary::Term (readonly)

Name of the header returned by the operation.



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

def returnsHeader
  @returnsHeader
end

#Rfc6570TemplateRDF::Vocabulary::Term (readonly)

An IRI template as defined by RFC6570.



147
148
149
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 147

def Rfc6570Template
  @Rfc6570Template
end

#searchRDF::Vocabulary::Term (readonly)

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



215
216
217
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 215

def search
  @search
end

#StatusRDF::Vocabulary::Term (readonly)

Additional information about a status code that might be returned.



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

def Status
  @Status
end

#statusCodeRDF::Vocabulary::Term (readonly)

The HTTP status code



119
120
121
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 119

def statusCode
  @statusCode
end

#subjectRDF::Vocabulary::Term (readonly)

The subject.



219
220
221
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 219

def subject
  @subject
end

#supportedClassRDF::Vocabulary::Term (readonly)

A class known to be supported by the Web API



223
224
225
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 223

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



227
228
229
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 227

def supportedOperation
  @supportedOperation
end

#supportedPropertyRDF::Vocabulary::Term (readonly)

The properties known to be supported by a Hydra class



231
232
233
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 231

def supportedProperty
  @supportedProperty
end

#SupportedPropertyRDF::Vocabulary::Term (readonly)

A property known to be supported by a Hydra class.



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

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.



123
124
125
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 123

def template
  @template
end

A templated link.



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

def TemplatedLink
  @TemplatedLink
end

#titleRDF::Vocabulary::Term (readonly)

A title, often used along with a description.



127
128
129
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 127

def title
  @title
end

#totalItemsRDF::Vocabulary::Term (readonly)

The total number of items referenced by a collection.



131
132
133
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 131

def totalItems
  @totalItems
end

#variableRDF::Vocabulary::Term (readonly)

An IRI template variable



135
136
137
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 135

def variable
  @variable
end

#VariableRepresentationRDF::Vocabulary::Term (readonly)

A representation specifies how to serialize variable values into strings.



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

def VariableRepresentation
  @VariableRepresentation
end

#variableRepresentationRDF::Vocabulary::Term (readonly)

The representation format to use when expanding the IRI template.



139
140
141
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 139

def variableRepresentation
  @variableRepresentation
end

#viewRDF::Vocabulary::Term (readonly)

A specific view of a resource.



235
236
237
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 235

def view
  @view
end

#writeableRDF::Vocabulary::Term (readonly)

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



143
144
145
# File 'vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/hydra.rb', line 143

def writeable
  @writeable
end