Class: RDF::Vocab::JSONLD

Inherits:
StrictVocabulary show all
Defined in:
vendor/bundler/ruby/2.7.0/bundler/gems/rdf-vocab-7bb82695cd86/lib/rdf/vocab/jsonld.rb

Overview

Vocabulary for http://www.w3.org/ns/json-ld#

The JSON-LD Vocabulary

This is a vocabulary document and is used to achieve certain features of the JSON-LD language.

See Also:

Version:

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

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

If the context definition has an @base key, its value MUST be an IRI reference, or null.

Returns:



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

def base
  @base
end

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

This profile IRI is used to request or specify compacted JSON-LD document form.

Returns:



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

def compacted
  @compacted
end

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

The associated @container value in an expanded term definition. If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords, or a combination of @set and any of @index, @id, @graph, @type, @language in any order. @container may also be an array containing @graph along with either @id or @index and also optionally including @set. If the value is @language, when the term is used outside of the @context, the associated value MUST be a language map. If the value is @index, when the term is used outside of the @context, the associated value MUST be an index map.

Returns:



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

def container
  @container
end

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

Defines term definitions and other aspects of a JSON-LD Context. A context definition MUST be a map whose keys MUST be either terms, compact IRIs, IRIs, or one of the keywords @base, @import, @language, @propagate, @protected, @type, @version, or @vocab.

Returns:



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

def Context
  @Context
end

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

As an IRI, this link relation is used to associate a JSON-LD context with a JSON document so that it can be interpreted as JSON-LD. In an HTTP request header, specifies the location of a context to use for compaction. As a Context, defines an inline context definition.

Returns:



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

def context
  @context
end

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

Term definition(s) associated with this context.

Returns:



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

def definition
  @definition
end

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

If the context definition has an @direction key, its value MUST be one of "ltr" or "rtl", or be null.

Returns:



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

def direction
  @direction
end

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

This profile URI is used to request or specify expanded JSON-LD document form.

Returns:



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

def expanded
  @expanded
end

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

This profile URI is used to request or specify flattened JSON-LD document form.

Returns:



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

def flattened
  @flattened
end

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

As an IRI, this link relation is used to associate a JSON-LD frame with a JSON-LD document. In an HTTP request header, specifies the location of a frame to use for framing.

Returns:



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

def frame
  @frame
end

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

This profile URI is used to request or specify framed JSON-LD document form.

Returns:



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

def framed
  @framed
end

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

If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords.

Returns:



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

def graphContainerType
  @graphContainerType
end

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

The @id mapping of a term definition.

Returns:



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

def id
  @id
end

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

If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords.

Returns:



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

def idContainerType
  @idContainerType
end

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

If the context definition contains the @import keyword, its value MUST be an IRI reference. When used as a reference from an @import, the referenced context definition MUST NOT include an @import key, itself.

Returns:



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

def import
  @import
end

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

If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords.

Returns:



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

def indexContainerType
  @indexContainerType
end

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

The default language is set in the context using the @language key whose value MUST be a string representing a BCP47 language code or null.

Returns:



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

def language
  @language
end

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

If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords.

Returns:



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

def languageContainerType
  @languageContainerType
end

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

If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords.

Returns:



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

def listContainerType
  @listContainerType
end

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

If the expanded term definition contains the @nest keyword, its value MUST be either @nest, or a term which expands to @nest.

Returns:



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

def nest
  @nest
end

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

With the value true, allows this term to be used to construct a compact IRI when compacting.

Returns:



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

def prefix
  @prefix
end

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

A string (simple term definition), expanding to an IRI.

Returns:



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

def PrefixDefinition
  @PrefixDefinition
end

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

If the context definition contains the @propagate keyword, its value MUST be true or false.

Returns:



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

def propagate
  @propagate
end

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

If the context definition contains the @protected keyword, its value MUST be true or false.

Returns:



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

def protected
  @protected
end

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

The @reverse mapping of an expanded term definition.

Returns:



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

def reverse
  @reverse
end

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

If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords.

Returns:



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

def setContainerType
  @setContainerType
end

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

The term associated with a term definition.

Returns:



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

def term
  @term
end

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

A term definition is an entry in a context, where the key defines a term which may be used within a dictionary as a key, type, or elsewhere that a string is interpreted as a vocabulary item. Its value is an expanded term definition. An expanded term definition MUST be a map composed of zero or more keys from @id, @reverse, @type, @language, @container, @context, @prefix, @propagate, or @protected. An expanded term definition SHOULD NOT contain any other keys.

Returns:



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

def TermDefinition
  @TermDefinition
end

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

If the context definition contains the @type keyword, its value MUST be a map with only the entry @container set to @set, and optionally an entry @protected. If the expanded term definition contains the @type keyword, its value MUST be an IRI reference, a term, null, or one of the keywords @id, @json, @none, or @vocab.

Returns:



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

def type
  @type
end

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

If the expanded term definition contains the @container keyword, its value MUST be either @list, @set, @language, @index, @id, @graph, @type, or be null or an array containing exactly any one of those keywords.

Returns:



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

def typeContainerType
  @typeContainerType
end

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

The processing mode defines how a JSON-LD document is processed. By default, all documents are assumed to be conformant with JSON-LD 1.1`. By defining a different version via explicit API option, other processing modes can be accessed. This specification defines extensions for the json-ld-1.1 processing mode.

Returns:



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

def version
  @version
end

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

Used to expand properties and values in @type with a common prefix IRI.

Returns:



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

def vocab
  @vocab
end