Class: RDF::Vocab::OA

Inherits:
StrictVocabulary
  • Object
show all
Defined in:
lib/rdf/vocab/oa.rb

Overview

Vocabulary for <www.w3.org/ns/oa#>

Web Annotation Ontology

The Web Annotation ontology defines the terms of the Web Annotation vocabulary. Any changes to this document MUST be from a Working Group in the W3C that has established expertise in the area.

See Also:

Version:

  • 2016-11-12T21:28:11Z

Instance Attribute Summary collapse

Instance Attribute Details

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

The class for Web Annotations.

Returns:

  • (RDF::Vocabulary::Term) 


11
12
13
 
# File 'lib/rdf/vocab/oa.rb', line 11

def Annotation
  @Annotation
end

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

The object of the relationship is the end point of a service that conforms to the annotation-protocol, and it may be associated with any resource. The expectation of asserting the relationship is that the object is the preferred service for maintaining annotations about the subject resource, according to the publisher of the relationship. This relationship is intended to be used both within Linked Data descriptions and as the rel type of a Link, via HTTP Link Headers rfc5988 for binary resources and in HTML <link> elements. For more information about these, please see the Annotation Protocol specification annotation-protocol.

Returns:

  • (RDF::Vocabulary::Term) 


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

def annotationService
  @annotationService
end

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

The motivation for when the user intends to provide an assessment about the Target resource.

Returns:

  • (RDF::Vocabulary::Term) 


219
220
221
 
# File 'lib/rdf/vocab/oa.rb', line 219

def assessing
  @assessing
end

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

The object of the predicate is a plain text string to be used as the content of the body of the Annotation. The value MUST be an xsd:string and that data type MUST NOT be expressed in the serialization. Note that language MUST NOT be associated with the value either as a language tag, as that is only available for rdf:langString .

Returns:

  • (RDF::Vocabulary::Term) 


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

def bodyValue
  @bodyValue
end

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

The motivation for when the user intends to create a bookmark to the Target or part thereof.

Returns:

  • (RDF::Vocabulary::Term) 


223
224
225
 
# File 'lib/rdf/vocab/oa.rb', line 223

def bookmarking
  @bookmarking
end

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

A object of the relationship is a copy of the Source resource’s representation, appropriate for the Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


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

def cachedSource
  @cachedSource
end

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

A object of the relationship is the canonical IRI that can always be used to deduplicate the Annotation, regardless of the current IRI used to access the representation.

Returns:

  • (RDF::Vocabulary::Term) 


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

def canonical
  @canonical
end

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

A subClass of as:OrderedCollection that conveys to a consuming application that it should select one of the resources in the as:items list to use, rather than all of them. This is typically used to provide a choice of resources to render to the user, based on further supplied properties. If the consuming application cannot determine the user’s preference, then it should use the first in the list.

Returns:

  • (RDF::Vocabulary::Term) 


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

def Choice
  @Choice
end

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

The motivation for when the user intends to that classify the Target as something.

Returns:

  • (RDF::Vocabulary::Term) 


227
228
229
 
# File 'lib/rdf/vocab/oa.rb', line 227

def classifying
  @classifying
end

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

The motivation for when the user intends to comment about the Target.

Returns:

  • (RDF::Vocabulary::Term) 


231
232
233
 
# File 'lib/rdf/vocab/oa.rb', line 231

def commenting
  @commenting
end

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

A CssSelector describes a Segment of interest in a representation that conforms to the Document Object Model through the use of the CSS selector specification.

Returns:

  • (RDF::Vocabulary::Term) 


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

def CssSelector
  @CssSelector
end

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

A resource which describes styles for resources participating in the Annotation using CSS.

Returns:

  • (RDF::Vocabulary::Term) 


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

def CssStyle
  @CssStyle
end

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

DataPositionSelector describes a range of data by recording the start and end positions of the selection in the stream. Position 0 would be immediately before the first byte, position 1 would be immediately before the second byte, and so on. The start byte is thus included in the list, but the end byte is not.

Returns:

  • (RDF::Vocabulary::Term) 


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

def DataPositionSelector
  @DataPositionSelector
end

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

The motivation for when the user intends to describe the Target, as opposed to a comment about them.

Returns:

  • (RDF::Vocabulary::Term) 


235
236
237
 
# File 'lib/rdf/vocab/oa.rb', line 235

def describing
  @describing
end

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

A class to encapsulate the different text directions that a textual resource might take. It is not used directly in the Annotation Model, only its three instances.

