This work is licensed under a Creative Commons Attribution 4.0 International License.
This document describes xR2RML, a language for expressing customized mappings from various types of databases (XML, object-oriented, NoSQL) to RDF datasets.
xR2RML is an extension of the R2RML [1] mapping language, and relies on some properties of the RML mapping language [4][3]. R2RML addresses the mapping of relational databases to RDF. RML extends R2RML to address the mapping of heterogeneous data formats (CSV, XML, JSON) to RDF, but does not investigate the constraints that arise when dealing with different types of heterogeneous databases. xR2RML extends this scope to a wide range of non-relational databases. This document leverages the R2RML specification and mainly describes extensions. It also leverage the RML specification [2] (Draft, 17 Sept. 2014), either explicitly reusing RML properties when applicable, or by extending existing properties. Consequently, the reader should have a good understanding of both R2RML and RML before reading this document.
xR2RML is backward compatible with R2RML.
Version | Date | Description |
---|---|---|
1 | 2014-09-22 | Initial version |
2 | 2014-10-08 | Fix spelling mistakes. |
3 | 2014-10-20 | Convergence with RML language definitions, moving of reference formulation from language to processor environment, fix misc. minor mistakes. |
4 | 2016-11-07 | Add property xrr:uniqueRef in logical source. Many rewordings and clarifications. |
5 | 2017-10-25 | Add property xrr:pushDown in logical source and nested term map |
5.1 | 2019-06-19 | Add property xrr:languageReference to handle varialbe language tag |
5.2 | 2021-07-30 | Add extended function sha1() |
In this document, examples assume the following namespace prefix bindings unless otherwise tated:
Prefix | IRI |
---|---|
rr: |
http://www.w3.org/ns/r2rml# |
rml: |
http://semweb.mmlab.be/ns/rml# |
ql: |
http://semweb.mmlab.be/ns/ql# |
xrr: |
http://www.i3s.unice.fr /ns/xr2rml# |
rdf: |
http://www.w3.org/1999/02/22-rdf-syntax-ns# |
rdfs: |
http://www.w3.org/2000/01/rdf-schema# |
xsd: |
http://www.w3.org/2001/XMLSchema# |
ex: |
http://example.com/ns# |
Vocabulary definitions are formatted in such grey boxes:
R2RML is specifically focused on the translation of relational databases into RDF datasets. xR2RML extends this scope to non-relational databases. Although it is illusory to seek universal support of any database, our endeavor is to equally support most common relational and non-relational databases. In our approach, we more specifically analyze the requirements to support NoSQL and XML databases. Yet, xR2RML may not support all NoSQL databases, given the large variety of systems behind this word. Nevertheless, we argue that our work can be generalized to some other types of database, for instance object-oriented and directory (LDAP) databases.
Relational databases all support ANSI SQL (or at least a subset of it), and most XML databases support XQuery and XPath (which is subset of XQuery). By contrast, NoSQL is a catch-all term referring to very diverse systems [6][5]. They have heterogeneous access methods ranging from low-level APIs to expressive query languages. Despite several propositions of common query language (N1QL, UnQL, SQL++ [8], ArangoDB Query Language, CloudMdsQL[7]), no consensus has emerged yet, that would fit most NoSQL databases. Therefore, until a standard eventually arises, xR2RML must be agile enough to cope with various query languages and protocols.
Remark: R2RML relies on the ability of relational databases to support a declarative query language. xR2RML does the same assumption with regards to other types of databases, although this may be limitative. For instance, most NoSQL key-value stores provide simple key-based operations (such as put, get, delete) by means of APIs used in imperative programming languages, but they hardly provide a declarative query language. If such a system is to be mapped to RDF using xR2RML, an xR2RML processor should implement a mechanism to bridge this gap. In other words the xR2RML processor should define its own query language to be interpreted and compiled using an imperative programming language.
Relational databases comply with a row-based model in which all rows have the same columns.
NoSQL systems have heterogeneous data models (key-value store, document store, extensible column-store, graph store). Some of them also comply with the row-based model, such as extensible column-stores (also known as column family stores) with the difference that all rows do not necessarily share the same columns (BigTables, Cassandra…). Other databases in which data is formatted in JSON (document stores such as MongoDB, CouchDB…) or XML (native XM databases such as BaseX, eXistDB) can hardly be reduced to a row-based model. JSON or XML documents consist of structured (hierarchical) values representing collections or key-value associations:
The model of structured values described above for JSON and XML can easily be applied to other databases. In an object-oriented model, an object can be approximated by as a key-value association: keys are attribute names while values are either a scalar, another object (composition or aggregation relationship), or a collection (depending on capabilities of the modeling language: list, map, etc). Similarly, an LDAP directory is organized as a tree. Each node has an identifier and a set of attributes represented as ''name=value'' that are nothing else than a key-value association. A set of attributes with the same name can be interpreted as either as a collection or a key-value association in which keys are not unique. Thus, xR2RML must be able to map data elements from rows as well as structured values (nested collections and key-value associations) to RDF terms.
Note: Below, we shall use the term "structured values" to refer to collections and key-value associations, whatever the representation syntax used.
An xR2RML mapping document is any document written in the Turtle RDF syntax that encodes an xR2RML mapping graph.
Any R2RML mapping graph is a valid xR2RML mapping graph (backward compatibility).An xR2RML processor has access to an execution environment consisting of:
It is the responsibility of an xR2RML processor developer to document how to provide the processor with this context information.
This section gives a brief overview of the xR2RML mapping language, followed by simple examples of mapping various types of database to RDF.
An xR2RML mapping refers to logical sources to retrieve data from the input database. A logical source can be either an xR2RML base table (for input databases where tables or views exist, such as SQL views), or an xR2RML view representingthe result of executing a query against the input database. An xR2RML processor is provided an xR2RML mapping description, a connection to the database and a reference formulation that specifies the syntax used to refer to data elements retrieved from the input database: this can be a column name in the case of row-based systems (RDB, extensible column-store), a JSONPath expression in case of a NoSQL document store, an XPath expression in case of an XML native database, an LDAP path in case of an LDAP directory, etc.
Each logical source is mapped to RDF using a triples map. As in R2RML, a triples map consists of a subject map that generates the subject of all RDF triples that will be generated from data elements, and multiple predicate-object maps that produce the predicate and object terms of triples.
The input database in the example below consists of one CSV document. It is assumed that the xR2RML processor is provided a connection to that file, e.g. by means of a descriptor to a file on the local file system or a URL to locate the file on a web server. Data elements will be referenced using column names, i.e. the reference formulation passed to the xR2RML processor.
As a CSV file simply consists of a single unnamed table, the logical source can simply be left empty.
Input data | title, year, director Manhattan, 1979, Woody Allen Annie Hall, 1979, Woody Allen 2046, 2004, Wong Kar-wai In the Mood for Love, 2000, Wong Kar-wai |
Mapping graph | <#CSVTriplesMap> rr:subjectMap [rr:template "http://example.org/movie/{title}"; ]; rr:predicateObjectMap [ rr:predicate ex:directedBy; rr:objectMap [ xrr:reference "director"; ]; ]. |
RDF triples produced | <http://example.org/movie/Manhattan> ex:directedBy "Woody Allen". <http://example.org/movie/Annie%20Hall> ex:directedBy "Woody Allen". <http://example.org/movie/2046> ex:directedBy "Wong Kar-wai". <http://example.org/movie/In%20the%20Mood%20for%20Love> ex:directedBy "Wong Kar-wai". |
The input database in the example below is a MongoDB database (document store). The query in the logical source uses the proprietary JavaScript-based query language of MongoDB. It retrieves one JSON document from collection "movies", that lists movie directors and movies they directed.
Without further instruction on how to parse the document, JSONPath expressions referring to data elements in the subject and object map will be evaluated against the whole document. For instance, a subject using expression "$.directors.name" will return two terms, while an object map using expression "$.directors.movies.*" will return four terms, one for each movie whatever its director. This will result in mixing up directors and movies. To avoid this, an rml:iterator property is added to the logical source, specifying that the triples map iteration should occur on each element of the array of directors.
References to data elements (rr:template, xrr:reference), as well as the iterator pattern, are expressed in JSONPath (i.e. the reference formulation, passed to the xR2RML processor along with the database connection).
Input data | { "directors": [ { "name": "Wong Kar-wai", "movies": ["2046", "In the Mood for Love"] }, { "name": "Woody Allen", "movies": ["Manhattan", "Annie Hall"] } ]} |
Mapping graph | <#Directors> xrr:logicalSource [ xrr:query "db.movies.find( { directors: { $exists: true} } )"; rml:iterator "$.directors.*"; ]; rr:subjectMap [ rr:template "http://example.org/director/{$.name}"; ]; rr:predicateObjectMap [ rr:predicate ex:directed; rr:objectMap [ xrr:reference "$.movies.*"; ]; ]. |
RDF triples produced | <http://example.org/director/Woody%20Allen> ex:directed "Manhattan". <http://example.org/director/Woody%20Allen> ex:directed "Annie Hall". <http://example.org/director/Wong%20Kar-wai> ex:directed "2046". <http://example.org/director/Wong%20Kar-wai> ex:directed "In the Mood for Love". |
The example below is very similar to the previous one, using an XML database supporting XQuery. The query in the logical source retrieves "director" XML elements. As in the previous example, to avoid mixing up directors and movies, an rml:iterator property is added to the logical source, specifying that the triples map iteration should occur on each "director" XML element.
References to data elements (rr:template, xrr:reference), as well as the iterator pattern, use the XPath syntax (i.e. the reference formulation, passed to the xR2RML processor along with the database connection).
Input data | <directors> <director name="Wong Kar-wai"> <movies> <movie>2046</movie> <movie>In the Mood for Love</movie> </movies> </director> <director name="Woody Allen"> <movies> <movie>Manhattan</movie> <movie>Annie Hall</movie> </movies> </director> </directors> |
Mapping graph | <#Directors> xrr:logicalSource [ """for $i in //directors/director where $i/country eq "China" return $i; """; ]; rr:subjectMap [ rr:template "http://example.org/director/{/director/@name}"; ]; rr:predicateObjectMap [ rr:predicate ex:directed; rr:objectMap [ xrr:reference "//movie"; ]; ]. |
RDF triples produced | <http://example.org/director/Woody%20Allen> ex:directed "Manhattan". <http://example.org/director/Woody%20Allen> ex:directed "Annie Hall". <http://example.org/director/Wong%20Kar-wai> ex:directed "2046". <http://example.org/director/Wong%20Kar-wai> ex:directed "In the Mood for Love". |
In some use cases, it is common to store values in a format which is not the native database format. For instance, an application designer may choose to embed JSON, CSV, or XML values in the cells of a relational database, for performance concerns or application design constraints.
xR2RML allows to reference data elements within such mixed contents with mixed-syntax paths. A path with mixed-syntax consists of the concatenation of several path expressions separated by the slash '/' character. Each individual path is enclosed in a syntax path constructor: Column(column-name), CSV(column-name), TSV(column-name), JSONPath(JSONPath-expression), XPath(XPath-expression).
In the example below, the logical source is a relational table with two columns. The second column, Movies, holds values formatted as JSON arrays. The xrr:reference property of the object map uses a mixed-syntax path: Column(Movies)/JSONPath($.*). This expression selects values from column "Movies" and evaluates JSONPath expression "$.*" against the values.
Input data | Table DIRECTORS:
|
||||||
Mapping graph |
<#Directors>
rr:logicalTable [
rr:tableName "DIRECTORS";
];
rr:subjectMap [ rr:template "http://example.org/director/{Name}"; ];
rr:predicateObjectMap [
rr:predicate ex:directed;
rr:objectMap [ xrr:reference "Column(Movies)/JSONPath($.*)"; ];
]. |
||||||
RDF triples produced | <http://example.org/director/Woody%20Allen> ex:directed "Manhattan". <http://example.org/director/Woody%20Allen> ex:directed "Annie Hall". <http://example.org/director/Wong%20Kar-wai> ex:directed "2046". <http://example.org/director/Wong%20Kar-wai> ex:directed "In the Mood for Love". |
As illustrated by the previous example, several RDF terms can be generated by a term map during one triples map iteration step. While this can lead to the generation of several triples, this can also be used to generate hierarchical values in the form of RDF collections or containers.
The example below was already presented in section 2.2. In the object map we simply add an rr:termType property with value xrr:RdfList. All RDF terms produced by the object map during one triples map iteration step are then grouped as members of one term of type rdf:List (denoted as "(a b c…)" in Turtle syntax).
Additionally, assume we want to add a language tag to the movie titles. The object map describes the generation of RDF lists, hence it would not make sense to add an rr:language property. To state properties about the members of the generated RDF list, we need a nested term map, introduced by the xrr:nestedTermMap property. A nested term map accepts the same properties as a term map, but it applies to members of RDF collection/container terms generated by its parent term map.
Input data | { "directors": [ { "name": "Wong Kar-wai", "movies": ["2046", "In the Mood for Love"] }, { "name": "Woody Allen", "movies": ["Manhattan", "Annie Hall"] } ]} |
Mapping graph |
<#Directors>
xrr:logicalSource [
xrr:query "db.movies.find( { directors: { $exists: true} } )";
rml:iterator "$.directors.*";
];
rr:subjectMap [ rr:template "http://example.org/director/{$.name}"; ];
rr:predicateObjectMap [
rr:predicate ex:directed;
rr:objectMap [
xrr:reference "$.movies.*";
rr:termType xrr:RdfList;
xrr:nestedTermMap [ rr:language "en"; ]
];
]. |
RDF triples produced | <http://example.org/director/<Wong%20Kar-wai> ex:directed ( "2046"@en "In the Mood for Love"@en ). |
The example below uses a referencing object map to describe a cross-reference relationship between logical resources. In addition, it generates an RDF bag from the result of the join condition in the referencing object map.
Triples map <#Movies> generates IRIs for the movies. The referencing object map in triples map <#Directors> uses IRI generated in triples map <#Movies> as the members of an RDF bag (property rr:term:Type xrr:RdfBag).
The join condition in triples map <#Directors> produces a result if a movie title (rr:parent "$.title") matches at least one movie in the list of movies associated with each director (rr:child "$.movies.*").
Input data | { "directors": [ { "name": "Wong Kar-wai", "movies": ["2046", "In the Mood for Love"] }, { "name": "Woody Allen", "movies": ["Manhattan", "Annie Hall"] } ]} { "movies": [ { "title": "Manhattan", "year": "1979" }, { "title": "Annie Hall", "year": "1977" }, { "title": "2046", "year": "2004" }, { "title": "In the Mood for Love", "year": "2000"} ]} |
Mapping graph |
<#Movies>
xrr:logicalSource [
xrr:query "db.movies.find( { movies: { $exists: true} } )";
rml:iterator "$.movies.*";
];
rr:subjectMap [ rr:template "http://example.org/movies/{$.title}"; ].
<#Directors>
xrr:logicalSource [
xrr:query "db.movies.find( { directors: { $exists: true} } )";
rml:iterator "$.directors.*";
];
rr:subjectMap [ rr:template "http://example.org/director/{$.name}"; ];
rr:predicateObjectMap [
rr:predicate ex:directed;
rr:objectMap [
rr:parentTriplesMap <#Movies>;
rr:joinCondition [
rr:child "$.movies.*";
rr:parent "$.title";
];
rr:termType xrr:RdfBag;
];
]. |
Generated RDF triples | <http://example.org/director/Woody%20Allen> ex:directed [ a rdf:Bag; rdf:_1 <http://example.org/movie/Manhattan>"; rdf:_1 <http://example.org/movie/Annie%20Hall>. ]. <http://example.org/director/<Wong%20Kar-wai> ex:directed [ a rdf:Bag; rdf:_1 <http://example.org/movie/2046>"; rdf:_2 <http://example.org/movie/In%20the%20Mood%20for%20Love>. ]. |
An xR2RML triples map specifies a rule for translating data elements of a logical source to zero or more RDF triples. The RDF triples generated from one data element (row, document, set of XML elements, etc.) in the logical source all share the same subject.
An xR2RML triples map extends R2RML triples map by referencing a logical source (next section) instead of a logical table. An xR2RML triples map is represented by a resource that references the following resources:
R2RML logical table: An R2RML logical table is a data set on which a triples map applies: this may be a relational table, an SQL view, or the result of a valid SQL query (property rr:sqlQuery).
RML logical source:
The discussion above underlines that it would not be suitable for xR2RML to extend RML's logical source concept. Instead, the xR2RML logical source extends the R2RML logical table, while relevant RML properties are used or extended separately.
Below we define the xR2RML logical source that extends the R2RML logical source to cope with a wider scope of input databases as well as richer iteration models detailed in section 3.1.3.
A logical source (property xrr:logicalSource) extends the R2RML concept of logical table (property rr:logicalTable) in the case of non-relational databases. A logical source is the result of a query applied to the input database, to be mapped to RDF triples. A logical source is either an xR2RML base table or an xR2RML view.
An xR2RML base table is a logical source containing data from a table in the input database. It simply extends the concept of R2RML table or view to the context of tabular databases beyond relational databases (e.g. CSV, extensible column store). An xR2RML base table is represented by a resource that has exactly one rr:tableName property. Its object is a string literal representing the table name.
An xR2RML view is a logical source whose content is the result of executing a query against the input database. It is represented by a resource that has exactly one xrr:query property. Property xrr:query extends RML property rml:query. The object of property xrr:query is a string literal representing a valid expression with regards to the query language supported by the input database.
A logical source may have one data property rml:iterator that specifies the iteration pattern to apply on data retrieved from the input database (section 3.1.3). Its object is an expression written using the reference formulation (section 1.4). The rml:iterator property is ignored in the context of tabular result sets in which data is accessed by column names.
An rml:iterator property may be complemented with any number of xrr:pushDown properties (section 3.1.3) that specify how some values must be added within the documents that result of the rml:iterator. The object of a xrr:pushDown property is an instance of the xrr:PushDown class, that must have exactly one xrr:reference property and one xrr:as property.
A logical source may have any number of xrr:uniqueRef properties that specify a unique data element reference within the documents retrieved by the xrr:query property. This property may be used for query optimization when rewriting a SPARQL query into the target database query language. The unique data element reference is an expression written according to the syntax specified by the reference formulation (section 1.4).
Note that xR2RML logical source and R2RML logical table definitions may equally be used in the case of a relational database. Examples:
R2RML logical table | Equivalent xR2RML logical source |
---|---|
[] rr:logicalTable [ rr:tableName "SOME_TABLE". ] |
[] xrr:logicalSource [ rr:tableName "SOME_TABLE"; ] |
[] rr:logicalTable [ rr:sqlQuery "SELECT NAME, DATE FROM MOVIES". ] |
[] xrr:logicalSource [ xrr:query "SELECT NAME, DATE FROM MOVIES". ] |
The table below shows examples of xR2RML logical source definition with different flavors of input databases.
Type of database | Logical source definition |
---|---|
Relational database | [] rr:logicalTable [ rr:sqlQuery """ SELECT TITLE FROM MOVIES WHERE YEAR > 1980 ORDER BY YEAR LIMIT 10"""; ]; |
XML file. The xR2RML processor is provided with a file URL, e.g. http://example.org/movies.xml, and the XPath reference formulation. Therefore no further query is required (no xrr:query property). An iterator defines the pattern of XML elements to iterate on. XPath is used to refer to data elements within the XML data returned by the database. |
[] xrr:logicalSource [ rml:iterator "//movie"; ]; |
REST-based web service returning an XML stream based on parameters passed in the HTTP GET query string. The service URL (e.g. http://example.org/service) and XPath reference formulation are passed to the xR2RML processor by configuration, while the HTTP query string is provided by the xrr:query property. | [] xrr:logicalSource [ xrr:query "?minYear=1980&limit=10"; rml:iterator "//movie"; ]; |
XML database supporting XQuery. XPath is used to describe the iterator and later on to refer to data elements within the XML data returned by the database. |
[] xrr:logicalSource [ xrr:query """for $i in //movies/movie where $i/year gt 1980 order by $i/@title return $i/@title"""; rml:iterator "//movie"; ]; |
JSON file. The xR2RML processor is provided with file URL and the JSONPath reference formulation. No further query is required (no xrr:query property). An iterator defines the pattern to iterate on. |
[] xrr:logicalSource [ rml:iterator "$.movies.*"; ]; |
MongoDB database (document store). MongoDB Shell Query Language is used to search for documents in collection "movies". Then, JSONPath is used to refer to data elements within the JSON documents returned by the database. | [] xrr:logicalSource [ xrr:query '''db.movies.find({"year":{$gt: 1980}})'''; xrr:uniqueRef "$.movieId" ]; |
Cassandra (extensible column store) using Cassandra Query Language (CQL). Data element are referenced by column name (reference formulation passed to the xR2RML processor). | [] xrr:logicalSource [ xrr:query """SELECT TITLE, YEAR FROM Movies LIMIT 10"""; ]; |
AllegroGraph (RDF graph store) using SPARQL. The column name reference formulation is applied to a SPARQL result set: the result set is considered as a table in which columns are named after variable names. |
[] xrr:logicalSource [ xrr:query """select ?title ?year where { ?movie a ex:Movie; ex:name ? title; ex:year ?year. } filter (?year > "1980"^^xsd:integer) order by ?year limit 10"""; ]; |
In R2RML, the row-based iteration implicitly occurs on a set of rows read from a logical table. xR2RML applies this principle to other row-based systems such as CSV/TSV files and extensible column stores, but also SPARQL result sets as already mentioned. In the context of non row-based databases, the model is implicitly extended to a document-based iteration model: a document is one result of a result set, whatever the form of such a result. Typically, the document-based iteration applies to a set of JSON documents retrieved from a NoSQL document store, or a set of XML documents retrieved from an XML database. In the case of data sources that do not natively provide iterators over results, for instance a simple XML file or a web service returning an XML stream at once, then a single iteration occurs on the whole document retrieved.
The document-based iteration model alone may not be sufficient to fulfill any iteration needs. This is particularly true for hierarchical data models such as JSON and XML. Let us consider the JSON document below that describes movie directors and respective movies:
{ "type": 3, "directors": [ { "name": "Wong Kar-wai", "movies": ["2046", "In the Mood for Love"] }, { "name": "Woody Allen", "movies": ["Manhattan", "Annie Hall"] } ]} |
We consider the following xR2RML following mapping graph:
<#Directors> xrr:logicalSource [ xrr:query "db.movies.find( { directors: { $exists: true} } )" ]; rr:subjectMap [ rr:template "http://example.org/director/{$.name}"; ]; rr:predicateObjectMap [ rr:predicate ex:directed; rr:objectMap [ xrr:reference "$.directors.*.movies.*"; ]; ]. |
In this mapping, the subject map returns two terms (one per director) while the object map returns four terms (one per movie in the document). Consequently, triples are generated that mix up all directors and movies:
<http://example.org/director/Woody%20Allen> ex:directed "Manhattan". <http://example.org/director/Woody%20Allen> ex:directed "Annie Hall". <http://example.org/director/Woody%20Allen> ex:directed "2046". <http://example.org/director/Woody%20Allen> ex:directed "In the Mood for Love". <http://example.org/director/Wong%20Kar-wai> ex:directed "Manhattan". <http://example.org/director/Wong%20Kar-wai> ex:directed "Annie Hall". <http://example.org/director/Wong%20Kar-wai> ex:directed "2046". <http://example.org/director/Wong%20Kar-wai> ex:directed "In the Mood for Love". |
To deal with such cases, xR2RML relies on the concept of iterator defined in RML:
An iterator is defined within an xR2RML logical source by means of the rml:iterator property. It specifies the iteration pattern to apply to data retrieved from the input database. The object of an rml:iterator property is a valid path expression written using the reference formulation (section 1.4).
With the rml:iterator property, the previous example is modified as shown below:
<#Directors>
xrr:logicalSource [
xrr:query "db.movies.find( { directors: { $exists: true} } )";
rml:iterator "$.directors.*";
];
rr:subjectMap [ rr:template "http://example.org/director/{$.name}"; ];
rr:predicateObjectMap [
rr:predicate ex:directed;
rr:objectMap [ xrr:reference "$.movies.*"; ];
]. |
The rml:iterator property indicates that, within the document retrieved, the triples map iteration should be performed on each director element rather than on the whole document. The iterator now yields two separate documents:
{ "name": "Wong Kar-wai", "movies": ["2046", "In the Mood for Love"] } { "name": "Woody Allen", "movies": ["Manhattan", "Annie Hall"] } |
Finally, the first document yields the first two triples below, while the second document yields the 3rd and 4th triples:
<http://example.org/director/Woody%20Allen> ex:directed "Manhattan". <http://example.org/director/Woody%20Allen> ex:directed "Annie Hall". <http://example.org/director/Wong%20Kar-wai> ex:directed "2046". <http://example.org/director/Wong%20Kar-wai> ex:directed "In the Mood for Love". |
Let us now assume that we would like field “type” (whose value is 3, whatever this means) to be part of the subject terms, e.g. <http://example.org/director/3-Woody%20Allen>. The documents yielded by the iterator do not contain field “type” since it is defined higher in the document hierarchy. To address this issue, we define an element of class xrr:PushDown with the xrr:pushDown property:
An xrr:PushDown instance is defined within an xR2RML logical source by means of the xrr:pushDown property. It is valid only as a companion of an rml:iterator property. It specifies a reference (property xrr:reference), written using the reference formulation (section 1.4), whose value must be added in the documents yielded by the iterator as a new data element whose name is given by the xrr:as property of the xrr:PushDown instance.
In our example, this should look like:
<#Directors> xrr:logicalSource [ xrr:query "db.movies.find( { directors: { $exists: true} } )"; rml:iterator "$.directors.*"; xrr:pushDown [ xrr:reference "$.type"; xrr:as "newType" ]; ]; rr:subjectMap [ rr:template "http://example.org/director/{$.newType}-{$.name}"; ]; rr:predicateObjectMap [ rr:predicate ex:directed; rr:objectMap [ xrr:reference "$.movies.*"; ]; ]. |
As a result, a field “newType” (property xrr:as) is created within the documents yielded by the iterator. The value of this field is the result of evaluating the “$.type” reference (xrr:reference property) against the documents fetched from the database. Example:
{ "name": "Wong Kar-wai", "movies": ["2046", "In the Mood for Love"], "newType": 3 } { "name": "Woody Allen", "movies": ["Manhattan", "Annie Hall"], "newType": 3 } |
Finally, the following triples are produced:
<http://example.org/director/3-Woody%20Allen> ex:directed "Manhattan". <http://example.org/director/3-Woody%20Allen> ex:directed "Annie Hall". <http://example.org/director/3-Wong%20Kar-wai> ex:directed "2046". <http://example.org/director/3-Wong%20Kar-wai> ex:directed "In the Mood for Love". |
R2RML defines a term map as a function that generates RDF terms from a logical table row.
A term map is either a subject map, predicate map, object map or graph map.
A term map must be exactly one of the following types:
R2RML treats all values from the input database as literals expressed in built-in data types. To deal with structured values such as collections or key-value associations, xR2RML term maps extend R2RML term maps so that structured values can be parsed, and data elements within structured values can be selected to build RDF terms. xR2RML extensions are described in this section.
R2RML properties rr:column and rr:template reference columns of a logical table. xR2RML not only references columns but also any data element within structured values. xR2RML relies on the rml:reference, that extends property rr:column. Its object is a column name (in the case of an RDB, CSV/TSV file, extensible column store, SPARQL result set, etc.), an XPath expression (in the case of XML data) and a JSONPath expression (in the case of JSON data). Furthermore, xR2RML introduces the possibility to reference data elements in data with mixed formats (§3.2.2.2). Thus, xR2RML extends property rml:reference with property xrr:reference. This leads to the following definition of an xR2RML term map. xR2RML changes to R2RML are highlighted.
A constant-valued term map is represented by a resource that has exactly one rr:constant property. A constant-valued term map always generates the same RDF term.
A column-valued term map has exactly one rr:column property. The value of the rr:column property is a valid column name.
A reference-valued term map has exactly one xrr:reference property. The value of the xrr:reference property is a valid reference to a data element, expressed using the syntax defined by the reference formulation (section 1.4). A reference-valued term map term map may have any number of xrr:pushDown properties (section 3.2.2.4) if and only if it has an xrr:nestedTermMap property.
A template-valued term map has exactly one rr:template property. The value of the rr:template property is a valid string template. A string template is a format string used to build strings from multiple components. It uses valid references to data elements by enclosing them in curly braces ("{" and "}"). Each reference is expressed using the syntax defined by the reference formulation (section 1.4).
RDF terms generated by a term map have a term type (rr:termType) that may be one of the three R2RML term types: rr:Literal, rr:BlankNode or rr:IRI.
xR2RML extends the rr:termType property with four new values, hereafter referred to as RDF collection or container term types:
Like in R2RML, xR2RML allows assigning language tags to literals. Language tags can be defined statically, but unlike R2RML they can also be defined dynamically using a path expression.
A term map or nested term map with an rr:Literal term type may have a specified language tag. It is represented statically by the rr:language property, or dynamically be the xrr:languageReference property. Both properties cause generated literals to be language-tagged plain literals.
rr:language and xrr:languageReference are not mutually exclusive. If only rr:language is present, the language tag is that given by the property. If xrr:languageReference is present, the language tag is the result of evaluating the path expression against the document of the current iteration. If the evaluation fails (no language tag is produced), then the language tag is that given by rr:language, if present.
If the evaluation of the path expression provided by xrr:languageReference fails, and there is no rr:language property, then the RDF term produced is a literal without language tag.
Example:
Input data | { "item": [ { "name":"football", "lang":"fr" }, { "name":"calcio", "lang":"it" }, { "name":"soccer" } ]} |
Term map | The first xrr:reference selects all elements of the "item" array. Then, the nested term map selects each "name" field and assigns it the language tag provided in the "lang" field.
[] rr:objectMap [ xrr:reference "$.item.*"; xrr:nestedTermMap [ xrr:reference "$.name"; rr:language "en"; xrr:languageReference "$.lang" ] ]; |
Generated RDF terms |
"football"@en "calcio"@it "soccer"@en |
Hierarchical data such as JSON or XML documents commonly have more than one level of nesting, resulting in tree-like values that may need to be parsed in depth, e.g. to nest RDF collections and containers (build an RDF collection of RDF collections).
An xR2RML term map may have an xrr:nestedTermMap property, whose range is the xrr:NestedTermMap class.
In a column-valued or reference-valued term map, the xrr:nestedTermMap property describes how to translate values produced by the rr:column or xrr:reference properties into RDF terms.
In a template-valued term map, the xrr:nestedTermMap property describes how to translate values produced by applying the template string to input values into RDF terms.
In a constant-valued term map, it is invalid to define a nested term map.
A nested term map may have the properties below:
A simple nested term map is a nested term map that has no xrr:reference nor rr:template property. A simple nested term map is used to qualify terms of an RDF collection or container generated by its parent term map or nested term map, i.e. assign them an optional term type, data type or language tag.
A reference-valued nested term map is a nested term map that has exactly one xrr:reference property.
A template-valued nested term map is a nested term map that has exactly one rr:template property.
xrr:nestedTermMap vs. rr:termType:
A nested term map N describes how to translate into RDF terms values produced by its parent P, P may be a term map or a nested term map.
If P has no rr:termType property, it simply returns values produced by N, therefore the term type of P is that of N.
If P has an rr:termType property with an RDF collection or container term type as object, then values produced by N will be assembled in an RDF collection or container.
Lastly, P should not have an rr:termType property with an R2RML term type (literal, blank node, IRI) or in other words, a nested term map cannot be used in the context of a term map or nested term map that has an R2RML term type (literal, IRI, blank node). Thus:
If a term map or nested term map has an xrr:nestedTermMap property, then it should have either no rr:termType property or an rr:termType property with an RDF collection or container term type. Formally:
A term map or nested term map with an RDF collection or container term type and no xrr:nestedTermMap property is assumed to have a default xrr:nestedTermMap property defined as follows:
xrr:nestedTermMap [ rr:termType rr:Literal ];
xrr:nestedTermMap [ rr:termType rr:IRI ];
Finally, properties rr:language, xrr:languageReference and rr:datatype apply when generating literals only:
A term map or nested term map may have an rr:language, xrr:languageReference or rr:datatype property only if its term type is rr:Literal (either stated by property rr:termType or inferred as a default value).
Nested term maps are exemplified in section 3.2.3.
The table below exemplifies the use of properties rr:column, xrr:reference and rr:template to reference simple data elements (i.e. with non-mixed data formats) from the logical source.
Logical source | Term map |
---|---|
Relational database: either rr:column or xrr:reference can be used to name a column. | [] rr:column "NAME". [] xrr:reference "NAME". [] rr:template "{NAME}". |
Extensible column store: properties xrr:reference and rr:template reference data elements by column names. | [] xrr:reference "NAME". [] rr:template "{NAME}". |
XML database supporting: properties xrr:reference and rr:template reference data elements by XPath expressions. | [] xrr:reference "//name". [] rr:template "{//name }". |
NoSQL document store: xrr:reference and rr:template reference data elements using a valid JSONPath expression. | [] xrr:reference "$.name". [] rr:template "{$.name }". |
RDF graph store accessed using a SPARQL SELECT query: xrr:reference and rr:template reference data elements by name of variable returned in the SPARQL result set. | [] xrr:reference "?name". [] rr:template "{?name }". |
Remark: If a term map references a structured value but does not parse it using a nested term map, then generated RDF terms are string literals containing a simple serialization of structured values. Example:
Input data | { "person": { "FirstName":"John", "LastName":"Smith" } } |
Term map | [] rr:objectMap [ xrr:reference "$.person"; ]; |
Generated RDF term | The structured value matching the JSONPath expression "$.person" is returned as a string literal in quotes:
'{ "FirstName":"John", "LastName":"Smith" }' |
In some use cases, databases are commonly used to store values written in a data format that they cannot interpret. For instance, an application designer may choose to embed JSON, CSV, or XML values in the cells of a relational table, for performance concerns or application design constraints.
To reference data elements within such mixed contents, xR2RML allows a term map to reference data elements with mixed-syntax paths:
Properties xrr:reference and rr:template may use mixed-syntax paths to reference data elements across data in different formats. A mixed-syntax path consists of the concatenation of several path expressions separated by the slash '/' character. Each individual path is enclosed in a syntax path constructor naming the path syntax explicitly. Existing constructors are:
In expressions enclosed in a syntax path constructor, special characters '/', '(', ')', '{' and '}' must be escaped with a '\'. Since, in Turtle syntax, the '\' character itself must be escaped with an additional '\', special characters are escaped with '\\'.
Example:
Input data | Relational table with one column:
|
||
Logical source definition and Term map | [] xrr:logicalSource [ … ]; ... rr:objectMap [ xrr:reference "Column(Name)/JSONPath($.FirstName)"; rr:language "en"; ]; |
||
Generated RDF term | "John"@en |
From the example above, it can be noticed that (i) the leftmost syntax path constructor (Column) is consistent with the reference formulation (section 1.4), and (ii) data elements referenced by mixed-syntax path "Column(Name)/JSONPath($.FirstName)" are formatted in JSON, corresponding to the rightmost syntax path constructor. More generally:
The leftmost syntax path constructor of a mixed-syntax path must be consistent with the reference formulation (section 1.4).
The format of data retrieved by a mixed-syntax path is the format of the rightmost syntax path constructor.
In a row-based logical source, a column reference returns exactly one scalar value per triples map iteration step: the value of the cell identified by "column name" in the current row. Thus, an R2RML term map generates zero or one RDF term during each iteration step, ultimately a triples map generates zero or one triple during each iteration step.
Due to the tree-like nature or JSON and XML data formats, JSONPath and XPath expressions allow addressing not only literals but also structured values. Thus, using the xrr:reference or rr:template properties with a JSONPath or XPath expression may return multiple values during each triples map iteration step. Hence the introduction of the term map iteration.
A term map iteration is a process that occurs in a term map during each triples-map iteration step. Thus, a reference-valued or template-valued term map generates zero to any number of RDF terms during each triples-map iteration step.
Examples:
Input data retrieved in one triples-map iteration step | { "FirstNames": ["John", "Albert"], "LastName": "Smith" } |
<person> <FirstNames> <item>John</item> <item>Albert</item> </FirstNames> <LastName>Smith</LastName> </person> |
Term map | [] rr:objectMap [ xrr:reference "$.FirstNames.*"; ]; |
[] rr:objectMap [ xrr:reference "/person/FirstNames/item"; ]; |
Generated RDF terms | "John" |
"John" |
The term map iteration applies identically in the context of mixed-syntax paths. Example:
Input data | <person> <name>John Smith</name> <items>[1,2,3]</items> </person> XML element "items" contains a value expressed as a JSON array. |
Term map | [] xrr:logicalSource [ ... ] ... rr:objectMap [ xrr:reference "XPath(\\/person\\/items)/JSONPath($.*)"; rr:datatype xsd:integer; ] The last expression of the mixed-syntax path, "JSONPath($.*)", indicates that (i) value "[1,2,3]" is formatted in JSON syntax, and (ii) it must be parsed as such using the "$.*" JSONPath expression. |
Generated RDF terms | 1^^xsd:integer 2^^xsd:integer 3^^xsd:integer |
A template-valued term map may reference several data elements from the logical source, captured by curly braces ('{' and '}'). If at least one of the data elements referenced in a template string produces several terms, then the following applies:
A template-valued term map produces RDF terms by performing a Cartesian product between all values produced by all data elements referenced in the template.
Example:
Input data | { "FirstNames": '["John", "Albert"]', "LastName": "Smith" } |
Term map | [] xrr:logicalSource [ … ]; rr:subjectMap [ rr:template "http://example.org/{$.FirstNames.*}/{$.LastName}"; ]; |
Generated RDF terms | The template performs a Cartesian product between "Smith" and ["John", "Albert"], resulting in two terms:
<http://example.org/John/Smith> <http://example.org/Albert/Smith> |
Finally, below we define the behavior of a triples map in which one or several term maps generate multiple RDF terms during a single triples map iteration step:
During each iteration of an xR2RML triples map, triples are generated as the Cartesian product between RDF terms produced by the subject map and each predicate-object map. Predicate-object couples result of the Cartesian product between RDF terms produced by each predicate and object map.
Note that a graph map may also produce multiple terms, in which case triples are produced simultaneously in several target graphs.
xR2RML vs. RML: RML makes the restriction that a subject map should return zero or one value during each triples map iteration. In the case of xR2RML, we make no such restriction so that the Cartesian product be possibly applied between multiple subjects, multiple predicate-object couples, and multiple graph IRIs. Besides, RML does not describe how a template with several multi-valued references is processed. xR2RML states that the Cartesian product applies equally in this case, whether the template be used as a subject, predicate, object or graph map.
In the example below, during one triples map iteration step, the subject map produces two RDF terms <http://example.org/company/Dell> and <http://example.org/company/Asus>, while the object map produces two literals "Laptop" and "Desktop". A Cartesian product between the two subjects and the two objects results in the production of four triples:
Input data: one row retrieved from a relational table, values are formatted in JSON in column “cos”, and XML in column “products” |
|
||||
Mapping graph | [] xrr:logicalSource [ ... ]; rr:subjectMap [ rr:template "http://example.org/{Column(cos)/JSONPath($.*)}"; ]; rr:predicateObjectMap [ rr:predicate ex:produces; rr:objectMap [ xrr:reference "Column(products)/XPath(\\/list\\/*)"; ]; ]; |
||||
Generated triples | <http://example.org/Dell> ex:produces "Laptop". <http://example.org/Dell> ex:produces "Desktop". <http://example.org/Asus> ex:produces "Laptop". <http://example.org/Asus> ex:produces "Desktop". |
As seen in the previous section, a term map iteration may occur in the context of hierarchical data formats. Within a term map iteration, it may be needed to access data elements higher in the hierarchical documents, such as JSON fields that are outside of the iteration and thus no longer available. To deal with such cases, a reference-valued term map or a reference-valued nested term map may have any number of xrr:pushDown properties, whose semantics is that defined in the context of a logical source (section 3.1.3).
Example:
Input data | { "id": 5, "FirstNames": '["John", "Albert"]', "LastName": "Smith" } |
Term map | rr:objectMap [ rr:reference " $.FirstNames"; xrr:pushDown [ xrr:reference "$.id"; xrr:as "personId" ]; xrr:nestedTermMap [ rr:template "Person {$.personId}: {$.*}"; rr:termType xrr:Literal; ] ]; |
Generated RDF terms | "Person 5: John" "Person 5: Albert" |
A term map with an RDF collection or container term type generates one RDF term during each triples map iteration step. The elements of the collection or container are the RDF terms produced by the term map, whether using property rr:column, xrr:reference or rr:template.
In the example below, the triples map generates one triple per iteration step, the object of this triple is an RDF bag (itself consisting of several triples):
Input data: JSON document retrieved in a single iteration step | <company "name"="Dell"> <products> <product>Laptop</product> <product>Desktop</product> </products> </company> |
Mapping graph |
[] xrr:logicalSource [ ... ];
rr:subjectMap [
rr:template "http://example.org/{/company/@name}";
];
rr:predicateObjectMap [
rr:predicate ex:builds;
rr:objectMap [
xrr:reference "//company/products/*";
rr:termType xrr:RdfBag;
];
]; |
Generated triples |
<http://example.org/Dell> ex:builds [
a rdf:Bag;
rdf:_1 "Laptop";
rdf:_2 "Desktop" .
]. |
Unlike RDF terms of type IRI or blank node, RDF terms of type RDF collection or container cannot be used as subject or predicate of an RDF triple, nor as a graph IRI. Consequently:
A term map with term type xrr:RdfList, xrr:RdfSeq, xrr:RdfBag or xrr:RdfAlt is an object map (hence it cannot be a subject map, predicate map nor graph map). Formally:
A nested term map (property xrr:nestedTermMap) can be used to specify a term type, language tag or data type of members of an RDF collection or container. The example below illustrates the usage of a nested term map to generate an RDF collection of IRIs (first example), and an RDF sequence of data-typed literals (second example):
Input data | { "key1": ["url1", "url2"] } |
{ "key1": [10, 20] } |
Term map |
[] rr:objectMap [
xrr:reference "$.key1.*";
rr:termType xrr:RdfList;
xrr:nestedTermMap [
rr:termType rr:IRI;
];
]; |
[] rr:objectMap [
xrr:reference "$.key1.*";
rr:termType xrr:RdfSeq;
xrr:nestedTermMap [
rr:termType rr:Literal;
rr:datatype xsd:integer;
];
]; |
Generated RDF terms | In Turtle abbreviated notation: (<url1> <url2>) |
[ a rdf:Seq; rdf:_1 10^^xsd:integer; rdf:_2 20^^xsd:integer. ]; |
In a template-valued term map, the xrr:nestedTermMap property applies to values resulting from the application of the template string to the input values. In the first example below, term type rr:IRI applies to the result of the template string. The same principle applies in the second example with term type rr:Literal and datatype xsd:string.
Input data | { "FirstNames": '["John", "Albert"]', "LastName": "Smith" } |
{ "FirstNames": '["John", "Albert"]', "LastName": "Smith" } |
Term map | [] rr:objectMap [ rr:template "http://example.org/ {$.FirstNames.*}/{$.LastName}"; rr:termType xrr:RdfList; xrr:nestedTermMap [ rr:termType rr:IRI; ]; ]; |
[] rr:objectMap [ rr:template "{$.FirstNames.*} {$.LastName}"; rr:termType xrr:RdfList; xrr:nestedTermMap [ rr:termType rr:Literal; rr:datatype xsd:string; ]; ]; |
Generated RDF terms | ( <http://example.org/John/Smith> <http://example.org/Albert/Smith> ) |
( "John Smith"^^xsd:string "Albert Smith"^^xsd:string ) |
The example below illustrates the use of a nested term map to (i) parse nested structured values ("teams" are collections of "team" elements, which are collections of "member" elements) and (ii) translate those nested structured values into RDF terms of class rdf:List.
Input data | <teams> <team> <member>John</member> <member>Paul</member> </team> <team> <member>Cathy</member> <member>Ed</member> </team> </teams> |
Term map |
[] rr:objectMap [
xrr:reference "/teams/team";
xrr:nestedTermMap [
xrr:reference "/member";
rr:termType xrr:RdfList;
];
];
The first xrr:reference property ("/teams/team") selects "team" elements from the XML input, each "team" element being the root of an XML tree whose descendants are "member" elements. The second xrr:reference property ("/member"), within the xrr:nestedTermMap property, is evaluated sequentially against the results of the parent reference expression. Thus, the xrr:RdfList term type successively applies to "member" elements of the first team, then to "member" elements of the second team. Finally the term map generates two RDF collections, one per team element. |
Generated RDF terms | ("John" "Paul") ("Cathy" "Ed") Note: the object map has no rr:termType property, therefore its term type is that of its nested term type, that is xrr:RdfList. |
The subsequent example generates one RDF sequence of nested RDF collections. Elements of the inner RDF collections are typed as rr:Literal and assigned a language tag using a second nested xrr:nestedTermMap property.
Input data | { "teams": [ ["John", "Paul"] , ["Cathy", "Ed"] ] } |
Term map | [] rr:objectMap [ xrr:reference "$.teams.*"; rr:termType xrr:RdfSeq; # represent "teams" as an rdf:Seq # Describe the elements of the RDF sequence xrr:nestedTermMap [ rr:template "Player {$.*}"; rr:termType xrr:RdfList; # represent each team as an rdf:List # Type members of each team as literals with language "en" # using a simple nested term map xrr:nestedTermMap [ rr:termType rr:Literal; rr:language "en"; ]; ]; ]; |
Generated RDF terms | [ a rdf:Seq; rdf:_1 ("Player John"@en "Player Paul"@en); rdf:_2 ("Player Cathy"@en "Player Ed"@en); ] |
As already mentioned, in a template-valued term map, property xrr:nestedTermMap applies to values resulting from the application of the template string to input values. Thus, defining a nested term map in a template-valued term map suggests that the template produces a valid expression with regards to the current data format, that, in turn, is interpreted against a path expression provided by an xrr:reference or rr:template property.
For instance, applying the template string:
'\{ "first": "{FirstNames}", "last": "{LastName}" \}'
would produce a string formatted as a JSON dictionary, like:
{ "first": "John", "last": "Smith" }
This use case is illustrated in the example below:
Input data | { "FirstNames": '["John", "Albert"]', "LastName": "Smith" } |
Term map |
[] rr:objectMap [
rr:template '\{ "first": "{$.FirstNames.*}", "last": "{$.LastName}" \}';
xrr:nestedTermMap [
xrr:reference "$.*";
rr:termType xrr:RdfList;
];
]; |
Generated RDF terms | ( "John" "Smith" ) ( "Albert" "Smith" ) Two values are generated by applying the template string, those values are formatted as JSON arrays: { "first": "John", "last": "Smith" } { "first": "Albert", "last": "Smith" } The xrr:nestedTermMap property instructs to parse those values using the JSONPath expression "$.*" (property xrr:reference), and generates an RDF collection (rdf:List) for each of them. |
Note: this use case may seem rather awkward and probably of little use, but insofar as it is consistent with the xR2RML language definition, we think it should be considered as valid.
The flexibility offered by nested term maps allows the same mapping to be written using various strategies: path expressions of properties xrr:reference and rr:template can be split in several levels of term map and nested term map.
For instance, both term maps below produce equivalent results. In the first case (left), the JSONPath expression ($.teams.*.*) retrieves all team members at once. In the second case (right), teams are retrieved first ($.teams.*), then the xrr:nestedTermMap property runs a second JSONPath evaluation to retrieve and datatype team members.
Input data | { "teams": [ ["John", "Paul"], ["Cathy", "Ed"] ] } |
|
Term maps |
[] xrr:logicalSource [ … ];
rr:objectMap [
xrr:reference "$.teams.*.*";
rr:datatype xsd:string;
]; |
[] xrr:logicalSource [ … ]; rr:objectMap [ xrr:reference "$.teams.*"; xrr:nestedTermMap [ xrr:reference "$.*"; rr:datatype xsd:string; ]; ]; |
Generated RDF terms | "John"^^xsd:string "Paul"^^xsd:string "Cathy"^^xsd:string "Ed"^^xsd:string |
It is likely that the first case will be more efficient as only one JSONPath evaluation is performed, whereas in the second case two JSONPath evaluations are performed in sequence.
Similarly, the example below shows how a mixed-syntax path can be split into a term map and a nested term map:
[] xrr:logicalSource [ … ]; rr:objectMap [ xrr:reference "Column(col)/XPath(\\/person\\/name)"; rr:datatype xsd:string; ]; |
[] xrr:logicalSource [ … ]; rr:objectMap [ rr:column "col"; xrr:nestedTermMap [ xrr:reference "XPath(\\/person\\/name)"; rr:datatype xsd:string; ]; ]; |
Both mappings are likely to be equally efficient, as both evaluations (column selection and XPath expression evaluation) need to be done anyway.
This section is an adaptation of section 7.4 of the R2RML specification). xR2RML additions to R2RML are highlighted.
If the term map has an optional rr:termType property then its term type is the value of that property. The value MUST be one of the following options:
If the term map does not have an rr:termType property, then its term type is:
A corollary of this definition is that the xrr:nestedTermMap property may be used in a subject map, predicate map or graph map only if it produces IRIs. Consequently:
A term map with an xrr:nestedTermMap property may be a subject map or graph map only if (i) it does not have an rr:termType property and (ii) its nested term map has an rr:termType property with object rr:IRI or rr:BlankNode.
A term map with an xrr:nestedTermMap property may be a predicate map only if (i) it does not have an rr:termType property and (ii) its nested term map property has an rr:termType property with object rr:IRI.
The following definitions are an adaptation of R2RML specification section 8. xR2RML additions to R2RML are highlighted.
A referencing object map allows using the subjects of another triples map as the objects generated by a predicate-object map. Since both triples maps may be based on different logical sources, this may require a join between the logical sources.
A referencing object map resource has exactly one rr:parentTriplesMap property (its value is a triples map), and optional rr:joinCondition properties. A join condition has exactly one rr:child property and one rr:parent property. The rr:child property references the join condition's child data element, the rr:parent property references the join condition's parent data element. Data element references are valid path expressions with regards to the reference formulation (section 1.4), possibly using mixed-syntax paths.
A referencing object map may have an rr:termType property with an RDF collection or container term type (see further details in §3.3.2).
The child query of a referencing object map is the query or source name of the logical source of the triples map containing the referencing object map.
The parent query of a referencing object map is the query or source name of the logical source of the referencing object map's parent triples map.
Properties rr:child and rr:parent use valid path expressions to reference data elements. As described in §3.2.2.3, such path expressions may produce multiple terms. Consequently, the equivalent joint query of a referencing object map must take into account the fact that child and parent references be multi-valued. More precisely, a join between two multi-valued references should be satisfied if at least one data element of the first reference matches one data element of the second reference.
The joint query of a referencing object map is defined below using SQL syntax (SELECT... FROM... AS... WHERE) and first order logic for the description of WHERE conditions:
If a referencing object map has no join condition, its joint query is:
If a referencing object map has at least one join condition, its joint query is:
where {child-refn} and {parent-refn} are the child reference and parent reference of the nth join condition, and eval(source, {ref}) is the result of the evaluation of expression "{ref}" on data "source".
Note: when applied to a relational database, in which child and parent references are single-valued, this definition can be simplified into the R2RML joint query definition:
The relational database example below models the relation between medical doctors and the studies for which they are investigators. Column "Doctor.studies" contains JSON arrays of which elements are references (similar to foreign keys) to column "Study.study_id".
Input data | Table Study
Table Doctor
|
||||||||||||||||||||
Mapping graph |
<#Study>
rr:logicalTable [ rr:tableName "Study" ];
rr:subjectMap [
rr:template "http://example.org/study/{study_name}";
].
<#Doctor>
rr:logicalTable [ rr:tableName "Doctor" ];
rr:subjectMap [
rr:template "http://example.org/doc/{doc_name}";
];
rr:predicateObjectMap [
rr:predicate ex:investigatorOf;
rr:objectMap [
rr:parentTriplesMap <#Study>;
rr:joinCondition [
rr:parent "study_id";
rr:child "Column(studies)/JSONPath($.*)";
];
];
].
The rr:child property uses a mixed-syntax path specifying that the data retrieved is formatted in JSON, and that each element of this structured value is considered in the join operation. |
||||||||||||||||||||
Generated triples | <http://example.org/doc/D1> ex:investigatorOf <http://example.org/study/study1> . <http://example.org/doc/D1> ex:investigatorOf <http://example.org/study/study2> . <http://example.org/doc/D2> ex:investigatorOf <http://example.org/study/study3> . According to the equivalent joint query definition, the joint query is as follows ("child" and "parent" notations have been removed for readability): SELECT * FROM Doctor, Study
WHERE ∃c ∈ eval(Doctor, Column(studies)/JSONPath($.*)), ∃p ∈ Study.study_id, c = p where eval(Doctor, Column(studies)/JSONPath($.*)) represents the evaluation of mixed-syntax path "Column(studies)/JSONPath($.*)" on table Doctor. Since Study.study_id is single-valued, we can rewrite the query as: SELECT * FROM Doctor, Study
WHERE ∃ c ∈ Doctor.Column(studies)/JSONPath($.*), c = Studies.study_id The join query results in this table:
|
In R2RML, referencing object maps do not have an rr:termType property as they should only produce RDF terms of type rr:IRI. In xR2RML however, the result of a joint query may be translated into an RDF collection or container using property rr:termType. The rr:termType has a specific semantics here: it groups joint query results by subjects of the generated triples, i.e. by child reference, and renders all objects in the same grouping as an RDF collection or container.
If a referencing object map has no rr:termType property, then its term type is rr:IRI (compliant with the R2RML definition).
A referencing object map may have an rr:termType property with an RDF collection or container term type (xrr:RdfList, xrr:RdfSeq, xrr:RdfBag or xrr:RdfAlt). In that case, members of the collection or container are necessarily of type rr:IRI.
In a referencing object map with an RDF collection or container term type, results of the joint query pertaining to the same subject term are grouped together. The objects of the triples map are grouped in a single object of type RDF collection or container, as instructed by the rr:termType property.
In the example below the referencing object map has an rr:termType property with value xrr:RdfList:
Input data | JSON documents retrieved by the query in the <#Study> triples map: { "study_id":1, "study_name":"study1" } { "study_id":2, "study_name":"study2"} { "study_id":3, "study_name":"study3"} JSON documents retrieved by the query in the <#Doctor> triples map: { "doc_name":"D1", "studies": [1,2] } { "doc_name":"D2", "studies": [2,3] } |
Mapping graph | Below, queries to retrieve Studies and Doctors are referred to as <Study query> and <Doctor query>.
<#Doctor> xrr:logicalSource [ xrr:query "<Doctor query>"; ]; rr:subjectMap [ rr:template "http://example.org/doc/{$.doc_name}"; ]. <#Study> xrr:logicalSource [ xrr:query "<Study query>"; ]; rr:subjectMap [ rr:template "http://example.org/study/{$.study_name}"; ]; rr:predicateObjectMap [ rr:predicate ex:hasInvestigators; rr:objectMap [ rr:parentTriplesMap <#Doctor>; rr:joinCondition [ rr:child "$.study_id"; rr:parent "$.studies.*"; ]; rr:termType xrr:RdfList; ]; ]. |
Generated RDF triples |
<http://example.org/study/study1> ex:hasInvestigators ( <http://example.org/doc/D1> ). <http://example.org/study/study2> ex:hasInvestigators ( <http://example.org/doc/D1> <http://example.org/doc/D2> ). <http://example.org/study/study3> ex:hasInvestigators ( <http://example.org/doc/D2> ). Explanation: according to the equivalent joint query definition, the joint query is as follows:
SELECT * FROM (<Study query>) as child, (<Doctor query>) as parent
WHERE ∃ p ∈ eval(parent, $.studies.*), p = eval(child, $.study_id) where eval(parent, $.studies.*) represents the evaluation of path "$.studies.*" on the result of the parent query, and eval(child, $.study_id) represents the evaluation of path "$.study_id" on the result of the child query. The equivalent joint query results in the following documents: { "study_id":1, "study_name":"study1", "doc_name":"D1", "studies": [1,2] } { "study_id":2, "study_name":"study2", "doc_name":"D1", "studies": [1,2] } { "study_id":2, "study_name":"study2", "doc_name":"D2", "studies": [2,3] } { "study_id":3, "study_name":"study3", "doc_name":"D2", "studies": [2,3] } Then, term type xrr:RdfList instructs to group results pertaining to the same subject, i.e. by "study_id". |
An interesting consequence of using the rr:termType in a referencing object map is the ability, in the case of a relational database with standard SQL values, to build an RDF collection or container reflecting a one-to-many relation. In the example below, foreign key Study.doctor relates each study to its investigator in a many-to-one relation (several studies may have the same investigator). Considered the other way round, it can be seen as a one-to-many relation (one doctor investigates several studies). The mapping graph describes the generation of each doctor along with the list of studies he/she investigates.
Input data | Table Study
Table Doctor
|
||||||||||||||||||||
Mapping graph |
<#Study>
rr:logicalTable [ rr:tableName "Study" ];
rr:subjectMap [
rr:template "http://example.org/study/{study_name}";
].
<#Doctor>
rr:logicalTable [ rr:tableName "Doctor" ];
rr:subjectMap [
rr:template "http://example.org/doc/{doc_name}";
].
rr:predicateObjectMap [
rr:predicate ex:investigatesStudies;
rr:objectMap [
rr:parentTriplesMap <#Study>;
rr:joinCondition [
rr:child "doc_id";
rr:parent "doctor;
];
rr:termType xrr:RdfList;
];
]. |
||||||||||||||||||||
Generated RDF triples |
<http://example.org/doc/D1> ex: investigatesStudies (<http://example.org/study/study1> <http://example.org/study/study2>) . <http://example.org/doc/D2> ex: investigatesStudies ( <http://example.org/study/study3> ) . The equivalent joint query results in this table:
Results are grouped by subjet, i.e. by column "doc_name" to generate RDF lists. |
Function sha1() can be used in the context of a template-valued term map (property rr:template) to calculate the SHA1 digest of components of the data source, where each reference to a data element is enclosed in curly braces ("{" and "}"). Templating still works inside the parentheses of the sha1() function.
A typical use case is to build unique resource IRIs using multiple data elements while keeping those elements obfuscated in the IRI. Example:
Input data | { "name":"John", "birthdate":"1996-05-23" } |
Mapping graph |
<#HashSubTriplesMap>
rr:subjectMap [ rr:template "http://example.org/person/sha1({$.name}_{$.birthdate})" ];
rr:predicateObjectMap [
rr:predicate schema:name;
rr:objectMap [ xrr:reference "$.name" ];
]. |
RDF triples produced | <http://example.org/person/1f83650790e2cee21218078f96d9ac88dbdc5621> schema:name "John". |