Class: RDF::Vocab::HYDRA

Inherits:
StrictVocabulary
  • Object
show all
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

Instance Attribute Details

#ApiDocumentation ⇒ RDF::Vocabulary::Term (readonly)

The Hydra API documentation class

Returns:

  • (RDF::Vocabulary::Term) 


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

Returns:

  • (RDF::Vocabulary::Term) 


174
175
176
 
# File 'lib/rdf/vocab/hydra.rb', line 174

def apiDocumentation
  @apiDocumentation
end

#BaseUriSource ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


15
16
17
 
# File 'lib/rdf/vocab/hydra.rb', line 15

def BaseUriSource
  @BaseUriSource
end

#BasicRepresentation ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


158
159
160
 
# File 'lib/rdf/vocab/hydra.rb', line 158

def BasicRepresentation
  @BasicRepresentation
end

#Class ⇒ RDF::Vocabulary::Term (readonly)

The class of Hydra classes.

Returns:

  • (RDF::Vocabulary::Term) 


19
20
21
 
# File 'lib/rdf/vocab/hydra.rb', line 19

def Class
  @Class
end

#Collection ⇒ RDF::Vocabulary::Term (readonly)

A collection holding references to a number of related resources.

Returns:

  • (RDF::Vocabulary::Term) 


23
24
25
 
# File 'lib/rdf/vocab/hydra.rb', line 23

def Collection
  @Collection
end

#collection ⇒ RDF::Vocabulary::Term (readonly)

Collections somehow related to this resource.

Returns:

  • (RDF::Vocabulary::Term) 


178
179
180
 
# File 'lib/rdf/vocab/hydra.rb', line 178

def collection
  @collection
end

#description ⇒ RDF::Vocabulary::Term (readonly)

A description.

Returns:

  • (RDF::Vocabulary::Term) 


71
72
73
 
# File 'lib/rdf/vocab/hydra.rb', line 71

def description
  @description
end

#entrypoint ⇒ RDF::Vocabulary::Term (readonly)

A link to main entry point of the Web API

Returns:

  • (RDF::Vocabulary::Term) 


182
183
184
 
# File 'lib/rdf/vocab/hydra.rb', line 182

def entrypoint
  @entrypoint
end

#Error ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


27
28
29
 
# File 'lib/rdf/vocab/hydra.rb', line 27

def Error
  @Error
end

#expects ⇒ RDF::Vocabulary::Term (readonly)

The information expected by the Web API.

Returns:

  • (RDF::Vocabulary::Term) 


186
187
188
 
# File 'lib/rdf/vocab/hydra.rb', line 186

def expects
  @expects
end

#expectsHeader ⇒ RDF::Vocabulary::Term (readonly)

Specification of the header expected by the operation.

Returns:

  • (RDF::Vocabulary::Term) 


75
76
77
 
# File 'lib/rdf/vocab/hydra.rb', line 75

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.

Returns:

  • (RDF::Vocabulary::Term) 


162
163
164
 
# File 'lib/rdf/vocab/hydra.rb', line 162

def ExplicitRepresentation
  @ExplicitRepresentation
end

#first ⇒ RDF::Vocabulary::Term (readonly)

The first resource of an interlinked set of resources.

Returns:

  • (RDF::Vocabulary::Term) 


190
191
192
 
# File 'lib/rdf/vocab/hydra.rb', line 190

def first
  @first
end

#freetextQuery ⇒ RDF::Vocabulary::Term (readonly)

A property representing a freetext query.

Returns:

  • (RDF::Vocabulary::Term) 


79
80
81
 
# File 'lib/rdf/vocab/hydra.rb', line 79

def freetextQuery
  @freetextQuery
end

#IriTemplate ⇒ RDF::Vocabulary::Term (readonly)

The class of IRI templates.

Returns:

  • (RDF::Vocabulary::Term) 


31
32
33
 
# File 'lib/rdf/vocab/hydra.rb', line 31

def IriTemplate
  @IriTemplate
end

#IriTemplateMapping ⇒ RDF::Vocabulary::Term (readonly)

A mapping from an IRI template variable to a property.

Returns:

  • (RDF::Vocabulary::Term) 


35
36
37
 
# File 'lib/rdf/vocab/hydra.rb', line 35

def IriTemplateMapping
  @IriTemplateMapping
end

#last ⇒ RDF::Vocabulary::Term (readonly)

The last resource of an interlinked set of resources.

Returns:

  • (RDF::Vocabulary::Term) 


194
195
196
 
# File 'lib/rdf/vocab/hydra.rb', line 194

def last
  @last
end

#limit ⇒ RDF::Vocabulary::Term (readonly)

Instructs to limit set only to N elements.

Returns:

  • (RDF::Vocabulary::Term) 


83
84
85
 
# File 'lib/rdf/vocab/hydra.rb', line 83

def limit
  @limit
end

#Link ⇒ RDF::Vocabulary::Term (readonly)

The class of properties representing links.

Returns:

  • (RDF::Vocabulary::Term) 