Returns:

  • (RDF::Vocabulary::Term) 


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

def Direction
  @Direction
end

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

The motivation for when the user intends to request a change or edit to the Target resource.

Returns:

  • (RDF::Vocabulary::Term) 


239
240
241
 
# File 'lib/rdf/vocab/oa.rb', line 239

def editing
  @editing
end

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

The end property is used to convey the 0-based index of the end position of a range of content.

Returns:

  • (RDF::Vocabulary::Term) 


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

def end
  @end
end

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

The object of the predicate is a copy of the text which is being selected, after normalization.

Returns:

  • (RDF::Vocabulary::Term) 


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

def exact
  @exact
end

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

The FragmentSelector class is used to record the segment of a representation using the IRI fragment specification defined by the representation’s media type.

Returns:

  • (RDF::Vocabulary::Term) 


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

def FragmentSelector
  @FragmentSelector
end

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

The object of the relationship is a resource that is a body of the Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


119
120
121
 
# File 'lib/rdf/vocab/oa.rb', line 119

def hasBody
  @hasBody
end

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

The relationship between a RangeSelector and the Selector that describes the end position of the range.

Returns:

  • (RDF::Vocabulary::Term) 


123
124
125
 
# File 'lib/rdf/vocab/oa.rb', line 123

def hasEndSelector
  @hasEndSelector
end

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

The purpose served by the resource in the Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


127
128
129
 
# File 'lib/rdf/vocab/oa.rb', line 127

def hasPurpose
  @hasPurpose
end

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

The scope or context in which the resource is used within the Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


131
132
133
 
# File 'lib/rdf/vocab/oa.rb', line 131

def hasScope
  @hasScope
end

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

The object of the relationship is a Selector that describes the segment or region of interest within the source resource. Please note that the domain ( oa:ResourceSelection ) is not used directly in the Web Annotation model.

Returns:

  • (RDF::Vocabulary::Term) 


135
136
137
 
# File 'lib/rdf/vocab/oa.rb', line 135

def hasSelector
  @hasSelector
end

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

The resource that the ResourceSelection, or its subclass SpecificResource, is refined from, or more specific than. Please note that the domain ( oa:ResourceSelection ) is not used directly in the Web Annotation model.

Returns:

  • (RDF::Vocabulary::Term) 


139
140
141
 
# File 'lib/rdf/vocab/oa.rb', line 139

def hasSource
  @hasSource
end

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

The relationship between a RangeSelector and the Selector that describes the start position of the range.

Returns:

  • (RDF::Vocabulary::Term) 


143
144
145
 
# File 'lib/rdf/vocab/oa.rb', line 143

def hasStartSelector
  @hasStartSelector
end

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

The relationship between the ResourceSelection, or its subclass SpecificResource, and a State resource. Please note that the domain ( oa:ResourceSelection ) is not used directly in the Web Annotation model.

Returns:

  • (RDF::Vocabulary::Term) 


147
148
149
 
# File 'lib/rdf/vocab/oa.rb', line 147

def hasState
  @hasState
end

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

The relationship between an Annotation and its Target.

Returns:

  • (RDF::Vocabulary::Term) 


151
152
153
 
# File 'lib/rdf/vocab/oa.rb', line 151

def hasTarget
  @hasTarget
end

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

The motivation for when the user intends to highlight the Target resource or segment of it.

Returns:

  • (RDF::Vocabulary::Term) 


243
244
245
 
# File 'lib/rdf/vocab/oa.rb', line 243

def highlighting
  @highlighting
end

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

The HttpRequestState class is used to record the HTTP request headers that a client SHOULD use to request the correct representation from the resource.

Returns:

  • (RDF::Vocabulary::Term) 


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

def HttpRequestState
  @HttpRequestState
end

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

The motivation for when the user intends to assign an identity to the Target or identify what is being depicted or described in the Target.

Returns:

  • (RDF::Vocabulary::Term) 


247
248
249
 
# File 'lib/rdf/vocab/oa.rb', line 247

def identifying
  @identifying
end

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

The motivation for when the user intends to link to a resource related to the Target.

Returns:

  • (RDF::Vocabulary::Term) 


251
252
253
 
# File 'lib/rdf/vocab/oa.rb', line 251

def linking
  @linking
end

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

The direction of text that is read from left to right.

Returns:

  • (RDF::Vocabulary::Term) 


255
256
257
 
# File 'lib/rdf/vocab/oa.rb', line 255

def ltrDirection
  @ltrDirection
end

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

The motivation for when the user intends to assign some value or quality to the Target.

