FunctionExpressionsBuilder
Description
Builder for function expressions.
Methods
bound( variable: string | Variable ): ExpressionCreates an Expression that returns true if variable is bound to a value.
See https://www.w3.org/TR/sparql11-query/#func-bound for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | Variable | Variable to evaluate if it's associated to a value. |
if( condition: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, consequent: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, alternative: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that evaluates condition and then returns the consequent value if the condition is true, otherwise it returns alternative.
See https://www.w3.org/TR/sparql11-query/#func-if for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate for its effective boolean value. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to return its value when the condition is evaluated to | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to returns its value when the condition is evaluated to |
coalesce( ...expressions: (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] ): ExpressionCreates an Expression that returns the value of the first expression from the expressions list that evaluates without error.
See https://www.w3.org/TR/sparql11-query/#func-coalesce for more information.
Parameters
| Name | Type | Description |
|---|---|---|
Expressions to be evaluated for the non-raising error one. | ||
| (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] |
exists( ...patterns: Pattern<PatternToken>[] ): ExpressionCreates an Expression that returns true if patterns matches the data set, or false otherwise.
See https://www.w3.org/TR/sparql11-query/#func-filter-exists for more information.
Parameters
| Name | Type | Description |
|---|---|---|
Patterns to evaluate if matches the data set. | ||
| Pattern<PatternToken>[] |
notExists( ...patterns: Pattern<PatternToken>[] ): ExpressionCreates an Expression that returns false if patterns matches the data set, or true otherwise.
See https://www.w3.org/TR/sparql11-query/#func-filter-exists for more information.
Parameters
| Name | Type | Description |
|---|---|---|
Patterns to evaluate if not matches the data set. | ||
| Pattern<PatternToken>[] |
sameTerm( term1: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, term2: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns true if term1 and term2 are the same RDF term, or false otherwise.
See https://www.w3.org/TR/sparql11-query/#func-sameTerm for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value against term2. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value against term1. |
isIRI( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns true if term is an IRI. Returns false otherwise.
See https://www.w3.org/TR/sparql11-query/#func-isIRI for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value. |
isURI( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns true if term is an URI. Returns false otherwise.
See https://www.w3.org/TR/sparql11-query/#func-isIRI for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value. |
isBlank( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns true if term is a blank node. Returns false otherwise.
See https://www.w3.org/TR/sparql11-query/#func-isBlank for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value. |
isLiteral( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns true if term is a literal. Returns false otherwise.
See https://www.w3.org/TR/sparql11-query/#func-isLiteral for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value. |
isNumeric( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns true if term is a numeric value. Returns false otherwise.
See https://www.w3.org/TR/sparql11-query/#func-isNumeric for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value. |
str( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the string representation of term.
See https://www.w3.org/TR/sparql11-query/#func-str for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value. |
lang( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the language tag of literal.
See https://www.w3.org/TR/sparql11-query/#func-lang for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value lang. |
datatype( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the datatype IRI of literal.
See https://www.w3.org/TR/sparql11-query/#func-datatype for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to evaluate its value lang. |
iri( argument: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that constructs an IRI by resolving argument.
See https://www.w3.org/TR/sparql11-query/#func-iri for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to construct an IRI with its value. |
uri( argument: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that constructs a URI by resolving argument.
See https://www.w3.org/TR/sparql11-query/#func-iri for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to construct a URI with its value. |
bnode( literal?: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that constructs a blank node that is distinct from all blank nodes in the data set. If literal is provided, it will be used as base for the blank node label.
See https://www.w3.org/TR/sparql11-query/#func-bnode for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Optional expression to use its value for the blank node creation. |
strDT( lexicalForm: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, dataType: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that constructs an RDF literal with lexicalForm and dataType specified.
See https://www.w3.org/TR/sparql11-query/#func-strdt for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expresion with a string value to use as the lexical form of the literal. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expresion with an IRI value to use as the datatype of the literal. |
strLang( lexicalForm: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, languageTag: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that constructs an RDF literal with the lexicalForm and languageTag specified.
See https://www.w3.org/TR/sparql11-query/#func-strlang for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expresion with a string value to use as the lexical form of the literal. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expresion with a string value to use as the language tag of the literal. |
uuid(): ExpressionCreates an Expression that returns an IRI from the UUID URN scheme.
See https://www.w3.org/TR/sparql11-query/#func-uuid for more information.
strUUID(): ExpressionCreates an Expression that returns a string with an UUID.
See https://www.w3.org/TR/sparql11-query/#func-struuid for more information.
strLen( str: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the number of characters of the str expression value.
See https://www.w3.org/TR/sparql11-query/#func-strlen for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to count the characters of its string value. |
substr( source: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, starting: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, length?: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns a the portion of the source value beginning at the position indicated by the value of starting and counting fot the number of characters indicated by the value of length if provided, otherwise it length will be considered infinite.
The index of the first character of a string is 1.
See https://www.w3.org/TR/sparql11-query/#func-substr for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to extract the portion from. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the index from where to start the portion to take. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the number of characters of the portion to take. |
uCase( str: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the str value converted to uppercase.
See https://www.w3.org/TR/sparql11-query/#func-ucase for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to convert. |
lCase( str: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the str value converted to lowercase.
See https://www.w3.org/TR/sparql11-query/#func-lcase for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to convert. |
strStarts( arg1: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, arg2: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the true of the value if arg1 starts with the value of arg2, otherwise it returns false.
See https://www.w3.org/TR/sparql11-query/#func-strstarts for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check it starts with arg2. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check it's the start of arg1. |
strEnds( arg1: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, arg2: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the true if the value of arg1 ends with the value of arg2, otherwise it returns false.
See https://www.w3.org/TR/sparql11-query/#func-strends for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check it ends with arg2. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check it's the end of arg1. |
contains( arg1: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, arg2: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the true if the value of arg1 contains the value of arg2 as a substring, otherwise it returns false.
See https://www.w3.org/TR/sparql11-query/#func-strends for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check it contains arg2. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check it's contained by arg1. |
strBefore( arg1: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, arg2: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the part the arg1 value that precedes the first occurrence of arg2 value.
See https://www.w3.org/TR/sparql11-query/#func-strends for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check and return the preceded part. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check where it appears in arg1. |
strAfter( arg1: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, arg2: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the part the arg1 value that follows the first occurrence of arg2 value.
See https://www.w3.org/TR/sparql11-query/#func-strafter for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check and return the followed part. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to check where it appears in arg1. |
encodeForUri( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns a literal with the encoded special characters that the value of the literal provided may have.
See https://www.w3.org/TR/sparql11-query/#func-encode for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string value to encode. |
concat( ...literals: (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] ): ExpressionCreates an Expression that returns the concatenation of the string values of the literals provided.
See https://www.w3.org/TR/sparql11-query/#func-concat for more information.
Parameters
| Name | Type | Description |
|---|---|---|
Expressions with the string values to concatenate. | ||
| (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] |
langMatches( languageTag: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, languageRange: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns true if languageTag value matches languageRange as defined in Matching of Language.
See https://www.w3.org/TR/sparql11-query/#func-langMatches for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expressions with the language tag to be checked. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the language range that languageTag will be checked against. |
regex( text: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, pattern: RegExp ): ExpressionCreates an Expression that returns true if text value matches the pattern regular expression.
See https://www.w3.org/TR/sparql11-query/#func-regex for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expressions with string value to be checked. | |
| RegExp | Regex used as the matcher. |
replace( text: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, pattern: RegExp, replacement: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns a string produced by the text value by replacing each non-overlapping occurrence of the pattern regular expression with the replacement string.
See https://www.w3.org/TR/sparql11-query/#func-replace for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expressions with string value to replace with the respective replacement. | |
| RegExp | RegExp used as the matcher. | |
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression with the string or pattern to use as the replacement. |
abs( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the absolute value of term.
See https://www.w3.org/TR/sparql11-query/#func-abs for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expressions with the numeric value to get its absolute value. |
round( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the number with no fractional part that is closest to the term value. If there are two such numbers, then the one that is closest to positive infinity is returned.
See https://www.w3.org/TR/sparql11-query/#func-round for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expressions with the numeric value to get its round value. |
ceil( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the closest to negative infinity number with no fractional part that is closest to the term value.
See https://www.w3.org/TR/sparql11-query/#func-ceil for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expressions with the numeric value to get its ceil value. |
floor( term: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the closest to positive infinity number with no fractional part that is closest to the term value.
See https://www.w3.org/TR/sparql11-query/#func-floor for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expressions with the numeric value to get its floor value. |
rand(): ExpressionCreates an Expression that returns a pseudo-random number between 0 (inclusive) and 1.0e0 (exclusive).
See https://www.w3.org/TR/sparql11-query/#idp2130040 for more information.
now(): ExpressionCreates an Expression that returns a xsd:dateType value for the current query execution.
See https://www.w3.org/TR/sparql11-query/#func-now for more information.
year( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the year part of the dateTime value as an integer.
See https://www.w3.org/TR/sparql11-query/#func-year for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
month( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the month part of the dateTime value as an integer.
See https://www.w3.org/TR/sparql11-query/#func-month for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
day( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the day part of the dateTime value as an integer.
See https://www.w3.org/TR/sparql11-query/#func-day for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
hours( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the hours part of the dateTime value as an integer.
See https://www.w3.org/TR/sparql11-query/#func-hours for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
minutes( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the minutes part of the dateTime value as an integer.
See https://www.w3.org/TR/sparql11-query/#func-minutes for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
seconds( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the seconds part of the dateTime value as a decimal.
See https://www.w3.org/TR/sparql11-query/#func-seconds for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
timezone( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the timezone part of the dateTime value as an xsd:dayTimeDuration.
Beware that using a Date object will generate a literal in ISO 8601 format with the Z timezone.
See https://www.w3.org/TR/sparql11-query/#func-timezone for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
tz( dateTime: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the timezone part of the dateTime value as a string.
Beware that using a Date object will generate a literal in ISO 8601 format with the Z timezone.
See https://www.w3.org/TR/sparql11-query/#func-tz for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
md5( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the MD5 checksum, calculated on the UTF-8 representation of the string literal provided.
See https://www.w3.org/TR/sparql11-query/#func-md5 for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
sha1( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the SHA1 checksum, calculated on the UTF-8 representation of the string literal provided.
See https://www.w3.org/TR/sparql11-query/#func-sha1 for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
sha256( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the SHA256 checksum, calculated on the UTF-8 representation of the string literal provided.
See https://www.w3.org/TR/sparql11-query/#func-sha256 for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
sha384( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the SHA384 checksum, calculated on the UTF-8 representation of the string literal provided.
See https://www.w3.org/TR/sparql11-query/#func-sha384 for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
sha512( literal: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the SHA512 checksum, calculated on the UTF-8 representation of the string literal provided.
See https://www.w3.org/TR/sparql11-query/#func-sha512 for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> |
custom( resource: string | Resource, ...args: (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] ): ExpressionCreates an Expression that executes a function declared by a custom IRI.
See https://www.w3.org/TR/sparql11-query/#ririOrFunction for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | Resource | ||
| (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] |
customDistinct( resource: string | Resource, ...args: (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] ): ExpressionCreates an Expression that executes a function declared by a custom IRI reducing to only distinct arguments.
See https://www.w3.org/TR/sparql11-query/#ririOrFunction for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | Resource | ||
| (string | number | boolean | Date | Expression<ConditionalOrExpressionToken>)[] |
count( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that counts the number of times the given expression has a solution over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggCount for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to be counted |
countDistinct( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that counts the number of times the given expression has a bound for every distinct sequence over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggCount for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression to be counted |
countAll(): ExpressionCreates an Expression that counts the number of solutions over the group.
See https://www.w3.org/TR/sparql11-query/#defn_aggCount for more information.
countAllDistinct(): ExpressionCreates an Expression that counts the number of distinct solution sequences over the group.
See https://www.w3.org/TR/sparql11-query/#defn_aggCount for more information.
sum( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the value of the sum of the given expression's values over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggSum for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to be summed. |
sumDistinct( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the value of the sum of the given expression's values for every distinct sequence over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggSum for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to be summed. |
avg( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the average value of the given expression's values over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggAvg for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its average. |
avgDistinct( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the average value of the given expression's values for every distinct sequence over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggAvg for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its average. |
min( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the minimum value of the given expression's values over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggMin for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its minimum. |
minDistinct( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the minimum value of the given expression's values for every distinct sequence over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggMin for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its minimum. |
max( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the maximum value of the given expression's values over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggMax for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its maximum. |
maxDistinct( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns the maximum value of the given expression's values for every distinct sequence over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggMax for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its maximum. |
groupConcat( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, separator?: string ): ExpressionCreates an Expression that returns the string concatenation of the given expression's values over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggGroupConcat for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its maximum. | |
| string | Optional separator character used in the concatenation, where by default its a space. |
groupConcatDistinct( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken>, separator?: string ): ExpressionCreates an Expression that returns the string concatenation of the given expression's values for every distinct sequence over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggGroupConcat for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values to calculate its maximum. | |
| string | Optional separator character used in the concatenation, where by default its a space. |
sample( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns an arbitrary value from the given expression's values over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggSample for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values from where to select the value. |
sampleDistinct( expression: string | number | boolean | Date | Expression<ConditionalOrExpressionToken> ): ExpressionCreates an Expression that returns an arbitrary value from the given expression's values for every distinct sequence over the solution group.
See https://www.w3.org/TR/sparql11-query/#defn_aggSample for more information.
Parameters
| Name | Type | Description |
|---|---|---|
| string | number | boolean | Date | Expression<ConditionalOrExpressionToken> | Expression of the values from where to select the value. |
FunctionExpressionsBuilder
Description
Constant with the utils for FunctionExpressionsBuilder objects.
Methods
createFrom<O extends object>( container: Container<undefined>, object: O ): O & FunctionExpressionsBuilderFactory function that allows to crete a FunctionExpressionsBuilder from the object provided.
Parameters
| Name | Type | Description |
|---|---|---|
| Container<undefined> | The related container with the data for the | |
| O | The base base from where to create the |
Returns
The FunctionExpressionsBuilder statement created from the object provided.