Abstract
This specification defines a set of algorithms for programmatic transformations of JSON-LD documents. Restructuring data according to the defined transformations often dramatically simplifies its usage. Furthermore, this document proposes an Application Programming Interface (API) for developers implementing the specified algorithms.
This specification describes a superset of the features defined in JSON-LD 1.0 Processing Algorithms And API [JSON-LD10-API] and, except where noted, the algorithms described in this specification are fully compatible with documents created using JSON-LD 1.0 [JSON-LD10].
Status of This Document
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.
This document has been developed by the JSON-LD Working Group and was derived from the JSON-LD Community Group's Final Report.
There is a live JSON-LD playground that is capable of demonstrating the features described in this document.
This specification is intended to supersede the JSON-LD 1.0 Processing Algorithms And API [JSON-LD10-API] specification.
This document was published by the JSON-LD Working Group as a Recommendation.
GitHub Issues are preferred for discussion of this specification. Alternatively, you can send comments to our mailing list. Please send them to public-json-ld-wg@w3.org (archives).
Please see the Working Group's implementation report.
This document has been reviewed by W3C Members, by software developers, and by other W3C groups and interested parties, and is endorsed by the Director as a W3C Recommendation. It is a stable document and may be used as reference material or cited from another document. W3C's role in making the Recommendation is to draw attention to the specification and to promote its widespread deployment. This enhances the functionality and interoperability of the Web.
This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
This document is governed by the 1 March 2019 W3C Process Document.
Set of Documents
This document is one of three JSON-LD 1.1 Recommendations produced by the JSON-LD Working Group:
Table of Contents
- 1. Introduction
- 2. Features
- 3. Conformance
- 4. Context Processing Algorithms
- 5. Expansion Algorithms
- 6. Compaction Algorithms
- 7. Flattening Algorithms
- 8. RDF Serialization/Deserialization Algorithms
- 9. The Application Programming Interface
- 10. Security Considerations
- 11. Privacy Considerations
- 12. Internationalization Considerations
- A. IDL Index
- B. Open Issues
- C. Changes since 1.0 Recommendation of 16 January 2014
- D. Changes since JSON-LD Community Group Final Report
- E. Changes since Candidate Release of 12 December 2019
- F. Changes since Candidate Release of 05 March 2020
- G. Changes since Proposed Recommendation Release of 7 May 2020
- H. Acknowledgements
- I. References
1. Introduction
This section is non-normative.
This document is a detailed specification of the JSON-LD processing algorithms. The document is primarily intended for the following audiences:
- Software developers who want to implement the algorithms to transform JSON-LD documents.
- Web authors and developers who want a very detailed view of how a JSON-LD Processor operates.
- Developers who want an overview of the proposed JSON-LD API.
To understand the basics in this specification you must first be familiar with JSON, which is detailed in [RFC8259]. You must also understand the JSON-LD syntax defined in the JSON-LD 1.1 Syntax specification [JSON-LD11], which is the base syntax used by all of the algorithms in this document. To understand the API and how it is intended to operate in a programming environment, it is useful to have working knowledge of the JavaScript programming language [ECMASCRIPT] and WebIDL [WEBIDL]. To understand how JSON-LD maps to RDF, it is helpful to be familiar with the basic RDF concepts [RDF11-CONCEPTS].
1.1 How to Read this Document
This section is non-normative.
This document is a detailed specification for a serialization of Linked Data in JSON. The document is primarily intended for the following audiences:
- Software developers who want to implement processors and APIs for JSON-LD
A companion document, the JSON-LD 1.1 specification [JSON-LD11], specifies the grammar of JSON-LD documents.
To understand the basics in this specification you must first be familiar with JSON, which is detailed in [RFC8259].
This document can highlight changes since the JSON-LD 1.0 version. Select to changes.
1.2 Contributing
This section is non-normative.
There are a number of ways that one may participate in the development of this specification:
- Technical discussion typically occurs on the public mailing list: public-json-ld-wg@w3.org
- The working group uses #json-ld IRC channel is available for real-time discussion on irc.w3.org.
- The #json-ld IRC channel is also available for real-time discussion on irc.freenode.net.
1.3 Typographical conventions
This section is non-normative.
The following typographic conventions are used in this specification:
markup- Markup (elements, attributes, properties), machine processable values (string, characters, media types), property name, or a file name is in red-orange monospace font.
- variable
- A variable in pseudo-code or in an algorithm description is in italics.
- definition
- A definition of a term, to be used elsewhere in this or other specifications, is in bold and italics.
- definition reference
- A reference to a definition in this document is underlined and is also an active link to the definition itself.
markup definition reference- A references to a definition in this document, when the reference itself is also a markup, is underlined, red-orange monospace font, and is also an active link to the definition itself.
- external definition reference
- A reference to a definition in another document is underlined, in italics, and is also an active link to the definition itself.
markup external definition reference- A reference to a definition in another document, when the reference itself is also a markup, is underlined, in italics red-orange monospace font, and is also an active link to the definition itself.
- hyperlink
- A hyperlink is underlined and in blue.
- [reference]
- A document reference (normative or informative) is enclosed in square brackets and links to the references section.
- Changes from Recommendation
- Sections or phrases changed from the previous Recommendation may be highlighted using a control in § 1.1 How to Read this Document.
Note
Notes are in light green boxes with a green left border and with a "Note" header in green. Notes are always informative.
Examples are in light khaki boxes, with khaki left border, and with a numbered "Example" header in khaki. Examples are always informative. The content of the example is in monospace font and may be syntax colored. Examples may have tabbed navigation buttons to show the results of transforming an example into other representations.
1.4 Terminology
This document uses the following terms as defined in external specifications and defines terms specific to JSON-LD.
Terms imported from Other Specifications
Terms imported from ECMAScript Language Specification [ECMASCRIPT], The JavaScript Object Notation (JSON) Data Interchange Format [RFC8259], Infra Standard [INFRA], and Web IDL [WEBIDL]
- array
- In the JSON serialization, an array structure is represented as square brackets surrounding zero or more values. Values are separated by commas. In the internal representation, a list (also called an array) is an ordered collection of zero or more values. While JSON-LD uses the same array representation as JSON, the collection is unordered by default. While order is preserved in regular JSON arrays, it is not in regular JSON-LD arrays unless specifically defined (see the Sets and Lists section of JSON-LD 1.1.
- boolean
-
The values
trueandfalsethat are used to express one of two possible states. - JSON object
-
In the JSON serialization,
an object structure
is represented as a pair of curly brackets surrounding zero or more name/value pairs (or members).
A name is a string.
A single colon comes after each name,
separating the name from the value.
A single comma separates a value from a following name.
In JSON-LD the names in an object must be unique.
In the internal representation a JSON object is described as a map (see [INFRA]), composed of entries with key/value pairs.
In the Application Programming Interface, a map is described using a [WEBIDL] record.
- null
-
The use of the null value within JSON-LD
is used to ignore or reset values.
A map entry in the
@contextwhere the value, or the@idof the value, isnull, explicitly decouples a term's association with an IRI. A map entry in the body of a JSON-LD document whose value isnullhas the same meaning as if the map entry was not defined. If@value,@list, or@setis set tonullin expanded form, then the entire JSON object is ignored. - number
- In the JSON serialization, a number is similar to that used in most programming languages, except that the octal and hexadecimal formats are not used and that leading zeros are not allowed. In the internal representation, a number is equivalent to either a long or double , depending on if the number has a non-zero fractional part (see [WEBIDL]).
- scalar
-
A scalar is either a string, number,
true, orfalse. - string
- A string is a sequence of zero or more Unicode (UTF-8) characters, wrapped in double quotes, using backslash escapes (if necessary). A character is represented as a single character string.
Terms imported from Internationalized Resource Identifiers (IRIs) [RFC3987]
- IRI
- The absolute form of an IRI containing a scheme along with a path and optional query and fragment segments.
- IRI reference
- Denotes the common usage of an Internationalized Resource Identifier. An IRI reference may be absolute or relative. However, the "IRI" that results from such a reference only includes absolute IRIs; any relative IRI references are resolved to their absolute form.
- relative IRI reference
-
A relative IRI reference is an IRI reference that is relative to some other IRI,
typically the base IRI of the document.
Note that properties,
values of
@type, and values of terms defined to be vocabulary relative are resolved relative to the vocabulary mapping, not the base IRI.
Terms imported from RDF 1.1 Concepts and Abstract Syntax [RDF11-CONCEPTS], RDF Schema 1.1 [RDF-SCHEMA], and Linked Data Design Issues [LINKED-DATA]
- base IRI
- The base IRI is an IRI established in the context, or is based on the JSON-LD document location. The base IRI is used to turn relative IRI references into IRIs.
- blank node
-
A node in a graph that is neither an IRI,
nor a literal.
A blank node does not contain
a de-referenceable identifier because it is either ephemeral in nature
or does not contain information that needs to be linked to from outside of the linked data graph.
In JSON-LD,
a blank node is assigned an identifier starting with the prefix
_:. - blank node identifier
-
A blank node identifier
is a string that can be used as an identifier for a blank node within the scope of a JSON-LD document.
Blank node identifiers begin with
_:. - dataset
- A dataset representing a collection of RDF graphs including exactly one default graph and zero or more named graphs.
- datatype IRI
- A datatype IRI is an IRI identifying a datatype that determines how the lexical form maps to a literal value.
- default graph
- The default graph of a dataset is an RDF graph having no name, which may be empty.
- graph name
- The IRI or blank node identifying a named graph.
- language-tagged string
- A language-tagged string consists of a string and a non-empty language tag as defined by [BCP47]. The language tag must be well-formed according to section 2.2.9 Classes of Conformance of [BCP47]. Processors may normalize language tags to lowercase.
- Linked Data
- A set of documents, each containing a representation of a linked data graph or dataset.
- list
- A list is an ordered sequence of IRIs, blank nodes, and literals.
- literal
-
An object expressed as a value such as a string or number.
Implicitly or explicitly includes a datatype IRI and, if the datatype is
rdf:langString, an optional language tag. - named graph
- A named graph is a linked data graph that is identified by an IRI or blank node.
- node
- A node in an RDF graph, either the subject and object of at least one triple. Note that a node can play both roles (subject and object) in a graph, even in the same triple.
- object
- An object is a node in a linked data graph with at least one incoming edge.
- property
-
The name of a directed-arc in a linked data graph.
Every property is directional
and is labeled with an IRI or a blank node identifier.
Whenever possible, a property should be labeled with an IRI.
Also, see predicate in [RDF11-CONCEPTS].
Note
The use of blank node identifiers to label properties is obsolete, and may be removed in a future version of JSON-LD.
- RDF graph
- A labeled directed graph, i.e., a set of nodes connected by directed-arcs. Also called linked data graph.
- resource
- A resource denoted by an IRI, a blank node or literal representing something in the world (the "universe of discourse").
- subject
- A subject is a node in a linked data graph with at least one outgoing edge, related to an object node through a property.
- triple
- A component of an RDF graph including a subject, predicate, and object, which represents a node-arc-node segment of an RDF graph.
JSON-LD Specific Term Definitions
- active context
- A context that is used to resolve terms while the processing algorithm is running.
- base direction
-
The base direction is the direction used when a string does not have a direction associated with it directly.
It can be set in the context using the
@directionkey whose value must be one of the strings"ltr","rtl", ornull. See the Context Definitions section of JSON-LD 1.1 for a normative description. - compact IRI
- A compact IRI has the form of prefix:suffix and is used as a way of expressing an IRI without needing to define separate term definitions for each IRI contained within a common vocabulary identified by prefix.
- context
- A set of rules for interpreting a JSON-LD document as described in the The Context section of JSON-LD 1.1, and normatively specified in the Context Definitions section of JSON-LD 1.1.
- default language
-
The default language is the language used when a string does not have a language associated with it directly.
It can be set in the context using the
@languagekey whose value must be a string representing a [BCP47] language code ornull. See the Context Definitions section of JSON-LD 1.1 for a normative description. - default object
-
A default object is a map that has a
@defaultkey. - expanded term definition
- An expanded term definition is a term definition where the value is a map containing one or more keyword keys to define the associated IRI, if this is a reverse property, the type associated with string values, and a container mapping. See the Expanded Term Definition section of JSON-LD 1.1 for a normative description.
- frame
- A JSON-LD document, which describes the form for transforming another JSON-LD document using matching and embedding rules. A frame document allows additional keywords and certain map entries to describe the matching and transforming process.
- graph object
-
A graph object represents a named graph
as the value of a map entry within a node object.
When expanded, a graph object must have an
@graphentry, and may also have@id, and@indexentries. A simple graph object is a graph object which does not have an@identry. Note that node objects may have a@graphentry, but are not considered graph objects if they include any other entries. A top-level object consisting of@graphis also not a graph object. Note that a node object may also represent a named graph it it includes other properties. See the Graph Objects section of JSON-LD 1.1 for a normative description. - id map
-
An id map is a map value of a term
defined with
@containerset to@id. The values of the id map must be node objects, and its keys are interpreted as IRIs representing the@idof the associated node object. If a value in the id map contains a key expanding to@id, its value must be equivalent to the referencing key in the id map. See the Id Maps section of JSON-LD 1.1 for a normative description. - included block
-
An included block is an entry in a node object where the key is either
@includedor an alias of@includedand the value is one or more node objects. See the Included Blocks section of JSON-LD 1.1 for a normative description. - index map
-
An index map is a map value of a term
defined with
@containerset to@index, whose values must be any of the following types: string, number,true,false, null, node object, value object, list object, set object, or an array of zero or more of the above possibilities. See the Index Maps section in JSON-LD 1.1 for a formal description. - JSON literal
-
A JSON literal is a literal where the associated datatype IRI is
rdf:JSON. In the value object representation, the value of@typeis@json. JSON literals represent values which are valid JSON [RFC8259]. See the Therdf:JSONDatatype section in JSON-LD 1.1 for a normative description. - JSON-LD document
- A JSON-LD document is a serialization of an RDF dataset. See the JSON-LD Grammar section in JSON-LD 1.1 for a formal description.
- JSON-LD internal representation
- The JSON-LD internal representation is the result of transforming a JSON syntactic structure into the core data structures suitable for direct processing: arrays, maps, strings, numbers, booleans, and null.
- JSON-LD Processor
- A JSON-LD Processor is a system which can perform the algorithms defined in JSON-LD 1.1 Processing Algorithms and API. See the Conformance section in JSON-LD 1.1 API for a formal description.
- JSON-LD value
-
A JSON-LD value is a string,
a number,
trueorfalse, a typed value, or a language-tagged string. It represents an RDF literal. - keyword
- A string that is specific to JSON-LD, described in the Syntax Tokens and Keywords section of JSON-LD 1.1, and normatively specified in the Keywords section of JSON-LD 1.1,
- language map
-
An language map is a map value of a term
defined with
@containerset to@language, whose keys must be strings representing [BCP47] language codes and the values must be any of the following types: null, string, or an array of zero or more of the above possibilities. See the Language Maps section of JSON-LD 1.1 for a normative description. - list object
-
A list object is a map that has a
@listkey. It may also have an@indexkey, but no other entries. See the Lists and Sets section of JSON-LD 1.1 for a normative description. - local context
-
A context that is specified with a map,
specified via the
@contextkeyword. - node object
-
A node object represents zero or more properties of a node in the graph
serialized by the JSON-LD document.
A map is a node object
if it exists outside of the JSON-LD context and:
- it does not contain the
@value,@list, or@setkeywords, or - it is not the top-most map in the JSON-LD document
consisting of no other entries than
@graphand@context.
- it does not contain the
- prefix
- A prefix is the first component of a compact IRI which comes from a term that maps to a string that, when prepended to the suffix of the compact IRI, results in an IRI.
- processing mode
-
The processing mode defines how a JSON-LD document is processed.
By default, all documents are assumed to be conformant with this specification.
By defining a different version using the
@versionentry in a context, publishers can ensure that processors conformant with JSON-LD 1.0 [JSON-LD10] will not accidentally process JSON-LD 1.1 documents, possibly creating a different output. The API provides an option for setting the processing mode tojson-ld-1.0, which will prevent JSON-LD 1.1 features from being activated, or error if@versionentry in a context is explicitly set to1.1. This specification extends JSON-LD 1.0 via thejson-ld-1.1processing mode. - scoped context
-
A scoped context is part of an expanded term definition using the
@contextentry. It has the same form as an embedded context. When the term is used as a type, it defines a type-scoped context , when used as a property it defines a property-scoped context . - set object
-
A set object is a map that has an
@setentry. It may also have an@indexkey, but no other entries. See the Lists and Sets section of JSON-LD 1.1 for a normative description. - term
- A term is a short word defined in a context that may be expanded to an IRI. See the Terms section of JSON-LD 1.1 for a normative description.
- term definition
- A term definition is an entry in a context, where the key defines a term which may be used within a map as a key, type, or elsewhere that a string is interpreted as a vocabulary item. Its value is either a string ( simple term definition ), expanding to an IRI, or a map (expanded term definition).
- type map
-
A type map is a map value of a term
defined with
@containerset to@type, whose keys are interpreted as IRIs representing the@typeof the associated node object; the value must be a node object, or array of node objects. If the value contains a term expanding to@type, its values are merged with the map value when expanding. See the Type Maps section of JSON-LD 1.1 for a normative description. - typed value
- A typed value consists of a value, which is a string, and a type, which is an IRI.
- value object
-
A value object is a map that has an
@valueentry. See the Value Objects section of JSON-LD 1.1 for a normative description. - vocabulary mapping
-
The vocabulary mapping is set in the context using the
@vocabkey whose value must be an IRI, a compact IRI, a term, ornull. See the Context Definitions section of JSON-LD 1.1 for a normative description.
1.4.1 Algorithm Terms
The Following terms are used within specific algorithms.
- active graph
- The name of the currently active graph that the processor should use when processing.
- active property
- The currently active property or keyword that the processor should use when processing. The active property is represented in the original lexical form, which is used for finding coercion mappings in the active context.
- add value
-
Used as a macro within various algorithms as a way to add a value
to an entry in a map (object) using a specified key.
The invocation may include an as array flag defaulting to
false. - IRI compacting
-
Used as a macro within various algorithms as to reduce the language used to describe
the process of compacting a string var representing an IRI or keyword
using an active context either specified directly, or coming from the scope of
the algorithm step using this term.
An optional value is used, if explicitly provided.
Unless specified, the vocab flag defaults to
true, and the reverse flag defaults tofalse.- Return the result of using the IRI Compaction algorithm, passing active context, var, value (if supplied), vocab, and result.
- IRI expanding
-
Used as a macro within various algorithms as to reduce the language used to describe
the process of expanding a string value representing an IRI or keyword
using an active context either specified directly, or coming from the scope of
the algorithm step using this term.
Optional defined and local context arguments are used, if explicitly provided.
Unless specified,
the document relative flag defaults to
false, and the vocab flag defaults totrue.- Return the result of using the IRI Expansion algorithm, passing active context, value, local context (if supplied), defined (if supplied), document relative, and vocab.
- JSON-LD input
- The JSON-LD data structure that is provided as input to the algorithm.
1.4.2 Syntax Tokens and Keywords
In addition to the keywords defined in the JSON-LD 1.1 Syntax specification [JSON-LD11], this specification adds an additional keyword to support JSON-LD 1.1 Framing [JSON-LD11-FRAMING]:
@preserve- Used in an expanded document created as the result of the Framing algorithm to represent values that might otherwise be removed as part of the Expansion algorithm.
1.5 Example Conventions
This section is non-normative.
Note that in the examples used in this document, output is of necessity shown in serialized form as JSON. While the algorithms describe operations on the JSON-LD internal representation, when they as displayed as examples, the JSON serialization is used. In particular, the internal representation use of maps are represented using JSON objects.
: Sample JSON-LD document
{
"@context": {
"name": "http://xmlns.com/foaf/0.1/name",
"knows": "http://xmlns.com/foaf/0.1/knows"
},
"@id": "http://me.markus-lanthaler.com/",
"name": "Markus Lanthaler",
"knows": [
{
"name": "Dave Longley"
}
]
}
In the internal representation, the example above would be of a
map containing @context, @id, name, and knows entries,
with either maps, strings, or arrays of
maps or strings values. In the JSON serialization, JSON objects are used
for maps, while arrays and strings are serialized using a
convention common to many programming languages.
2. Features
This section is non-normative.
The JSON-LD 1.1 Syntax specification [JSON-LD11] defines a syntax to express Linked Data in JSON. Because there is more than one way to express Linked Data using this syntax, it is often useful to be able to transform JSON-LD documents so that they may be more easily consumed by specific applications.
To allow these algorithms to be adapted for syntaxes other than JSON, the algorithms operate on the JSON-LD internal representation, which uses the generic concepts of arrays, maps, strings, numbers, booleans, and null to describe the data represented by a JSON document. Algorithms act on this internal representation with API entry points responsible for transforming between the concrete and internal representations.
JSON-LD uses contexts to allow Linked Data to be expressed in a way that is specifically tailored to a particular person or application. By providing a context, JSON data can be expressed in a way that is a natural fit for a particular person or application whilst also indicating how the data should be understood at a global scale. In order for people or applications to share data that was created using a context that is different from their own, a JSON-LD processor must be able to transform a document from one context to another. Instead of requiring JSON-LD processors to write specific code for every imaginable context switching scenario, it is much easier to specify a single algorithm that can remove any context. Similarly, another algorithm can be specified to subsequently apply any context. These two algorithms represent the most basic transformations of JSON-LD documents. They are referred to as expansion and compaction, respectively.
JSON-LD 1.1 introduces new features that are
compatible with JSON-LD 1.0 [JSON-LD10],
but if processed by a JSON-LD 1.0 processor may produce different results.
Processors default to json-ld-1.1, unless the
processingMode API option
is explicitly set to json-ld-1.0.
Publishers are encouraged to use the @version map entry within a context
set to 1.1 to ensure that JSON-LD 1.0 processors will not misinterpret JSON-LD 1.1 features.
There are four major types of transformation that are discussed in this document: expansion, compaction, flattening, and RDF serialization/deserialization.
2.1 Expansion
This section is non-normative.
The algorithm that removes context is called expansion . Before performing any other transformations on a JSON-LD document, it is easiest to remove any context from it and to make data structures more regular.
To get an idea of how context and data structuring affects the same data, here is an example of JSON-LD that uses only terms and is fairly compact:
The next input example uses one IRI to express a property and a map to encapsulate a value, but leaves the rest of the information untouched.
Note that both inputs are valid JSON-LD and both represent the same information. The difference is in their context information and in the data structures used. A JSON-LD processor can remove context and ensure that the data is more regular by employing expansion.
Expansion has two important goals: removing any contextual
information from the document, and ensuring all values are represented
in a regular form. These goals are accomplished by expanding all entry keys
to IRIs and by expressing all
values in arrays in
expanded form. Expanded form is the most verbose
and regular way of expressing of values in JSON-LD; all contextual
information from the document is instead stored locally with each value.
Running the Expansion algorithm
(expand())
operation) against the above examples results in the following output:
: Expanded JSON-LD document using an IRI
[
{
"@id": "http://me.markus-lanthaler.com/",
"http://xmlns.com/foaf/0.1/name": [
{ "@value": "Markus Lanthaler" }
],
"http://xmlns.com/foaf/0.1/homepage": [
{ "@id": "http://www.markus-lanthaler.com/" }
]
}
]
The example above is the JSON-LD serialization of the output of the expansion algorithm, where the algorithm's use of maps are replaced with JSON objects.
Note that in the output above all context definitions have been removed, all terms and compact IRIs have been expanded to absolute IRIs, and all JSON-LD values are expressed in arrays in expanded form. While the output is more verbose and difficult for a human to read, it establishes a baseline that makes JSON-LD processing easier because of its very regular structure.
2.2 Compaction
This section is non-normative.
While expansion removes context from a given input, compaction 's primary function is to perform the opposite operation: to express a given input according to a particular context. Compaction applies a context that specifically tailors the way information is expressed for a particular person or application. This simplifies applications that consume JSON or JSON-LD by expressing the data in application-specific terms, and it makes the data easier to read by humans.
Compaction uses a developer-supplied context to shorten IRIs to terms or compact IRIs and JSON-LD values expressed in expanded form to simple values such as strings or numbers.
For example, assume the following expanded JSON-LD input document:
: Expanded sample document
[
{
"@id": "http://me.markus-lanthaler.com/",
"http://xmlns.com/foaf/0.1/name": [
{ "@value": "Markus Lanthaler" }
],
"http://xmlns.com/foaf/0.1/homepage": [
{ "@id": "http://www.markus-lanthaler.com/" }
]
}
]
Additionally, assume the following developer-supplied JSON-LD context:
: JSON-LD context
{
"@context": {
"name": "http://xmlns.com/foaf/0.1/name",
"homepage": {
"@id": "http://xmlns.com/foaf/0.1/homepage",
"@type": "@id"
}
}
}
Running the Compaction Algorithm
(compact())
operation) given the context supplied above against the JSON-LD input
document provided above would result in the following output:
The example above is the JSON-LD serialization of the output of the compaction algorithm, where the algorithm's use of maps are replaced with JSON objects.
Note that all IRIs have been compacted to
terms as specified in the context,
which has been injected into the output. While compacted output is
useful to humans, it is also used to generate structures that are easy to
program against. Compaction enables developers to map any expanded document
into an application-specific compacted document. While the context provided
above mapped http://xmlns.com/foaf/0.1/name to name, it
could also have been mapped to any other term provided by the developer.
2.3 Flattening
This section is non-normative.
While expansion ensures that a document is in a uniform structure, flattening goes a step further to ensure that the shape of the data is deterministic. In expanded documents, the properties of a single node may be spread across a number of different node objects. By flattening a document, all properties of a node are collected in a single node object and all blank nodes are labeled with a blank node identifier. This may drastically simplify the code required to process JSON-LD data in certain applications.
For example, assume the following JSON-LD input document:
: JSON-LD document in compact form
{
"@context": {
"name": "http://xmlns.com/foaf/0.1/name",
"knows": "http://xmlns.com/foaf/0.1/knows"
},
"@id": "http://me.markus-lanthaler.com/",
"name": "Markus Lanthaler",
"knows": [
{"name": "Dave Longley"}
]
}
Running the Flattening Algorithm
(flatten())
operation) with a context set to null to prevent compaction
returns the following document:
The example above is the JSON-LD serialization of the output of the flattening algorithm, where the algorithm's use of maps are replaced with JSON objects.
Note how in the output above all properties of a node are collected in a
single node object and how the blank node representing
"Dave Longley" has been assigned the blank node identifier
_:b0.
To make it easier for humans to read or for certain applications to process it, a flattened document can be compacted by passing a context. Using the same context as the input document, the flattened and compacted document looks as follows:
Please note that the result of flattening and compacting a document
is always a map,
(represented as a JSON object when serialized),
which contains an @graph
entry that represents the default graph.
2.4 RDF Serialization/Deserialization
This section is non-normative.
JSON-LD can be used to serialize RDF data as described in [RDF11-CONCEPTS]. This ensures that data can be round-tripped to and from any RDF syntax without any loss in fidelity.
For example, assume the following RDF input serialized in Turtle [TURTLE]:
: Sample Turtle document
@prefix foaf: <http://xmlns.com/foaf/0.1/> . <http://me.markus-lanthaler.com/> foaf:name "Markus Lanthaler" ; foaf:homepage <http://www.markus-lanthaler.com/> .
Using the Serialize RDF as JSON-LD Algorithm a developer could transform this document into expanded JSON-LD:
: Sample Turtle document converted to JSON-LD
[
{
"@id": "http://me.markus-lanthaler.com/",
"http://xmlns.com/foaf/0.1/name": [
{ "@value": "Markus Lanthaler" }
],
"http://xmlns.com/foaf/0.1/homepage": [
{ "@id": "http://www.markus-lanthaler.com/" }
]
}
]
The example above is the JSON-LD serialization of the output of the Serialize RDF as JSON-LD Algorithm, where the algorithm's use of maps are replaced with JSON objects.
Note that the output above could easily be compacted using the technique outlined in the previous section. It is also possible to deserialize the JSON-LD document back to RDF using the Deserialize JSON-LD to RDF Algorithm.
3. Conformance
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
The key words MAY, MUST, MUST NOT, and SHOULD in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
There are two classes of products that can claim conformance to this specification: JSON-LD Processors, and RDF Serializers/Deserializers.
A conforming JSON-LD Processor is a system which can perform the Expansion, Compaction, and Flattening operations in a manner consistent with the algorithms defined in this specification.
JSON-LD Processors MUST NOT attempt to correct malformed IRIs or language tags; however, they SHOULD issue validation warnings. IRIs are not modified other than conversion between relative and absolute IRIs.
A conforming RDF Serializer/Deserializer is a system that can deserialize JSON-LD to RDF and serialize RDF as JSON-LD as defined in this specification.
Unless specified using
processingMode API option,
the processing mode is set using the @version entry
in a local context and
affects the behavior of algorithms including expansion and compaction.
Once set, it is an error to attempt to change to a different processing mode,
and processors MUST generate,
a processing mode conflict
error and abort further processing.
The algorithms in this specification are generally written with more concern for clarity than efficiency. Thus, JSON-LD Processors may implement the algorithms given in this specification in any way desired, so long as the end result is indistinguishable from the result that would be obtained by the specification's algorithms.
In algorithm steps that describe operations on keywords, those steps also apply to keyword aliases.
Note
Implementers can partially check their level of conformance to this specification by successfully passing the test cases of the JSON-LD test suite. Note, however, that passing all the tests in the test suite does not imply complete conformance to this specification. It only implies that the implementation conforms to aspects tested by the test suite.
This specification makes use of the following namespace prefixes:
| Prefix | IRI |
|---|---|
| rdf | http://www.w3.org/1999/02/22-rdf-syntax-ns# |
| xsd | http://www.w3.org/2001/XMLSchema# |
4. Context Processing Algorithms
The following sections describe algorithms for processing a JSON-LD context.
4.1 Context Processing Algorithm
When processing a JSON-LD data structure, each processing rule is applied using information provided by the active context. This section describes how to produce an active context.
The active context consists of:
- the active term definitions which specify how keys and values have to be interpreted (array of term definitions),
- the current base IRI (IRI),
- the original base URL (IRI),
- an inverse context (inverse context),
- an optional vocabulary mapping (IRI),
- an optional default language (string),
- an optional default base direction (
"ltr"or"rtl"), - and an optional previous context (context), used when a non-propagated context is defined.
Each term definition consists of:
- an IRI mapping (IRI),
- a prefix flag (boolean),
- a protected flag (boolean),
- a reverse property flag (boolean),
- an optional base URL (IRI),
- an optional context (context),
- an optional container mapping (array of strings),
- an optional direction mapping (
"ltr"or"rtl"), - an optional index mapping (string),
- an optional language mapping (string),
- an optional nest value (string),
- and an optional type mapping (IRI).
A term definition can not only be used to map a term to an IRI, but also to map a term to a keyword, in which case it is referred to as a keyword alias .
When processing, active context is initialized
with a null inverse context,
without any term definitions,
vocabulary mapping, default base direction, or default language.
If a local context is encountered during processing, a new
active context is created by cloning the existing
active context. Then the information from the
local context is merged into the new active context.
Given that local contexts may contain
references to remote contexts, this includes their retrieval.
4.1.1 Overview
This section is non-normative.
First we prepare a new active context result by cloning the current active context. Then we normalize the form of the original local context to an array. Local contexts may be in the form of a map, a string, or an array containing a combination of the two. Finally we process each context contained in the local context array as follows.
If context is a string, it represents a reference to
a remote context. We dereference the remote context and replace context
with the value of the @context entry of the top-level object in the
retrieved JSON-LD document.
If there's no such entry, an
invalid remote context
has been detected. Otherwise, we process context by recursively using
this algorithm ensuring that there is no cyclical reference.
If context is a map,
it is a context definition.
We first update
the base IRI,
the default base direction,
the default language,
context propagation,
the processing mode,
and the vocabulary mapping
by processing six specific keywords:
@base,
@direction,
@language,
@propagate,
@version,
and @vocab.
These are handled before any other entries in the local context because
they affect how the other entries are processed.
If context contains @import, it is retrieved and is reverse-merged
into the containing context, allowing JSON-LD 1.0 contexts to be upgraded to JSON-LD 1.1.
Please note that @base is ignored when processing remote contexts.
If context is not to be propagated, a reference to the previous context is retained so that it may be rolled back when a new node object is entered. By default, all contexts are propagated, other than type-scoped contexts.
When an active context is initialized, the value
of the original base URL
is initialized from the original
of the document containing the initial context, if available,
otherwise from the documentUrl API option.
This is necessary when resetting the active context
by setting it to basenull
to retain the original default base IRI.
When initialized, or when any entry of
an active context is changed,
or any associated term definition is added, changed, or removed,
the inverse context field
in active context is set to null.
Then, for every other entry in local context, we update the term definition in result. Since term definitions in a local context may themselves contain terms or compact IRIs, we may need to recurse. When doing so, we must ensure that there is no cyclical dependency, which is an error. After we have processed any term definition dependencies, we update the current term definition, which may be a keyword alias.
Finally, we return result as the new active context.
4.1.2 Algorithm
This algorithm specifies how a new active context is updated
with a local context. The algorithm takes three required
and four optional
input variables.
The required inputs are
an active context,
a local context,
and a base URL used when resolving relative context URLs.
The optional inputs are
an array remote contexts,
defaulting to a new empty array, which is used to detect cyclical context inclusions,
override protected, defaulting to false,
which is used to allow changes to protected terms,
propagate, defaulting to true
to mark term definitions associated with non-propagated contexts,
and validate scoped context defaulting to true,
which is used to limit recursion when validating possibly recursive scoped contexts..
- Initialize result to the result of cloning
active context,
with inverse context set to
null.. - If local context is an object containing the member
@propagate, its value MUST be booleantrueorfalse, set propagate to that value.Note
Error handling is performed in step 5.11.
- If propagate is
false, and result does not have a previous context, set previous context in result to active context. - If local context is not an array, set local context to an array containing only local context.
-
For each item context in local context:
- If context is
null:- If override protected is
falseand active context contains any protected term definitions, aninvalid context nullificationhas been detected and processing is aborted. - Initialize result as a
newly-initialized active context,
setting both base IRI and original base URL to the value of
original base URL in active context,
and, if propagate is
false, previous context in result to the previous value of result. - Continue with the next context.
- If override protected is
- If context is a string,
- Initialize context to the result of resolving context against
base URL. If base URL is not a valid IRI,
then context MUST be a valid IRI, otherwise
a
loading document failederror has been detected and processing is aborted. - If validate scoped context is
false, and remote contexts already includes context do not process context further and continue to any next context in local context. - If the number of entries in the remote contexts array
exceeds a processor defined limit, a
context overflowerror has been detected and processing is aborted; otherwise, add context to remote contexts. - If context was previously dereferenced,
then the processor MUST NOT do a further dereference, and
context is set to the
previously established internal representation:
set context document to the previously dereferenced document,
and set loaded context to the value of the
@contextentry from the document in context document.Note
Only the
@contextentry need be retained. - Otherwise, set context document
to the
obtained by dereferencing context using theRemoteDocumentLoadDocumentCallback, passing context for url, andhttp://www.w3.org/ns/json-ld#contextforprofileand forrequestProfile.- If context cannot be dereferenced,
or the
from context document cannot be transformed into the internal representation , adocumentloading remote context failederror has been detected and processing is aborted. - If the
has no top-level map with andocument@contextentry, aninvalid remote contexthas been detected and processing is aborted. - Set loaded context to the value of that entry.
- If context cannot be dereferenced,
or the
- Set result to the result of recursively calling this algorithm,
passing result for active context,
loaded context for local context,
the
of context document for base URL, a copy of remote contexts, and validate scoped context.documentUrlNote
If context was previously dereferenced, processors MUST make provisions for retaining the base URL of that context for this step to enable the resolution of any relative context URLs that may be encountered during processing.
- Continue with the next context.
- Initialize context to the result of resolving context against
base URL. If base URL is not a valid IRI,
then context MUST be a valid IRI, otherwise
a
- If context is not a map, an
invalid local contexterror has been detected and processing is aborted. - Otherwise, context is a context definition.
- If context has an
@versionentry:- If the associated value is not
1.1, aninvalid @version valuehas been detected, and processing is aborted.Note
The use of
1.1for the value of@versionis intended to cause a JSON-LD 1.0 processor to stop processing. Although it is clearly meant to be related to JSON-LD 1.1, it does not otherwise adhere to the requirements for Semantic Versioning. Implementations may require special consideration when comparing the values of numbers with a non-zero fractional part. - If processing mode
is set to
json-ld-1.0, aprocessing mode conflicterror has been detected and processing is aborted.
- If the associated value is not
- If context has an
@importentry:- If processing mode is
json-ld-1.0, aninvalid context entryerror has been detected and processing is aborted. - Otherwise, if the value of
@importis not a string, aninvalid @import valueerror has been detected and processing is aborted. - Initialize import to the result of resolving the value of
@importagainst base URL. - Dereference import using
the
LoadDocumentCallback, passing import for url, andhttp://www.w3.org/ns/json-ld#contextforprofileand forrequestProfile. - If import cannot be dereferenced,
or cannot be transformed into the internal representation,
a
loading remote context failederror has been detected and processing is aborted. - If the dereferenced document has no
top-level map with an
@contextentry, or if the value of@contextis not a context definition (i.e., it is not an map), aninvalid remote contexthas been detected and processing is aborted; otherwise, set import context to the value of that entry. - If import context has a
@importentry, aninvalid context entryerror has been detected and processing is aborted. - Set context to the result of merging context into import context, replacing common entries with those from context.
- If processing mode is
- If context has an
@baseentry and remote contexts is empty, i.e., the currently being processed context is not a remote context:- Initialize value to the value associated with the
@baseentry. - If value is
null, remove the base IRI of result. - Otherwise, if value is an IRI, the base IRI of result is set to value.
- Otherwise, if value is a relative IRI reference and
the base IRI of result is not
null, set the base IRI of result to the result of resolving value against the current base IRI of result. - Otherwise, an
invalid base IRIerror has been detected and processing is aborted.
- Initialize value to the value associated with the
- If context has an
@vocabentry:- Initialize value to the value associated with the
@vocabentry. - If value is null, remove any vocabulary mapping from result.
- Otherwise, if value is
an IRI
or blank node identifier, the vocabulary mapping
of result is set to
the result of
IRI expanding value
using
truefor document relative . If it is not an IRI, or a blank node identifier, aninvalid vocab mappingerror has been detected and processing is aborted.Note
The use of blank node identifiers to value for
@vocabis obsolete, and may be removed in a future version of JSON-LD.
- Initialize value to the value associated with the
- If context has an
@languageentry:- Initialize value to the value associated with the
@languageentry. - If value is
null, remove any default language from result. - Otherwise, if value is a string, the
default language of result is set to
value.
If it is not a string, an
invalid default languageerror has been detected and processing is aborted. If value is not well-formed according to section 2.2.9 of [BCP47], processors SHOULD issue a warning.
- Initialize value to the value associated with the
- If context has an
@directionentry:- If processing mode is
json-ld-1.0, aninvalid context entryerror has been detected and processing is aborted. - Initialize value to the value associated with the
@directionentry. - If value is
null, remove any base direction from result. - Otherwise, if value is a string, the
base direction of result is set to
value. If it is not
null,"ltr", or"rtl", aninvalid base directionerror has been detected and processing is aborted.
- If processing mode is
- If context has an
@propagateentry:- If processing mode is
json-ld-1.0, aninvalid context entryerror has been detected and processing is aborted. - Otherwise, if the value of
@propagateis not booleantrueorfalse, aninvalid @propagate valueerror has been detected and processing is aborted.Note
The previous context is actually set earlier in this algorithm; the previous two steps exist for error checking only.
- If processing mode is
- Create a map defined to keep track of whether or not a term has already been defined or is currently being defined during recursion.
- For each key-value pair in context where
key is not
@base,@direction,@import,@language,@propagate,@protected,@version, or@vocab, invoke the Create Term Definition algorithm, passing result for active context, context for local context, key, defined, base URL, the value of the@protectedentry from context, if any, for protected, override protected, and a copy of remote contexts.
- If context is
- Return result.
4.2 Create Term Definition
This algorithm is called from the Context Processing algorithm to create a term definition in the active context for a term being processed in a local context.
4.2.1 Overview
This section is non-normative.
Term definitions are created by parsing the information in the given local context for the given term. If the given term is a compact IRI, it may omit an IRI mapping by depending on its prefix having its own term definition. If the prefix is an entry in the local context, then its term definition must first be created, through recursion, before continuing. Because a term definition can depend on other term definitions, a mechanism must be used to detect cyclical dependencies. The solution employed here uses a map, defined, that keeps track of whether or not a term has been defined or is currently in the process of being defined. This map is checked before any recursion is attempted.
After all dependencies for a term have been defined, the rest of the information in the local context for the given term is taken into account, creating the appropriate IRI mapping, container mapping, and type mapping, language mapping, or direction mapping for the term.
4.2.2 Algorithm
The algorithm has four required and five optional inputs.
The required inputs are
an active context,
a local context,
a term,
and a map defined.
The optional inputs are
base URL defaulting to null,
protected which defaults to false,
and override protected, defaulting to false,
which is used to allow changes to protected terms,
an array remote contexts,
defaulting to a new empty array, which is used to detect cyclical context inclusions,
and validate scoped context defaulting to true,
which is used to limit recursion when validating possibly recursive scoped contexts..
- If defined contains the entry term and the associated
value is
true(indicating that the term definition has already been created), return. Otherwise, if the value isfalse, acyclic IRI mappingerror has been detected and processing is aborted. - If term is the empty string (
""), aninvalid term definitionerror has been detected and processing is aborted. Otherwise, set the value associated with defined's term entry tofalse. This indicates that the term definition is now being created but is not yet complete. - Initialize value to a copy of the value associated with the entry term in local context.
- If term is
@type, and processing mode isjson-ld-1.0, akeyword redefinitionerror has been detected and processing is aborted. At this point, value MUST be a map with only either or both of the following entries:- An entry for
@containerwith value@set. - An entry for
@protected.
keyword redefinitionerror has been detected and processing is aborted. - An entry for
- Otherwise, since keywords cannot be overridden,
term MUST NOT be a keyword and a
keyword redefinitionerror has been detected and processing is aborted. If term has the form of a keyword (i.e., it matches the ABNF rule"@"1*ALPHAfrom [RFC5234]), return; processors SHOULD generate a warning. - Initialize previous definition to any existing term definition for term in active context, removing that term definition from active context.
- If value is
null, convert it to a map consisting of a single entry whose key is@idand whose value isnull. - Otherwise, if value is a string, convert it
to a map consisting of a single entry whose
key is
@idand whose value is value. Set simple term totrue. - Otherwise, value MUST be a map, if not, an
invalid term definitionerror has been detected and processing is aborted. Set simple term tofalse. - Create a new term definition, definition,
initializing prefix flag to
false, protected to protected, and reverse property tofalse. - If value has an
@protectedentry, set the protected flag in definition to the value of this entry. If the value of@protectedis not a boolean, aninvalid @protected valueerror has been detected and processing is aborted. If processing mode isjson-ld-1.0, aninvalid term definitionhas been detected and processing is aborted. - If value contains the entry
@type:- Initialize type to the value associated with the
@typeentry, which MUST be a string. Otherwise, aninvalid type mappingerror has been detected and processing is aborted. - Set type to the result of IRI expanding type, using local context, and defined.
- If the expanded type is
@jsonor@none, and processing mode isjson-ld-1.0, aninvalid type mappingerror has been detected and processing is aborted. - Otherwise, if the expanded type is
neither
@id, nor@json, nor@none, nor@vocab, nor an IRI, aninvalid type mappingerror has been detected and processing is aborted. - Set the type mapping for definition to type.
- Initialize type to the value associated with the
- If value contains the entry
@reverse:- If value contains
@idor@nest, entries, aninvalid reverse propertyerror has been detected and processing is aborted. - If the value associated with the
@reverseentry is not a string, aninvalid IRI mappingerror has been detected and processing is aborted. - If the value associated with the
@reverseentry is a string having the form of a keyword (i.e., it matches the ABNF rule"@"1*ALPHAfrom [RFC5234]), return; processors SHOULD generate a warning. - Otherwise, set the IRI mapping of definition to the
result of
IRI expanding
the value associated with the
@reverseentry, using local context, and defined. If the result does not have the form of an IRI or a blank node identifier, aninvalid IRI mappingerror has been detected and processing is aborted. - If value contains an
@containerentry, set the container mapping of definition to an array containing its value; if its value is neither@set, nor@index, nornull, aninvalid reverse propertyerror has been detected (reverse properties only support set- and index-containers) and processing is aborted. - Set the reverse property flag of definition
to
true. - Set the term definition of term in
active context to definition and the
value associated with defined's entry term to
trueand return.
- If value contains
- If value contains the entry
@idand its value does not equal term:- If the
@identry of value isnull, the term is not used for IRI expansion, but is retained to be able to detect future redefinitions of this term. - Otherwise:
- If the value associated with the
@identry is not a string, aninvalid IRI mappingerror has been detected and processing is aborted. - If the value associated with the
@identry is not a keyword, but has the form of a keyword (i.e., it matches the ABNF rule"@"1*ALPHAfrom [RFC5234]), return; processors SHOULD generate a warning. - Otherwise, set the IRI mapping of definition to the
result of
IRI expanding
the value associated with the
@identry, using local context, and defined. If the resulting IRI mapping is neither a keyword, nor an IRI, nor a blank node identifier, aninvalid IRI mappingerror has been detected and processing is aborted; if it equals@context, aninvalid keyword aliaserror has been detected and processing is aborted. - If the term contains a colon (
:) anywhere but as the first or last character of term, or if it contains a slash (/) anywhere:- Set the value associated with defined's term entry to
true. - If the result of IRI expanding term
using local context, and defined,
is not the same as the IRI mapping of definition,
an
invalid IRI mappingerror has been detected and processing is aborted.
- Set the value associated with defined's term entry to
- If term contains neither a colon (
:) nor a slash (/), simple term istrue, and if the IRI mapping of definition is either an IRI ending with a gen-delim character, or a blank node identifier, set the prefix flag in definition totrue.
- If the value associated with the
- If the
-
Otherwise if the term contains a colon (
:) anywhere after the first character:- If term is a compact IRI with a prefix that is an entry in local context a dependency has been found. Use this algorithm recursively passing active context, local context, the prefix as term, and defined.
- If term's prefix has a term definition in active context, set the IRI mapping of definition to the result of concatenating the value associated with the prefix's IRI mapping and the term's suffix.
- Otherwise, term is an IRI or blank node identifier. Set the IRI mapping of definition to term.
-
Otherwise if the term contains a slash (
/):- Term is a relative IRI reference.
- Set the IRI mapping of definition to the
result of IRI expanding term.
If the resulting IRI mapping is not an IRI, an
invalid IRI mappingerror has been detected and processing is aborted.
- Otherwise, if term is
@type, set the IRI mapping of definition to@type. - Otherwise, if active context has a
vocabulary mapping, the IRI mapping
of definition is set to the result of concatenating the value
associated with the vocabulary mapping and term.
If it does not have a vocabulary mapping, an
invalid IRI mappingerror been detected and processing is aborted. - If value contains the entry
@container:- Initialize container to the value associated with the
@containerentry, which MUST be either@graph,@id,@index,@language,@list,@set,@type, or an array containing exactly any one of those keywords, an array containing@graphand either@idor@indexoptionally including@set, or an array containing a combination of@setand any of@index,@graph,@id,@type,@languagein any order . Otherwise, aninvalid container mappinghas been detected and processing is aborted. - If the container value
is
@graph,@id, or@type, or is otherwise not a string, generate aninvalid container mappingerror and abort processing if processing mode isjson-ld-1.0. - Set the container mapping of definition to container coercing to an array, if necessary.
- If the container mapping of definition includes
@type:- If type mapping in definition is undefined, set it to
@id. - If type mapping in definition is neither
@idnor@vocab, aninvalid type mappingerror has been detected and processing is aborted.
- If type mapping in definition is undefined, set it to
- Initialize container to the value associated with the
- If value contains the entry
@index:- If processing mode is
json-ld-1.0or container mapping does not include@index, aninvalid term definitionhas been detected and processing is aborted. - Initialize index to the value associated with the
@indexentry. If the result of IRI expanding that value is not an IRI, aninvalid term definitionhas been detected and processing is aborted. - Set the index mapping of definition to index
- If processing mode is
- If value contains the entry
@context:- If processing mode is
json-ld-1.0, aninvalid term definitionhas been detected and processing is aborted. - Initialize context to the value associated with the
@contextentry, which is treated as a local context. - Invoke the Context Processing algorithm
using the active context, context as local context,
base URL,
truefor override protected, a copy of remote contexts, andfalsefor validate scoped context. If any error is detected, aninvalid scoped contexterror has been detected and processing is aborted.Note
The result of the Context Processing algorithm is discarded; it is called to detect errors at definition time. If used, the context will be re-processed and applied to the active context as part of expansion or compaction.
- Set the local context of definition to context, and base URL to base URL.
- If processing mode is
- If value contains the entry
@languageand does not contain the entry@type:- Initialize language to the value associated with the
@languageentry, which MUST be eithernullor a string. If language is not well-formed according to section 2.2.9 of [BCP47], processors SHOULD issue a warning. Otherwise, aninvalid language mappingerror has been detected and processing is aborted. - Set the language mapping of definition to language.
- Initialize language to the value associated with the
- If value contains the entry
@directionand does not contain the entry@type:- Initialize direction to the value associated with the
@directionentry, which MUST be eithernull,"ltr", or"rtl". Otherwise, aninvalid base directionerror has been detected and processing is aborted. - Set the direction mapping of definition to direction.
- Initialize direction to the value associated with the
- If value contains the entry
@nest:- If processing mode is
json-ld-1.0, aninvalid term definitionhas been detected and processing is aborted. - Initialize nest value in definition to the value associated with the
@nestentry, which MUST be a string and MUST NOT be a keyword other than@nest. Otherwise, aninvalid @nest valueerror has been detected and processing is aborted.
- If processing mode is
- If value contains the entry
@prefix:- If processing mode is
json-ld-1.0, or if term contains a colon (:) or slash (/), aninvalid term definitionhas been detected and processing is aborted. - Set the prefix flag to the value associated with the
@prefixentry, which MUST be a boolean. Otherwise, aninvalid @prefix valueerror has been detected and processing is aborted. - If the prefix flag of definition is set to
true, and its IRI mapping is a keyword, aninvalid term definitionhas been detected and processing is aborted.
- If processing mode is
- If value contains any entry other than
@id,@reverse,@container,@context,@direction,@index,@language,@nest,@prefix,@protected, or@type, aninvalid term definitionerror has been detected and processing is aborted. - If override protected is
falseand previous definition exists and is protected;- If definition is not the same as previous definition
(other than the value of protected),
a
protected term redefinitionerror has been detected, and processing is aborted. - Set definition to previous definition to retain the value of protected.
- If definition is not the same as previous definition
(other than the value of protected),
a
- Set the term definition of term in
active context to definition and set the value
associated with defined's entry term to
true.
4.3 Inverse Context Creation
When there is more than one term that could be chosen to compact an IRI, it has to be ensured that the term selection is both deterministic and represents the most context-appropriate choice whilst taking into consideration algorithmic complexity.
In order to make term selections, the concept of an inverse context is introduced. An inverse context is essentially a reverse lookup table that maps container mapping, type mappings, and language mappings to a simple term for a given active context. A inverse context only needs to be generated for an active context if it is being used for compaction.
To make use of an inverse context, a list of preferred container mapping and the type mapping or language mapping are gathered for a particular value associated with an IRI. These parameters are then fed to the Term Selection algorithm, which will find the term that most appropriately matches the value's mappings.
4.3.1 Overview
This section is non-normative.
To create an inverse context for a given
active context, each term in the
active context is visited, ordered by length, shortest
first (ties are broken by choosing the lexicographically least
term). For each term, an entry is added to
the inverse context for each possible combination of
container mapping and type mapping
or language mapping that would legally match the
term. Illegal matches include differences between a
value's type mapping or language mapping and
that of the term. If a term has no
container mapping, type mapping, or
language mapping (or some combination of these), then it
will have an entry in the inverse context using the special
key @none. This allows the
Term Selection algorithm to fall back
to choosing more generic terms when a more
specifically-matching term is not available for a particular
IRI and value combination.
Although normalizing language tags is optional, the inverse context creates entries based on normalized language tags, so that the proper term can be selected regardless of representation.
4.3.2 Algorithm
The algorithm takes one required input: the active context that the inverse context is being created for.
- Initialize result to an empty map.
- Initialize default language to
@none. If the active context has a default language, set default language to the default language from the active context normalized to lower case. - For each key term and value term definition in
the active context, ordered by shortest term
first (breaking ties by choosing the lexicographically least
term):
- If the term definition is
null, term cannot be selected during compaction, so continue to the next term. - Initialize container to
@none. If the container mapping is not empty, set container to the concatenation of all values of the container mapping in lexicographical order . - Initialize var to the value of the IRI mapping for the term definition.
- If var is not an entry of result, add an entry where the key is var and the value is an empty map to result.
- Reference the value associated with the var entry in result using the variable container map.
- If container map has no container entry,
create one and set its value to a new
map with three entries.
The first entry is
@languageand its value is a new empty map, the second entry is@typeand its value is a new empty map, and the third entry is@anyand its value is a new map with the entry@noneset to the term being processed. - Reference the value associated with the container entry in container map using the variable type/language map.
- Reference the value associated with the
@typeentry in type/language map using the variable type map. - Reference the value associated with the
@languageentry in type/language map using the variable language map. - If the term definition indicates that the term represents a reverse property:
- Otherwise, if term definition has a
type mapping which is
@none: - Otherwise, if term definition has a
type mapping:
- If type map does not have an entry corresponding to the type mapping in term definition, create one and set its value to the term being processed.
- Otherwise, if term definition has both
a language mapping and a direction mapping:
- Create a new variable lang dir.
- If neither the language mapping nor the direction mapping
are
null, set lang dir to the concatenation of language mapping and direction mapping separated by an underscore ("_") normalized to lower case. - Otherwise, if language mapping is not
null, set lang dir to the language mapping, normalized to lower case. - Otherwise, if direction mapping is not
null, set lang dir to direction mapping preceded by an underscore ("_"). - Otherwise, set lang dir to
@null. - If language map does not have a lang dir entry, create one and set its value to the term being processed.
- Otherwise, if term definition has a
language mapping (might be
null):- If the language mapping equals
null, set language to@null; otherwise to the language mapping, normalized to lower case. - If language map does not have a language entry, create one and set its value to the term being processed.
- If the language mapping equals
- Otherwise, if term definition has a
direction mapping (might be
null):- If the direction mapping equals
null, set direction to@none; otherwise to direction mapping preceded by an underscore ("_"). - If language map does not have a direction entry, create one and set its value to the term being processed.
- If the direction mapping equals
- Otherwise, if active context has a
default base direction:
- Initialize a variable lang dir
with the concatenation of default language and default base direction,
separate by an underscore (
"_"), normalized to lower case. - If language map does not have a lang dir entry, create one and set its value to the term being processed.
- If language map does not have an
@noneentry, create one and set its value to the term being processed. - If type map does not have an
@noneentry, create one and set its value to the term being processed.
- Initialize a variable lang dir
with the concatenation of default language and default base direction,
separate by an underscore (
- Otherwise:
- If language map does not have a default language entry (after being normalized to lower case), create one and set its value to the term being processed.
- If language map does not have an
@noneentry, create one and set its value to the term being processed. - If type map does not have an
@noneentry, create one and set its value to the term being processed.
- If the term definition is
- Return result.
4.4 Term Selection
This algorithm, invoked via the IRI Compaction algorithm, makes use of an active context's inverse context to find the term that is best used to compact an IRI. Other information about a value associated with the IRI is given, including which container mapping and which type mapping or language mapping would be best used to express the value.
4.4.1 Overview
This section is non-normative.
The inverse context's entry for the IRI will be first searched according to the preferred container mapping, in the order that they are given. Amongst terms with a matching container mapping, preference will be given to those with a matching type mapping or language mapping, over those without a type mapping or language mapping. If there is no term with a matching container mapping then the term without a container mapping that matches the given type mapping or language mapping is selected. If there is still no selected term, then a term with no type mapping or language mapping will be selected if available. No term will be selected that has a conflicting type mapping or language mapping. Ties between terms that have the same mappings are resolved by first choosing the shortest terms, and then by choosing the lexicographically least term. Note that these ties are resolved automatically because they were previously resolved when the Inverse Context Creation algorithm was used to create the inverse context.
4.4.2 Algorithm
This algorithm has five required inputs. They are: an active context, a keyword or IRI var, an array containers that represents an ordered list of preferred container mapping, a string type/language that indicates whether to look for a term with a matching type mapping or language mapping, and an array representing an ordered list of preferred values for the type mapping or language mapping to look for.
- If the active context has a
nullinverse context, set inverse context in active context to the result of calling the Inverse Context Creation algorithm using active context. - Initialize inverse context to the value of inverse context in active context.
- Initialize container map to the value associated with var in the inverse context.
- For each item container in containers:
- If container is not an entry of container map, then there is no term with a matching container mapping for it, so continue to the next container.
- Initialize type/language map to the value associated with the container entry in container map.
- Initialize value map to the value associated with type/language entry in type/language map.
- For each item in preferred values:
- If item is not an entry of value map, then there is no term with a matching type mapping or language mapping, so continue to the next item.
- Otherwise, a matching term has been found, return the value associated with the item entry in value map.
- No matching term has been found. Return
null.
4.4.3 Examples
This section is non-normative.
The following examples are intended to illustrate how the term selection algorithm behaves for different term definitions and values. It is not comprehensive, but intended to illustrate different parts of the algorithm.
Language Map Term
If the term definition has "@container": "@language", it will only match a
value object having no @type.
Datatyped Term
If the term definition has a datatype, it will only match a value object having a matching datatype.
5. Expansion Algorithms
The following sections describe algorithms for expanding JSON-LD documents, IRIs and values.
5.1 Expansion Algorithm
This algorithm expands a JSON-LD document, such that all context definitions are removed, all terms and compact IRIs are expanded to IRIs, blank node identifiers, or keywords and all JSON-LD values are expressed in arrays in expanded form.
5.1.1 Overview
This section is non-normative.
Starting with its root element, we can process the JSON-LD document recursively, until we have a fully expanded result. When expanding an element, we can treat each one differently according to its type, in order to break down the problem:
- If the element is
null, there is nothing to expand. - Otherwise, if element is a scalar, we expand it according to the Value Expansion algorithm.
- Otherwise, if the element is an array, then we expand each of its items recursively and return them in a new array.
- Otherwise, element is a map. We expand each of its entries, adding them to our result, and then we expand each value for each entry recursively. Some of the entry keys will be terms or compact IRIs and others will be keywords or simply ignored because they do not have definitions in the context. Any IRIs will be expanded using the IRI Expansion algorithm.
Finally, after ensuring result is in an array, we return result.
Note
Although the data model, based on [RDF11-CONCEPTS], does not support multiple unordered property values, this algorithm does not remove duplicates that may be found during expansion within an unordered array. Other algorithms, such as § 6.1 Compaction Algorithm, and § 7.1 Flattening Algorithm, do eliminate duplicate values from unordered arrays. A future version of this specification may be updated to remove duplicate array values when the form a set.
5.1.2 Algorithm
The algorithm takes four required and three optional input variables.
The required inputs are an active context,
an active property, an element to be expanded,
and a base URL associated with the of the original
document to expand.
The optional inputs are the
documentUrl
flag allowing special forms of input used for frame expansion,
the frameExpansion flag, used to order
map entry keys lexicographically, where noted,
and the from map flag, used to control reverting
previous term definitions in the active context associated with non-propagated contexts.
If not passed, the optional flags are set to orderedfalse.
The algorithm also performs processing steps specific to expanding
a JSON-LD Frame. For a frame, the @id and
@type entries can accept an array of IRIs or
an empty map. The entries of a value object can also
accept an array of strings, or an empty map.
Framing also uses additional keyword entries:
(@explicit, @default,
@embed, @explicit, @omitDefault, or
@requireAll) which are preserved through expansion.
Special processing for a JSON-LD Frame is invoked when the
flag is set to frameExpansiontrue.
Note
As mentioned in Terms [JSON-LD11],
to avoid forward-compatibility issues, terms should not start with an
@ character as future versions of JSON-LD may introduce
additional keywords.
This algorithm will treat such terms like any other term, i.e., they are ignored unless mapped to an IRI.
Implementations of this algorithm may consider providing a
runtime flag to show a warning if such terms are encountered.
Note
The use of empty terms ("") is not
allowed as not all programming languages are able to handle empty JSON keys.
Implementations of this algorithm may consider providing a
runtime flag to show a warning if such terms are encountered.
Note
The use of blank node identifiers to label properties is obsolete, and may be removed in a future version of JSON-LD. Implementations of this algorithm may consider providing a runtime flag to show a warning if such terms are encountered.
- If element is
null, returnnull. - If active property is
@default, initialize theflag toframeExpansionfalse. - If active property has a term definition in active context with a local context, initialize property-scoped context to that local context.
- If element is a scalar,
- If active property is
nullor@graph, drop the free-floating scalar by returningnull. - If property-scoped context is defined, set active context to the result of the Context Processing algorithm, passing active context, property-scoped context as local context, and base URL from the term definition for active property in active context.
- Return the result of the Value Expansion algorithm, passing the active context, active property, and element as value.
- If active property is
- If element is an array,
- Initialize an empty array, result.
- For each item in element:
- Initialize expanded item to the result of using this
algorithm recursively, passing active context,
active property, item as element,
base URL,
the
frameExpansion, and from map flags.ordered - If the container mapping
of active property includes
@list, and expanded item is an array, set expanded item to a new map containing the entry@listwhere the value is the original expanded item. - If expanded item is an array, append each of its items to result. Otherwise, if expanded item is not null, append it to result.
- Initialize expanded item to the result of using this
algorithm recursively, passing active context,
active property, item as element,
base URL,
the
- Return result.
- Otherwise element is a map.
- If active context has a previous context,
the active context is not propagated.
If from map is undefined or
false, and element does not contain an entry expanding to@value, and element does not consist of a single entry expanding to@id(where entries are IRI expanded, set active context to previous context from active context, as the scope of a term-scoped context does not apply when processing new node objects. - If property-scoped context is defined,
set active context to the result of the
Context Processing algorithm,
passing active context, property-scoped context as local context,
base URL from the term definition for active property,
in active context
and
truefor override protected. - If element contains the entry
@context, set active context to the result of the Context Processing algorithm, passing active context, the value of the@contextentry as local context and base URL. - Initialize type-scoped context to active context. This is used for expanding values that may be relevant to any previous type-scoped context.
- For each key and value in element
ordered lexicographically by key
where key IRI expands to
@type:- Convert value into an array, if necessary.
- For each term which is a value of value ordered lexicographically,
if term is a string,
and term's term definition in type-scoped context
has a local context, set active context to the result
Context Processing algorithm,
passing active context,
the value of the
term's local context as local context,
base URL from the term definition for value
in active context,
and
falsefor propagate.
- Initialize two empty maps, result
and nests.
Initialize input type to expansion of the last value of the first entry in element
expanding to
@type(if any), ordering entries lexicographically by key. Both the key and value of the matched entry are IRI expanded. -
For each key and value in element,
ordered lexicographically by key if
isorderedtrue:- If key is
@context, continue to the next key. - Initialize expanded property to the result of IRI expanding key.
- If expanded property is
nullor it neither contains a colon (:) nor it is a keyword, drop key by continuing to the next key. - If expanded property is a keyword:
- If active property equals
@reverse, aninvalid reverse property maperror has been detected and processing is aborted. - If result already has an expanded property entry,
other than
@includedor@type(unless processing mode isjson-ld-1.0), acolliding keywordserror has been detected and processing is aborted. - If expanded property is
@id:- If value is not a string, an
invalid @id valueerror has been detected and processing is aborted. When theflag is set, value MAY be an empty map, or an array of one or more strings.frameExpansion - Otherwise,
set expanded value to the result of
IRI expanding value
using
truefor document relative andfalsefor vocab. When theflag is set, expanded value will be an array of one or more of the values, with string values expanded using the IRI Expansion algorithm as above.frameExpansion
- If value is not a string, an
- If expanded property is
@type:- If value
is neither a string nor an array of
strings, an
invalid type valueerror has been detected and processing is aborted. When theflag is set, value MAY be an empty map, or a default object where the value offrameExpansion@defaultis restricted to be an IRI. All other values mean thatinvalid type valueerror has been detected and processing is aborted. - If value is an empty map, set expanded value to value.
- Otherwise, if value
is a default object, set expanded value to
a new default object with the value of
@defaultset to the result of IRI expanding value using type-scoped context for active context, andtruefor document relative. - Otherwise,
set expanded value to the result of
IRI expanding
each of its values
using type-scoped context for active context,
and
truefor document relative. - If result already has an entry for
@type, prepend the value of@typein result to expanded value, transforming it into an array, if necessary.
- If value
is neither a string nor an array of
strings, an
- If expanded property is
@graph, set expanded value to the result of using this algorithm recursively passing active context,@graphfor active property, value for element, base URL, and theandframeExpansionflags, ensuring that expanded value is an array of one or more maps.ordered - If expanded property is
@included:- If processing mode is
json-ld-1.0, continue with the next key from element. - Set expanded value to the result of using
this algorithm recursively passing active context,
nullfor active property, value for element, base URL, and theandframeExpansionflags, ensuring that the result is an array.ordered - If any element of expanded value is not a node object,
an
invalid @included valueerror has been detected and processing is aborted. - If result already has an entry for
@included, prepend the value of@includedin result to expanded value.
- If processing mode is
- If expanded property is
@value:- If
input type is
@json, set expanded value to value. If processing mode isjson-ld-1.0, aninvalid value object valueerror has been detected and processing is aborted. - Otherwise, if value is not a scalar or
null, aninvalid value object valueerror has been detected and processing is aborted. When theflag is set, value MAY be an empty map or an array of scalar values.frameExpansion - Otherwise, set expanded value to value.
When the
flag is set, expanded value will be an array of one or more string values or an array containing an empty map.frameExpansion - If expanded value
is
null, set the@valueentry of result tonulland continue with the next key from element. Null values need to be preserved in this case as the meaning of an@typeentry depends on the existence of an@valueentry.
- If
input type is
- If expanded property is
@language:- If value is not a string, an
invalid language-tagged stringerror has been detected and processing is aborted. When theflag is set, value MAY be an empty map or an array of zero or more strings.frameExpansion -
Otherwise, set expanded value to value.
If value is not well-formed according to
section 2.2.9 of [BCP47],
processors SHOULD issue a warning.
When the
flag is set, expanded value will be an array of one or more string values or an array containing an empty map.frameExpansion
- If value is not a string, an
- If expanded property is
@direction:- If processing mode is
json-ld-1.0, continue with the next key from element. - If value is neither
"ltr"nor"rtl", aninvalid base directionerror has been detected and processing is aborted. When theflag is set, value MAY be an empty map or an array of zero or more strings.frameExpansion - Otherwise, set expanded value to value.
When the
flag is set, expanded value will be an array of one or more string values or an array containing an empty map.frameExpansion
- If processing mode is
- If expanded property is
@index:- If value is not a string, an
invalid @index valueerror has been detected and processing is aborted. - Otherwise, set expanded value to value.
- If value is not a string, an
- If expanded property is
@list:- If active property is
nullor@graph, continue with the next key from element to remove the free-floating list. - Otherwise, initialize expanded value to the result of using
this algorithm recursively passing active context,
active property, value for element,
base URL,
and the
andframeExpansionflags, ensuring that the result is an array..ordered
- If active property is
- If expanded property is
@set, set expanded value to the result of using this algorithm recursively, passing active context, active property, value for element, base URL, and theandframeExpansionflags.ordered - If expanded property is
@reverse:- If value is not a map, an
invalid @reverse valueerror has been detected and processing is aborted. - Otherwise initialize expanded value to the result of using this
algorithm recursively, passing active context,
@reverseas active property, value as element, base URL, and theandframeExpansionflags.ordered - If expanded value contains an
@reverseentry, i.e., properties that are reversed twice, execute for each of its property and item the following steps: - If expanded value contains an entry other than
@reverse:- Set reverse map to the value
of the
@reverseentry in result, initializing it to an empty map, if necessary. - For each property and items in expanded value
other than
@reverse:- For each item in items:
- If item is a value object or list object, an
invalid reverse property valuehas been detected and processing is aborted. - Use add value to add item
to the property entry in reverse map
using
truefor as array.
- If item is a value object or list object, an
- For each item in items:
- Set reverse map to the value
of the
- Continue with the next key from element.
- If value is not a map, an
- If expanded property is
@nest, add key to nests, initializing it to an empty array, if necessary. Continue with the next key from element. - When the
flag is set, if expanded property is any other framing keyword (frameExpansion@default,@embed,@explicit,@omitDefault, or@requireAll), set expanded value to the result of performing the Expansion Algorithm recursively, passing active context, active property, value for element, base URL, and theandframeExpansionflags.ordered - Unless expanded value is
null, expanded property is@value, and input type is not@json, set the expanded property entry of result to expanded value. - Continue with the next key from element.
- If active property equals
- Initialize container mapping to key's container mapping in active context.
- If key's term definition in active context
has a type mapping of
@json, set expanded value to a new map, set the entry@valueto value, and set the entry@typeto@json. - Otherwise, if container mapping includes
@languageand value is a map then value is expanded from a language map as follows:- Initialize expanded value to an empty array.
- Initialize direction to the default base direction from active context.
- If key's term definition in active context has a direction mapping, update direction with that value.
- For each key-value pair language-language value
in value, ordered lexicographically by language if
isorderedtrue:- If language value is not an array set language value to an array containing only language value.
- For each item in language value:
- If item is
null, continue to the next entry in language value. - item must be a string,
otherwise an
invalid language map valueerror has been detected and processing is aborted. - Initialize a new map v
consisting of two
key-value pairs: (
@value-item) and (@language-language). If item is neither@nonenor well-formed according to section 2.2.9 of [BCP47], processors SHOULD issue a warning. - If language is
@none, or expands to@none, remove@languagefrom v. -
If direction is not
null, add an entry for@directionto v with direction. - Append v to expanded value.
- If item is
- Otherwise, if container mapping
includes
@index,@type, or@idand value is a map then value is expanded from an map as follows:- Initialize expanded value to an empty array.
- Initialize index key to
the key's index mapping in active context,
or
@index, if it does not exist. - For each key-value pair index-index value
in value, ordered lexicographically by index
if
isorderedtrue:- If container mapping includes
@idor@type, initialize map context to the previous context from active context if it exists, otherwise, set map context to active context. - If container mapping includes
@typeand index's term definition in map context has a local context, update map context to the result of the Context Processing algorithm, passing map context as active context the value of the index's local context as local context and base URL from the term definition for index in map context. - Otherwise, set map context to active context.
- Initialize expanded index to the result of IRI expanding index.
- If index value is not an array set index value to an array containing only index value.
- Initialize index value to the result of
using this algorithm recursively, passing
map context as active context,
key as active property,
index value as element,
base URL,
truefor from map, and theandframeExpansionflags.ordered - For each item in index value:
- If container mapping includes
@graph, and item is not a graph object, set item to a new map containing the key-value pair@graph-item, ensuring that the value is represented using an array. - If container mapping includes
@index, index key is not@index, and expanded index is not@none:- Initialize re-expanded index to the result of calling the Value Expansion algorithm, passing the active context, index key as active property, and index as value.
- Initialize expanded index key to the result of IRI expanding index key.
- Initialize index property values to an array consisting of re-expanded index followed by the existing values of the concatenation of expanded index key in item, if any.
- Add the key-value pair (expanded index key-index property values) to item.
- If item is a value object,
it MUST NOT contain any extra properties;
an
invalid value objecterror has been detected and processing is aborted.
- Otherwise, if container mapping includes
@index, item does not have an entry@index, and expanded index is not@none, add the key-value pair (@index-index) to item. - Otherwise, if container mapping includes
@iditem does not have the entry@id, and expanded index is not@none, add the key-value pair (@id-expanded index) to item, where expanded index is set to the result of IRI expandingindex usingtruefor document relative andfalsefor vocab. - Otherwise, if container mapping includes
@typeand expanded index is not@none, initialize types to a new array consisting of expanded index followed by any existing values of@typein item. Add the key-value pair (@type-types) to item. - Append item to expanded value.
- If container mapping includes
- If container mapping includes
- Otherwise, initialize expanded value to the result of
using this algorithm recursively, passing active context,
key for active property, value for element,
base URL,
and the
andframeExpansionflags.ordered - If expanded value is
null, ignore key by continuing to the next key from element. - If container mapping includes
@listand expanded value is not already a list object, convert expanded value to a list object by first setting it to an array containing only expanded value if it is not already an array, and then by setting it to a map containing the key-value pair@list-expanded value. - If container mapping includes
@graph, and includes neither@idnor@index, convert expanded value into an array, if necessary, then convert each value ev in expanded value into a graph object:- Convert ev into
a graph object by creating a map containing the key-value
pair
@graph-ev where ev is represented as an array.Note
- Convert ev into
a graph object by creating a map containing the key-value
pair
- If the term definition associated to
key indicates that it is a reverse property
- If result has no
@reverseentry, create one and initialize its value to an empty map. - Reference the value of the
@reverseentry in result using the variable reverse map. - If expanded value is not an array, set it to an array containing expanded value.
- For each item in expanded value
- If item is a value object or list object, an
invalid reverse property valuehas been detected and processing is aborted. - If reverse map has no expanded property entry, create one and initialize its value to an empty array.
- Use add value to add item
to the expanded property entry in reverse map
using
truefor as array.
- If item is a value object or list object, an
- If result has no
- Otherwise, key is not a reverse property
use add value to add expanded value
to the expanded property entry in result
using
truefor as array.
- If key is
- For each key nesting-key in nests,
ordered lexicographically if
isorderedtrue:- Initialize nested values to the value of nesting-key in element, ensuring that it is an array.
- For each nested value in nested values:
- If nested value is not a map, or any key within
nested value expands to
@value, aninvalid @nest valueerror has been detected and processing is aborted. - Recursively repeat steps 13 and 14 using nested value for element.
- If nested value is not a map, or any key within
nested value expands to
- If result contains the entry
@value:- The result must not contain any entries other than
@direction,@index,@language,@type, and@value. It must not contain an@typeentry if it contains either@languageor@directionentries. Otherwise, aninvalid value objecterror has been detected and processing is aborted. - If the result's
@typeentry is@json, then the@valueentry may contain any value, and is treated as a JSON literal. - Otherwise, if the value of result's
@valueentry isnull, or an empty array, returnnull. - Otherwise, if the value of result's
@valueentry is not a string and result contains the entry@language, aninvalid language-tagged valueerror has been detected (only strings can be language-tagged) and processing is aborted. - Otherwise, if the result has an
@typeentry and its value is not an IRI, aninvalid typed valueerror has been detected and processing is aborted.
- The result must not contain any entries other than
- Otherwise, if result contains the entry
@typeand its associated value is not an array, set it to an array containing only the associated value. - Otherwise, if result contains the entry
@setor@list:- The result must contain at most one other entry
which must be
@index. Otherwise, aninvalid set or list objecterror has been detected and processing is aborted. - If result contains the entry
@set, then set result to the entry's associated value.
- The result must contain at most one other entry
which must be
- If result is a map that contains only the entry
@language, returnnull. - If active property is
nullor@graph, drop free-floating values as follows: - Return result.
5.2 IRI Expansion
In JSON-LD documents, some keys and values may represent IRIs. This section defines an algorithm for transforming a string that represents an IRI into an absolute IRI or blank node identifier. It also covers transforming keyword aliases into keywords.
IRI expansion may occur during context processing or during any of the other JSON-LD algorithms. If IRI expansion occurs during context processing, then the local context and its related defined map from the Context Processing algorithm are passed to this algorithm. This allows for term definition dependencies to be processed via the Create Term Definition algorithm.
5.2.1 Overview
This section is non-normative.
In order to expand value to an IRI, we must
first determine if it is null, a term, a
keyword alias, or some form of IRI. Based on what
we find, we handle the specific kind of expansion; for example, we expand
a keyword alias to a keyword and a term
to an IRI according to its IRI mapping
in the active context. While inspecting value we
may also find that we need to create term definition
dependencies because we're running this algorithm during context processing.
We can tell whether or not we're running during context processing by
checking local context against null.
We know we need to create a term definition in the
active context when value is
an entry in the local context and the defined map
does not have an entry for value with an associated value of
true. The defined map is used during
Context Processing to keep track of
which terms have already been defined or are
in the process of being defined. We create a
term definition by using the
Create Term Definition algorithm.
Note
Values that have the form of a keyword,
but are not keywords (i.e., they begin with "@") do not
map to any value, as they are reserved for future use.
The algorithm returns null, so that they will be ignored when encountered.
5.2.2 Algorithm
The algorithm takes two required and four optional input variables. The
required inputs are an active context and a value
to be expanded. The optional inputs are two flags,
document relative and vocab, that specifying
whether value can be interpreted as a relative IRI reference
against the document's base IRI or the
active context's
vocabulary mapping, respectively, and
a local context and a map defined to be used when
this algorithm is used during Context Processing.
If not passed, the two flags are set to false and
local context and defined are initialized to null.
- If value is a keyword or
null, return value as is. -
If value has the form of a keyword
(i.e., it matches the ABNF rule
"@"1*ALPHAfrom [RFC5234]), a processor SHOULD generate a warning and returnnull. - If local context is not
null, it contains an entry with a key that equals value, and the value of the entry for value in defined is nottrue, invoke the Create Term Definition algorithm, passing active context, local context, value as term, and defined. This will ensure that a term definition is created for value in active context during Context Processing. - If active context has a term definition for value, and the associated IRI mapping is a keyword, return that keyword.
- If vocab is
trueand the active context has a term definition for value, return the associated IRI mapping. - If value contains a colon (
:) anywhere after the first character, it is either an IRI, a compact IRI, or a blank node identifier:- Split value into a prefix and suffix
at the first occurrence of a colon (
:). - If prefix is underscore (
_) or suffix begins with double-forward-slash (//), return value as it is already an IRI or a blank node identifier. - If local context is not
null, it contains a prefix entry, and the value of the prefix entry in defined is nottrue, invoke the Create Term Definition algorithm, passing active context, local context, prefix as term, and defined. This will ensure that a term definition is created for prefix in active context during Context Processing. - If active context contains a term definition
for prefix
having a non-
nullIRI mapping and the prefix flag of the term definition istrue, return the result of concatenating the IRI mapping associated with prefix and suffix. - If value has the form of an IRI, return value.
- Split value into a prefix and suffix
at the first occurrence of a colon (
- If vocab is
true, and active context has a vocabulary mapping, return the result of concatenating the vocabulary mapping with value. - Otherwise, if document relative is
trueset value to the result of resolving value against the base IRI from active context. Only the basic algorithm in section 5.2 of [RFC3986] is used; neither Syntax-Based Normalization nor Scheme-Based Normalization are performed. Characters additionally allowed in IRI references are treated in the same way that unreserved characters are treated in URI references, per section 6.5 of [RFC3987]. - Return value as is.
5.3 Value Expansion
Some values in JSON-LD can be expressed in a compact form. These values are required to be expanded at times when processing JSON-LD documents. A value is said to be in expanded form after the application of this algorithm.
5.3.1 Overview
This section is non-normative.
If active property has a type mapping in the
active context set to @id or @vocab,
and the value is a string,
a map with a single entry @id whose
value is the result of using the
IRI Expansion algorithm on value
is returned.
Otherwise, the result will be a map containing
an @value entry whose value is the passed value.
Additionally, an @type entry will be included if there is a
type mapping associated with the active property
or an @language entry if value is a
string and there is language mapping associated
with the active property.
Note that values interpreted as IRIs fall into two categories:
those that are document relative, and those that are
vocabulary relative. Properties and values of @type,
along with terms marked as "@type": "@vocab"
are vocabulary relative, meaning that they need to be either
a defined term, a compact IRI
where the prefix is a term,
or a string which is turned into an IRI using
the vocabulary mapping.
5.3.2 Algorithm
The algorithm takes three required inputs: an active context, an active property, and a value to expand.
- If the active property has a type mapping
in active context that is
@id, and the value is a string, return a new map containing a single entry where the key is@idand the value is the result IRI expanding value usingtruefor document relative andfalsefor vocab. - If active property has a type mapping in
active context that is
@vocab, and the value is a string, return a new map containing a single entry where the key is@idand the value is the result of IRI expanding value usingtruefor document relative. - Otherwise, initialize result to a map
with an
@valueentry whose value is set to value. - If active property has a type mapping in
active context,
other than
@id,@vocab, or@none, add@typeto result and set its value to the value associated with the type mapping. - Otherwise, if value is a string:
- Initialize language to the language mapping for active property in active context, if any, otherwise to the default language of active context.
- Initialize direction to the direction mapping for active property in active context, if any, otherwise to the default base direction of active context.
- If language is not
null, add@languageto result with the value language. - If direction is not
null, add@directionto result with the value direction.
- Return result.
6. Compaction Algorithms
The following sections describe algorithms for compacting JSON-LD documents, IRIs and values.
6.1 Compaction Algorithm
This algorithm compacts a JSON-LD document, such that the given context is applied. This must result in shortening any applicable IRIs to terms or compact IRIs, any applicable keywords to keyword aliases, and any applicable JSON-LD values expressed in expanded form to simple values such as strings or numbers.
6.1.1 Overview
This section is non-normative.
Starting with its root element, we can process the JSON-LD document recursively, until we have a fully compacted result. When compacting an element, we can treat each one differently according to its type, in order to break down the problem:
- If the element is a scalar, it is already in compacted form, so we simply return it.
- If the element is an array, we compact each of its items recursively and return them in a new array.
- Otherwise element is a map. The value
of each entry in element is compacted recursively. Some of the entry keys will be
compacted, using the IRI Compaction algorithm,
to terms or compact IRIs
and others will be compacted from keywords to
keyword aliases or simply left
unchanged because they do not have definitions in the context.
Values will be converted to compacted form via the
Value Compaction algorithm. Some data
will be reshaped based on container mapping
specified in the context such as
@indexor@languagemaps.
6.1.2 Algorithm
The algorithm takes three required and two optional input variables.
The required inputs are an active context,
an active property,
and an element to be compacted.
The optional inputs are the
flag
and the compactArrays flag, used to order
map entry keys lexicographically, where noted.
If not passed, both flags are set to orderedfalse.
- Initialize type-scoped context to active context. This is used for compacting values that may be relevant to any previous type-scoped context.
- If element is a scalar, it is already in its most compact form, so simply return element.
- If element is an array:
- Initialize result to an empty array.
- For each item in element:
- Initialize compacted item to the result of using this
algorithm recursively, passing active context,
active property,
item for element,
and the
andcompactArraysflags.ordered - If compacted item is not
null, then append it to result.
- Initialize compacted item to the result of using this
algorithm recursively, passing active context,
active property,
item for element,
and the
- If result is empty or contains more than one value,
or
iscompactArraysfalse, or active property is either@graphor@set, or container mapping for active property in active context includes either@listor@set, return result. - Otherwise, return the value in result.
- Otherwise element is a map.
- If active context has a previous context,
the active context is not propagated.
If element does not contain an
@valueentry, and element does not consist of a single@identry, set active context to previous context from active context, as the scope of a term-scoped context does not apply when processing new node objects. - If the term definition for active property in active context
has a local context:
- Set active context to the result of the
Context Processing algorithm,
passing active context,
the value of the active property's local context as local context,
base URL from the term definition for active property
in active context,
and
truefor override protected.
- Set active context to the result of the
Context Processing algorithm,
passing active context,
the value of the active property's local context as local context,
base URL from the term definition for active property
in active context,
and
- If element has an
@valueor@identry and the result of using the Value Compaction algorithm, passing active context, active property, and element as value is a scalar, or the term definition for active property has a type mapping of@json, return that result. - If element is a
list object, and the container mapping for
active property in active context includes
@list, return the result of using this algorithm recursively, passing active context, active property, value of@listin element for element, and theandcompactArraysflags.ordered - Initialize inside reverse to
trueif active property equals@reverse, otherwise tofalse. - Initialize result to an empty map.
- If element has an
@typeentry, create a new array compacted types initialized by transforming each expanded type of that entry into its compacted form by IRI compacting expanded type. Then, for each term in compacted types ordered lexicographically:- If the term definition for term in type-scoped context has a
local context
set active context to the result of the
Context Processing algorithm,
passing active context and the value of term's
local context in type-scoped context as local context
base URL from the term definition for term
in type-scoped context,
and
falsefor propagate.
- If the term definition for term in type-scoped context has a
local context
set active context to the result of the
Context Processing algorithm,
passing active context and the value of term's
local context in type-scoped context as local context
base URL from the term definition for term
in type-scoped context,
and
- For each key expanded property and value expanded value
in element, ordered lexicographically by expanded property
if
isorderedtrue:- If expanded property is
@id:- If expanded value is a string,
then initialize compacted value
by IRI compacting expanded value
with vocab set to
false. - Initialize alias by IRI compacting expanded property.
- Add an entry alias to result whose value is set to compacted value and continue to the next expanded property.
- If expanded value is a string,
then initialize compacted value
by IRI compacting expanded value
with vocab set to
- If expanded property is
@type:- If expanded value is a string, then initialize compacted value by IRI compacting expanded value using type-scoped context for active context.
- Otherwise, expanded value must be a
@typearray:- Initialize compacted value to an empty array.
- For each item expanded type in
expanded value:
- Set term by IRI compacting expanded type using type-scoped context for active context.
- Append term, to compacted value.
- Initialize alias by IRI compacting expanded property.
- Initialize as array
to
trueif processing mode isjson-ld-1.1and the container mapping for alias in the active context includes@set, otherwise to the negation of.compactArrays - Use add value to add compacted value to the alias entry in result using as array.
- Continue to the next expanded property.
- If expanded property is
@reverse:- Initialize compacted value to the result of using this
algorithm recursively, passing active context,
@reversefor active property, expanded value for element, and theandcompactArraysflags.ordered - For each property and value in compacted value:
- If the term definition for property in the
active context indicates that property is
a reverse property
- Initialize as array
to
trueif the container mapping for property in the active context includes@set, otherwise the negation of.compactArrays - Use add value to add value to the property entry in result using as array.
- Remove the property entry from compacted value.
- Initialize as array
to
- If the term definition for property in the
active context indicates that property is
a reverse property
- If compacted value has some remaining map entries, i.e.,
it is not an empty map:
- Initialize alias
by IRI compacting
@reverse. - Set the value of the alias entry of result to compacted value.
- Initialize alias
by IRI compacting
- Continue with the next expanded property from element.
- Initialize compacted value to the result of using this
algorithm recursively, passing active context,
- If expanded property is
@preservethen:- Initialize compacted value to the result of using this
algorithm recursively, passing
active context,
active property,
expanded value for element,
and the
andcompactArraysflags.ordered - Add compacted value as the value of
@preservein result unless expanded value is an empty array.
- Initialize compacted value to the result of using this
algorithm recursively, passing
active context,
active property,
expanded value for element,
and the
- If expanded property is
@indexand active property has a container mapping in active context that includes@index, then the compacted result will be inside of an@indexcontainer, drop the@indexentry by continuing to the next expanded property. - Otherwise, if expanded property is
@direction,@index,@language, or@value:- Initialize alias by IRI compacting expanded property.
- Add an entry alias to result whose value is set to expanded value and continue with the next expanded property.
- If expanded value is an empty array:
- Initialize item active property by IRI compacting expanded property using expanded value for value and inside reverse for reverse.
- If the term definition for item active property
in the active context has a nest value
entry (nest term):
- If nest term is not
@nest, or a term in the active context that expands to@nest, aninvalid @nest valueerror has been detected, and processing is aborted. - If result does not have a nest term entry, initialize it to an empty map.
- Initialize nest result to the value of nest term in result.
- If nest term is not
- Otherwise, initialize nest result to result.
- Use add value to add an empty array
to the item active property entry in nest result
using
truefor as array.
-
At this point, expanded value must be an
array due to the
Expansion algorithm.
For each item expanded item in expanded value:
- Initialize item active property by IRI compacting expanded property using expanded item for value and inside reverse for reverse.
- If the term definition for item active property
in the active context has a nest value
entry (nest term):
- If nest term is not
@nest, or a term in the active context that expands to@nest, aninvalid @nest valueerror has been detected, and processing is aborted. - If result does not have a nest term entry, initialize it to an empty map.
- Initialize nest result to the value of nest term in result.
- If nest term is not
- Otherwise, initialize nest result to result.
- Initialize container to container mapping for item active property in active context, or to a new empty array, if there is no such container mapping.
- Initialize as array
to
trueif container includes@set, or if item active property is@graphor@list, otherwise the negation of.compactArrays - Initialize compacted item to the result of using
this algorithm recursively, passing
active context,
item active property for active property,
expanded item for element,
along with the
andcompactArraysflags. If expanded item is a list object or a graph object, use the value of theordered@listor@graphentries, respectively, for element instead of expanded item. - If expanded item is a list object:
- If compacted item is not an array, then set compacted item to an array containing only compacted item.
- If container does not include
@list:- Convert compacted item to a
list object by setting it to a
map containing an entry
where the key is the result of
IRI compacting
@listand the value is the original compacted item. - If expanded item contains the entry
@index-value, then add an entry to compacted item where the key is the result of IRI compacting@indexand value is value. - Use add value to add compacted item to the item active property entry in nest result using as array.
- Convert compacted item to a
list object by setting it to a
map containing an entry
where the key is the result of
IRI compacting
- Otherwise, set the value of the item active property entry in nest result to compacted item.
- If expanded item is a graph object:
- If container includes
@graphand@id:- Initialize map object to the value of item active property in nest result, initializing it to a new empty map, if necessary.
- Initialize map key
by IRI compacting
the value of
@idin expanded item or@noneif no such value exists with vocab set tofalseif there is an@identry in expanded item. - Use add value to add compacted item to the map key entry in map object using as array.
- Otherwise, if container includes
@graphand@indexand expanded item is a simple graph object:- Initialize map object to the value of item active property in nest result, initializing it to a new empty map, if necessary.
- Initialize map key the value of
@indexin expanded item or@none, if no such value exists. - Use add value to add compacted item to the map key entry in map object using as array.
- Otherwise, if container includes
@graphand expanded item is a simple graph object the value cannot be represented as a map object.- If compacted item is an array
with more than one value, it cannot be directly represented,
as multiple objects would be interpreted as different named graphs.
Set compacted item to a new map,
containing the key
from IRI compacting
@includedand the original compacted item as the value. - Use add value to add compacted item to the item active property entry in nest result using as array.
- If compacted item is an array
with more than one value, it cannot be directly represented,
as multiple objects would be interpreted as different named graphs.
Set compacted item to a new map,
containing the key
from IRI compacting
- Otherwise, container does not include
@graphor otherwise does not match one of the previous cases.- Set compacted item to a new map containing
the key
from IRI compacting
@graphusing the original compacted item as a value. - If expanded item contains an
@identry, add an entry in compacted item using the key from IRI compacting@idusing the value of IRI compacting the value of@idin expanded item usingfalsefor vocab. - If expanded item contains an
@indexentry, add an entry in compacted item using the key from IRI compacting@indexand the value of@indexin expanded item. - Use add value to add compacted item to the item active property entry in nest result using as array.
- Set compacted item to a new map containing
the key
from IRI compacting
- If container includes
-
Otherwise, if container includes
@language,@index,@id, or@typeand container does not include@graph:- Initialize map object to the value of item active property in nest result, initializing it to a new empty map, if necessary.
- Initialize container key
by IRI compacting
either
@language,@index,@id, or@typebased on the contents of container. - Initialize index key to the value of index mapping in
the term definition associated with item active property in active context,
or
@index, if no such value exists. - If container includes
@languageand expanded item contains a@valueentry, then set compacted item to the value associated with its@valueentry. Set map key to the value of@languagein expanded item, if any. - Otherwise, if container includes
@indexand index key is@index, set map key to the value of@indexin expanded item, if any. - Otherwise, if container includes
@indexand index key is not@index:- Reinitialize container key by IRI compacting index key.
- Set map key to the first value of container key in compacted item, if any.
- If there are remaining values in compacted item for container key, use add value to add those remaining values to the container key in compacted item. Otherwise, remove that entry from compacted item.
- Otherwise, if container includes
@id, set map key to the value of container key in compacted item and remove container key from compacted item. - Otherwise, if container includes
@type:- Set map key to the first value of container key in compacted item, if any.
- If there are remaining values in compacted item for container key, use add value to add those remaining values to the container key in compacted item.
- Otherwise, remove that entry from compacted item.
- If compacted item contains a single entry with a key expanding
to
@id, set compacted item to the result of using this algorithm recursively, passing active context, item active property for active property, and a map composed of the single entry for@idfrom expanded item for element
- If expanded property is