Returns:

  • (RDF::Vocabulary::Term) 


259
260
261
 
# File 'lib/rdf/vocab/oa.rb', line 259

def moderating
  @moderating
end

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

The relationship between an Annotation and a Motivation that describes the reason for the Annotation’s creation.

Returns:

  • (RDF::Vocabulary::Term) 


155
156
157
 
# File 'lib/rdf/vocab/oa.rb', line 155

def motivatedBy
  @motivatedBy
end

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

The Motivation class is used to record the user’s intent or motivation for the creation of the Annotation, or the inclusion of the body or target, that it is associated with.

Returns:

  • (RDF::Vocabulary::Term) 


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

def Motivation
  @Motivation
end

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

An IRI to signal the client prefers to receive full descriptions of the Annotations from a container, not just their IRIs.

Returns:

  • (RDF::Vocabulary::Term) 


211
212
213
 
# File 'lib/rdf/vocab/oa.rb', line 211

def PreferContainedDescriptions
  @PreferContainedDescriptions
end

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

An IRI to signal that the client prefers to receive only the IRIs of the Annotations from a container, not their full descriptions.

Returns:

  • (RDF::Vocabulary::Term) 


215
216
217
 
# File 'lib/rdf/vocab/oa.rb', line 215

def PreferContainedIRIs
  @PreferContainedIRIs
end

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

The object of the property is a snippet of content that occurs immediately before the content which is being selected by the Selector.

Returns:

  • (RDF::Vocabulary::Term) 


159
160
161
 
# File 'lib/rdf/vocab/oa.rb', line 159

def prefix
  @prefix
end

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

The object of the property is the language that should be used for textual processing algorithms when dealing with the content of the resource, including hyphenation, line breaking, which font to use for rendering and so forth. The value must follow the recommendations of BCP47.

Returns:

  • (RDF::Vocabulary::Term) 


163
164
165
 
# File 'lib/rdf/vocab/oa.rb', line 163

def processingLanguage
  @processingLanguage
end

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

The motivation for when the user intends to ask a question about the Target.

Returns:

  • (RDF::Vocabulary::Term) 


263
264
265
 
# File 'lib/rdf/vocab/oa.rb', line 263

def questioning
  @questioning
end

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

A Range Selector can be used to identify the beginning and the end of the selection by using other Selectors. The selection consists of everything from the beginning of the starting selector through to the beginning of the ending selector, but not including it.

Returns:

  • (RDF::Vocabulary::Term) 


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

def RangeSelector
  @RangeSelector
end

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

The relationship between a Selector and another Selector or a State and a Selector or State that should be applied to the results of the first to refine the processing of the source resource.

Returns:

  • (RDF::Vocabulary::Term) 


167
168
169
 
# File 'lib/rdf/vocab/oa.rb', line 167

def refinedBy
  @refinedBy
end

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

A system that was used by the application that created the Annotation to render the resource.

Returns:

  • (RDF::Vocabulary::Term) 


171
172
173
 
# File 'lib/rdf/vocab/oa.rb', line 171

def renderedVia
  @renderedVia
end

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

The motivation for when the user intends to reply to a previous statement, either an Annotation or another resource.

Returns:

  • (RDF::Vocabulary::Term) 


267
268
269
 
# File 'lib/rdf/vocab/oa.rb', line 267

def replying
  @replying
end

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

Instances of the ResourceSelection class identify part (described by an oa:Selector) of another resource (referenced with oa:hasSource), possibly from a particular representation of a resource (described by an oa:State). Please note that ResourceSelection is not used directly in the Web Annotation model, but is provided as a separate class for further application profiles to use, separate from oa:SpecificResource which has many Annotation specific features.

Returns:

  • (RDF::Vocabulary::Term) 


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

def ResourceSelection
  @ResourceSelection
end

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

The direction of text that is read from right to left.

Returns:

  • (RDF::Vocabulary::Term) 


271
272
273
 
# File 'lib/rdf/vocab/oa.rb', line 271

def rtlDirection
  @rtlDirection
end

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

A resource which describes the segment of interest in a representation of a Source resource, indicated with oa:hasSelector from the Specific Resource. This class is not used directly in the Annotation model, only its subclasses.

Returns:

  • (RDF::Vocabulary::Term) 


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

def Selector
  @Selector
end

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

The timestamp at which the Source resource should be interpreted as being applicable to the Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


175
176
177
 
# File 'lib/rdf/vocab/oa.rb', line 175

def sourceDate
  @sourceDate
end

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