39
40
41
 
# File 'lib/rdf/vocab/hydra.rb', line 39

def Link
  @Link
end

#LinkContext ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


166
167
168
 
# File 'lib/rdf/vocab/hydra.rb', line 166

def LinkContext
  @LinkContext
end

#manages ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


198
199
200
 
# File 'lib/rdf/vocab/hydra.rb', line 198

def manages
  @manages
end

#mapping ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


87
88
89
 
# File 'lib/rdf/vocab/hydra.rb', line 87

def mapping
  @mapping
end

#member ⇒ RDF::Vocabulary::Term (readonly)

A member of the collection

Returns:

  • (RDF::Vocabulary::Term) 


202
203
204
 
# File 'lib/rdf/vocab/hydra.rb', line 202

def member
  @member
end

#memberAssertion ⇒ RDF::Vocabulary::Term (readonly)

Semantics of each member provided by the collection.

Returns:

  • (RDF::Vocabulary::Term) 


206
207
208
 
# File 'lib/rdf/vocab/hydra.rb', line 206

def memberAssertion
  @memberAssertion
end

#method ⇒ RDF::Vocabulary::Term (readonly)

The HTTP method.

Returns:

  • (RDF::Vocabulary::Term) 


91
92
93
 
# File 'lib/rdf/vocab/hydra.rb', line 91

def method
  @method
end

#next ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


210
211
212
 
# File 'lib/rdf/vocab/hydra.rb', line 210

def next
  @next
end

#object ⇒ RDF::Vocabulary::Term (readonly)

The object.

Returns:

  • (RDF::Vocabulary::Term) 


214
215
216
 
# File 'lib/rdf/vocab/hydra.rb', line 214

def object
  @object
end

#offset ⇒ RDF::Vocabulary::Term (readonly)

Instructs to skip N elements of the set.

Returns:

  • (RDF::Vocabulary::Term) 


95
96
97
 
# File 'lib/rdf/vocab/hydra.rb', line 95

def offset
  @offset
end

#Operation ⇒ RDF::Vocabulary::Term (readonly)

An operation.

Returns:

  • (RDF::Vocabulary::Term) 


43
44
45
 
# File 'lib/rdf/vocab/hydra.rb', line 43

def Operation
  @Operation
end

#operation ⇒ RDF::Vocabulary::Term (readonly)

An operation supported by the Hydra resource

Returns:

  • (RDF::Vocabulary::Term) 


218
219
220
 
# File 'lib/rdf/vocab/hydra.rb', line 218

def operation
  @operation
end

#pageIndex ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


99
100
101
 
# File 'lib/rdf/vocab/hydra.rb', line 99

def pageIndex
  @pageIndex
end

#pageReference ⇒ RDF::Vocabulary::Term (readonly)

Instructs to provide a specific page reference of the collection.

Returns:

  • (RDF::Vocabulary::Term) 


103
104
105
 
# File 'lib/rdf/vocab/hydra.rb', line 103

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.

Returns:

  • (RDF::Vocabulary::Term) 


47
48
49
 
# File 'lib/rdf/vocab/hydra.rb', line 47

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)

Returns:

  • (RDF::Vocabulary::Term) 


222
223
224
 
# File 'lib/rdf/vocab/hydra.rb', line 222

def possibleStatus
  @possibleStatus
end

#previous ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


226
227
228
 
# File 'lib/rdf/vocab/hydra.rb', line 226

def previous
  @previous
end

#property ⇒ RDF::Vocabulary::Term (readonly)

A property

Returns:

  • (RDF::Vocabulary::Term) 


107
108
109
 
# File 'lib/rdf/vocab/hydra.rb', line 107

def property
  @property
end

#readable ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


111
112
113
 
# File 'lib/rdf/vocab/hydra.rb', line 111

def readable
  @readable
end

#required ⇒ RDF::Vocabulary::Term (readonly)

True if the property is required, false otherwise.

Returns:

  • (RDF::Vocabulary::Term) 


115
116
117
 
# File 'lib/rdf/vocab/hydra.rb', line 115

def required
  @required
end

#resolveRelativeUsing ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


118
119
120
 
# File 'lib/rdf/vocab/hydra.rb', line 118

def resolveRelativeUsing
  @resolveRelativeUsing
end

#Resource ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


51
52
53
 
# File 'lib/rdf/vocab/hydra.rb', line 51

def Resource
  @Resource
end

#returns ⇒ RDF::Vocabulary::Term (readonly)

The information returned by the Web API on success

Returns:

  • (RDF::Vocabulary::Term) 


230
231
232
 
# File 'lib/rdf/vocab/hydra.rb', line 230

def returns
  @returns
end

#returnsHeader ⇒ RDF::Vocabulary::Term (readonly)

Name of the header returned by the operation.

Returns:

  • (RDF::Vocabulary::Term) 


122
123
124
 
# File 'lib/rdf/vocab/hydra.rb', line 122

def returnsHeader
  @returnsHeader
end

#Rfc3986 ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


