Skip to content

Commit a4fad10

Browse files
committed
Docs updates for 4.4.0.2
1 parent b2f15a2 commit a4fad10

17 files changed

+41
-29
lines changed

docs/modules/ROOT/examples/documentation.csv

Lines changed: 19 additions & 9 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
¦signature
2-
¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?) :: (STRING?)
2+
¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, sspo = null :: LIST? OF STRING?) :: (STRING?)
33
¦n10s.rdf.fullUriFromShortForm(short :: STRING?) :: (STRING?)
44
¦n10s.rdf.getDataType(literal :: ANY?) :: (STRING?)
55
¦n10s.rdf.getIRILocalName(url :: STRING?) :: (STRING?)
@@ -8,4 +8,5 @@
88
¦n10s.rdf.getLangValue(lang :: STRING?, values :: ANY?) :: (STRING?)
99
¦n10s.rdf.getValue(literal :: STRING?) :: (STRING?)
1010
¦n10s.rdf.hasLangTag(lang :: STRING?, value :: ANY?) :: (BOOLEAN?)
11+
¦n10s.rdf.isIRI(str :: STRING?) :: (BOOLEAN?)
1112
¦n10s.rdf.shortFormFromFullUri(uri :: STRING?) :: (STRING?)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦signature
2-
¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?) :: (STRING?)
2+
¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, sspo = null :: LIST? OF STRING?) :: (STRING?)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦type¦qualified name¦signature¦description
2-
¦function¦n10s.rdf.collect¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?) :: (STRING?)¦n10s.rdf.collect(subject,predicate,object,isLiteral,literalType,literalLang) - collects a set of triples as returned by n10s.rdf.export.* or n10s.rdf.stream.* and returns them serialised as N-triples
2+
¦function¦n10s.rdf.collect¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, sspo = null :: LIST? OF STRING?) :: (STRING?)¦n10s.rdf.collect(subject,predicate,object,isLiteral,literalType,literalLang) - collects a set of triples as returned by n10s.rdf.export.* or n10s.rdf.stream.* and returns them serialised as N-triples
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
¦type¦qualified name¦signature¦description
2-
¦function¦n10s.rdf.collect¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?) :: (STRING?)¦n10s.rdf.collect(subject,predicate,object,isLiteral,literalType,literalLang) - collects a set of triples as returned by n10s.rdf.export.* or n10s.rdf.stream.* and returns them serialised as N-triples
2+
¦function¦n10s.rdf.collect¦n10s.rdf.collect(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, sspo = null :: LIST? OF STRING?) :: (STRING?)¦n10s.rdf.collect(subject,predicate,object,isLiteral,literalType,literalLang) - collects a set of triples as returned by n10s.rdf.export.* or n10s.rdf.stream.* and returns them serialised as N-triples
33
¦function¦n10s.rdf.fullUriFromShortForm¦n10s.rdf.fullUriFromShortForm(short :: STRING?) :: (STRING?)¦Returns the expanded (full) IRI given a shortened one created in the load process with semantics.importRDF
44
¦function¦n10s.rdf.getDataType¦n10s.rdf.getDataType(literal :: ANY?) :: (STRING?)¦Returns the XMLSchema or custom datatype of a property when present
55
¦function¦n10s.rdf.getIRILocalName¦n10s.rdf.getIRILocalName(url :: STRING?) :: (STRING?)¦Returns the local part of an IRI
@@ -8,4 +8,5 @@
88
¦function¦n10s.rdf.getLangValue¦n10s.rdf.getLangValue(lang :: STRING?, values :: ANY?) :: (STRING?)¦Returns the first value with the language tag passed as first argument or null if there's not a value for the provided tag
99
¦function¦n10s.rdf.getValue¦n10s.rdf.getValue(literal :: STRING?) :: (STRING?)¦Returns the value of a datatype of a property after stripping out the datatype information when present
1010
¦function¦n10s.rdf.hasLangTag¦n10s.rdf.hasLangTag(lang :: STRING?, value :: ANY?) :: (BOOLEAN?)¦Returns false if the value is not a string or if the string is not tagged with the given language tag
11+
¦function¦n10s.rdf.isIRI¦n10s.rdf.isIRI(str :: STRING?) :: (BOOLEAN?)¦Returns the true if string is a valid IRI
1112
¦function¦n10s.rdf.shortFormFromFullUri¦n10s.rdf.shortFormFromFullUri(uri :: STRING?) :: (STRING?)¦Returns the shortened version of an IRI using the existing namespace definitions
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
¦signature
2-
¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
3-
¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
2+
¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
3+
¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
¦type¦qualified name¦signature¦description
2-
¦procedure¦n10s.rdf.export.cypher¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Executes a cypher query returning graph elements (nodes,rels) and serialises the output as triples.
3-
¦procedure¦n10s.rdf.export.spo¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Returns the triples matching the spo pattern passed as parameter.
2+
¦procedure¦n10s.rdf.export.cypher¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Executes a cypher query returning graph elements (nodes,rels) and serialises the output as triples.
3+
¦procedure¦n10s.rdf.export.spo¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Returns the triples matching the spo pattern passed as parameter.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦signature
2-
¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
2+
¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦type¦qualified name¦signature¦description
2-
¦procedure¦n10s.rdf.export.cypher¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Executes a cypher query returning graph elements (nodes,rels) and serialises the output as triples.
2+
¦procedure¦n10s.rdf.export.cypher¦n10s.rdf.export.cypher(cypher :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Executes a cypher query returning graph elements (nodes,rels) and serialises the output as triples.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦signature
2-
¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
2+
¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦type¦qualified name¦signature¦description
2-
¦procedure¦n10s.rdf.export.spo¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Returns the triples matching the spo pattern passed as parameter.
2+
¦procedure¦n10s.rdf.export.spo¦n10s.rdf.export.spo(subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral = false :: BOOLEAN?, literalType = http://www.w3.org/2001/XMLSchema#string :: STRING?, literalLang = null :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Returns the triples matching the spo pattern passed as parameter.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
¦signature
2-
¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
3-
¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
2+
¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
3+
¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
¦type¦qualified name¦signature¦description
2-
¦procedure¦n10s.rdf.stream.fetch¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Parses RDF and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.
3-
¦procedure¦n10s.rdf.stream.inline¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Parses RDF passed as a string and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.
2+
¦procedure¦n10s.rdf.stream.fetch¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Parses RDF and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.
3+
¦procedure¦n10s.rdf.stream.inline¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Parses RDF passed as a string and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦signature
2-
¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
2+
¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦type¦qualified name¦signature¦description
2-
¦procedure¦n10s.rdf.stream.fetch¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Parses RDF and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.
2+
¦procedure¦n10s.rdf.stream.fetch¦n10s.rdf.stream.fetch(url :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Parses RDF and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦signature
2-
¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)
2+
¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
¦type¦qualified name¦signature¦description
2-
¦procedure¦n10s.rdf.stream.inline¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?)¦Parses RDF passed as a string and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.
2+
¦procedure¦n10s.rdf.stream.inline¦n10s.rdf.stream.inline(rdf :: STRING?, format :: STRING?, params = {} :: MAP?) :: (subject :: STRING?, predicate :: STRING?, object :: STRING?, isLiteral :: BOOLEAN?, literalType :: STRING?, literalLang :: STRING?, subjectSPO :: LIST? OF STRING?)¦Parses RDF passed as a string and streams each triple as a record with <S,P,O> along with datatype and language tag for Literal values. No writing to the DB.

0 commit comments

Comments
 (0)