The end timestamp of the interval over which the Source resource should be interpreted as being applicable to the Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


179
180
181
 
# File 'lib/rdf/vocab/oa.rb', line 179

def sourceDateEnd
  @sourceDateEnd
end

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

The start timestamp of the interval over which the Source resource should be interpreted as being applicable to the Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


183
184
185
 
# File 'lib/rdf/vocab/oa.rb', line 183

def sourceDateStart
  @sourceDateStart
end

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

Instances of the SpecificResource class identify part of another resource (referenced with oa:hasSource), a particular representation of a resource, a resource with styling hints for renders, or any combination of these, as used within an Annotation.

Returns:

  • (RDF::Vocabulary::Term) 


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

def SpecificResource
  @SpecificResource
end

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

The start position in a 0-based index at which a range of content is selected from the data in the source resource.

Returns:

  • (RDF::Vocabulary::Term) 


187
188
189
 
# File 'lib/rdf/vocab/oa.rb', line 187

def start
  @start
end

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

A State describes the intended state of a resource as applied to the particular Annotation, and thus provides the information needed to retrieve the correct representation of that resource.

Returns:

  • (RDF::Vocabulary::Term) 


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

def State
  @State
end

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

A Style describes the intended styling of a resource as applied to the particular Annotation, and thus provides the information to ensure that rendering is consistent across implementations.

Returns:

  • (RDF::Vocabulary::Term) 


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

def Style
  @Style
end

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

The name of the class used in the CSS description referenced from the Annotation that should be applied to the Specific Resource.

Returns:

  • (RDF::Vocabulary::Term) 


191
192
193
 
# File 'lib/rdf/vocab/oa.rb', line 191

def styleClass
  @styleClass
end

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

A reference to a Stylesheet that should be used to apply styles to the Annotation rendering.

Returns:

  • (RDF::Vocabulary::Term) 


195
196
197
 
# File 'lib/rdf/vocab/oa.rb', line 195

def styledBy
  @styledBy
end

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

The snippet of text that occurs immediately after the text which is being selected.

Returns:

  • (RDF::Vocabulary::Term) 


199
200
201
 
# File 'lib/rdf/vocab/oa.rb', line 199

def suffix
  @suffix
end

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

An SvgSelector defines an area through the use of the Scalable Vector Graphics [SVG] standard. This allows the user to select a non-rectangular area of the content, such as a circle or polygon by describing the region using SVG. The SVG may be either embedded within the Annotation or referenced as an External Resource.

Returns:

  • (RDF::Vocabulary::Term) 


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

def SvgSelector
  @SvgSelector
end

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

The motivation for when the user intends to associate a tag with the Target.

Returns:

  • (RDF::Vocabulary::Term) 


275
276
277
 
# File 'lib/rdf/vocab/oa.rb', line 275

def tagging
  @tagging
end

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

The direction of the text of the subject resource. There MUST only be one text direction associated with any given resource.

Returns:

  • (RDF::Vocabulary::Term) 


203
204
205
 
# File 'lib/rdf/vocab/oa.rb', line 203

def textDirection
  @textDirection
end

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

The TextPositionSelector describes a range of text by recording the start and end positions of the selection in the stream. Position 0 would be immediately before the first character, position 1 would be immediately before the second character, and so on.

Returns:

  • (RDF::Vocabulary::Term) 


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

def TextPositionSelector
  @TextPositionSelector
end

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

The TextQuoteSelector describes a range of text by copying it, and including some of the text immediately before (a prefix) and after (a suffix) it to distinguish between multiple copies of the same sequence of characters.

Returns:

  • (RDF::Vocabulary::Term) 


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

def TextQuoteSelector
  @TextQuoteSelector
end

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

Returns:

  • (RDF::Vocabulary::Term) 


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

def TextualBody
  @TextualBody
end

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

A TimeState records the time at which the resource’s state is appropriate for the Annotation, typically the time that the Annotation was created and/or a link to a persistent copy of the current version.

Returns:

  • (RDF::Vocabulary::Term) 


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

def TimeState
  @TimeState
end

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

A object of the relationship is a resource from which the source resource was retrieved by the providing system.

Returns:

  • (RDF::Vocabulary::Term) 


207
208
209
 
# File 'lib/rdf/vocab/oa.rb', line 207

def via
  @via
end

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

An XPathSelector is used to select elements and content within a resource that supports the Document Object Model via a specified XPath value.

Returns:

  • (RDF::Vocabulary::Term) 


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

def XPathSelector
  @XPathSelector
end