170
171
172
 
# File 'lib/rdf/vocab/hydra.rb', line 170

def Rfc3986
  @Rfc3986
end

#Rfc6570Template ⇒ RDF::Vocabulary::Term (readonly)

An IRI template as defined by RFC6570.

Returns:

  • (RDF::Vocabulary::Term) 


154
155
156
 
# File 'lib/rdf/vocab/hydra.rb', line 154

def Rfc6570Template
  @Rfc6570Template
end

#search ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


234
235
236
 
# File 'lib/rdf/vocab/hydra.rb', line 234

def search
  @search
end

#Status ⇒ RDF::Vocabulary::Term (readonly)

Additional information about a status code that might be returned.

Returns:

  • (RDF::Vocabulary::Term) 


55
56
57
 
# File 'lib/rdf/vocab/hydra.rb', line 55

def Status
  @Status
end

#statusCode ⇒ RDF::Vocabulary::Term (readonly)

The HTTP status code

Returns:

  • (RDF::Vocabulary::Term) 


126
127
128
 
# File 'lib/rdf/vocab/hydra.rb', line 126

def statusCode
  @statusCode
end

#subject ⇒ RDF::Vocabulary::Term (readonly)

The subject.

Returns:

  • (RDF::Vocabulary::Term) 


238
239
240
 
# File 'lib/rdf/vocab/hydra.rb', line 238

def subject
  @subject
end

#supportedClass ⇒ RDF::Vocabulary::Term (readonly)

A class known to be supported by the Web API

Returns:

  • (RDF::Vocabulary::Term) 


242
243
244
 
# File 'lib/rdf/vocab/hydra.rb', line 242

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

Returns:

  • (RDF::Vocabulary::Term) 


246
247
248
 
# File 'lib/rdf/vocab/hydra.rb', line 246

def supportedOperation
  @supportedOperation
end

#supportedProperty ⇒ RDF::Vocabulary::Term (readonly)

The properties known to be supported by a Hydra class

Returns:

  • (RDF::Vocabulary::Term) 


250
251
252
 
# File 'lib/rdf/vocab/hydra.rb', line 250

def supportedProperty
  @supportedProperty
end

#SupportedProperty ⇒ RDF::Vocabulary::Term (readonly)

A property known to be supported by a Hydra class.

Returns:

  • (RDF::Vocabulary::Term) 


59
60
61
 
# File 'lib/rdf/vocab/hydra.rb', line 59

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.

Returns:

  • (RDF::Vocabulary::Term) 


130
131
132
 
# File 'lib/rdf/vocab/hydra.rb', line 130

def template
  @template
end

#TemplatedLink ⇒ RDF::Vocabulary::Term (readonly)

A templated link.

Returns:

  • (RDF::Vocabulary::Term) 


63
64
65
 
# File 'lib/rdf/vocab/hydra.rb', line 63

def TemplatedLink
  @TemplatedLink
end

#title ⇒ RDF::Vocabulary::Term (readonly)

A title, often used along with a description.

Returns:

  • (RDF::Vocabulary::Term) 


134
135
136
 
# File 'lib/rdf/vocab/hydra.rb', line 134

def title
  @title
end

#totalItems ⇒ RDF::Vocabulary::Term (readonly)

The total number of items referenced by a collection.

Returns:

  • (RDF::Vocabulary::Term) 


138
139
140
 
# File 'lib/rdf/vocab/hydra.rb', line 138

def totalItems
  @totalItems
end

#variable ⇒ RDF::Vocabulary::Term (readonly)

An IRI template variable

Returns:

  • (RDF::Vocabulary::Term) 


142
143
144
 
# File 'lib/rdf/vocab/hydra.rb', line 142

def variable
  @variable
end

#variableRepresentation ⇒ RDF::Vocabulary::Term (readonly)

The representation format to use when expanding the IRI template.

Returns:

  • (RDF::Vocabulary::Term) 


146
147
148
 
# File 'lib/rdf/vocab/hydra.rb', line 146

def variableRepresentation
  @variableRepresentation
end

#VariableRepresentation ⇒ RDF::Vocabulary::Term (readonly)

A representation specifies how to serialize variable values into strings.

Returns:

  • (RDF::Vocabulary::Term) 


67
68
69
 
# File 'lib/rdf/vocab/hydra.rb', line 67

def VariableRepresentation
  @VariableRepresentation
end

#view ⇒ RDF::Vocabulary::Term (readonly)

A specific view of a resource.

Returns:

  • (RDF::Vocabulary::Term) 


254
255
256
 
# File 'lib/rdf/vocab/hydra.rb', line 254

def view
  @view
end

#writable ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


150
151
152
 
# File 'lib/rdf/vocab/hydra.rb', line 150

def writable
  @writable
end

#writeable ⇒ RDF::Vocabulary::Term (readonly)

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

Returns:

  • (RDF::Vocabulary::Term) 


258
259
260
 
# File 'lib/rdf/vocab/hydra.rb', line 258

def writeable
  @writeable
end