| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| |
| <title>Apache Jena - Functions in ARQ</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <link href="/css/bootstrap.min.css" rel="stylesheet" media="screen"> |
| <link href="/css/bootstrap-icons.css" rel="stylesheet" media="screen"><link rel="stylesheet" type="text/css" href="https://jena.apache.org/sass/jena.1b17c39a117e22b46db4c66f6395dc27c134a60377d87d2d5745b8600eb69722.css" integrity="sha256-GxfDmhF+IrRttMZvY5XcJ8E0pgN32H0tV0W4YA62lyI="> |
| <link rel="shortcut icon" href="/images/favicon.ico" /> |
| |
| </head> |
| |
| <body> |
| |
| <nav class="navbar navbar-expand-lg bg-body-tertiary" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| <a class="navbar-brand" href="/index.html"> |
| <img class="logo-menu" src="/images/jena-logo/jena-logo-notext-small.png" alt="jena logo">Apache Jena</a> |
| </div> |
| |
| <div class="collapse navbar-collapse" id="navbarNav"> |
| <ul class="navbar-nav me-auto mb-2 mb-lg-0"> |
| <li id="homepage" class="nav-item"><a class="nav-link" href="/index.html"><span class="bi-house"></span> Home</a></li> |
| <li id="download" class="nav-item"><a class="nav-link" href="/download/index.cgi"><span class="bi-download"></span> Download</a></li> |
| <li class="nav-item dropdown"> |
| <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false"><span class="bi-journal"></span> Learn <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li class="dropdown-header">Tutorials</li> |
| <li><a class="dropdown-item" href="/tutorials/index.html">Overview</a></li> |
| <li><a class="dropdown-item" href="/documentation/fuseki2/index.html">Fuseki Triplestore</a></li> |
| <li><a class="dropdown-item" href="/documentation/notes/index.html">How-To's</a></li> |
| <li><a class="dropdown-item" href="/documentation/query/manipulating_sparql_using_arq.html">Manipulating SPARQL using ARQ</a></li> |
| <li><a class="dropdown-item" href="/tutorials/rdf_api.html">RDF core API tutorial</a></li> |
| <li><a class="dropdown-item" href="/tutorials/sparql.html">SPARQL tutorial</a></li> |
| <li><a class="dropdown-item" href="/tutorials/using_jena_with_eclipse.html">Using Jena with Eclipse</a></li> |
| <li class="dropdown-divider"></li> |
| <li class="dropdown-header">References</li> |
| <li><a class="dropdown-item" href="/documentation/index.html">Overview</a></li> |
| <li><a class="dropdown-item" href="/documentation/query/index.html">ARQ (SPARQL)</a></li> |
| <li><a class="dropdown-item" href="/documentation/io/">RDF I/O</a></li> |
| <li><a class="dropdown-item" href="/documentation/assembler/index.html">Assembler</a></li> |
| <li><a class="dropdown-item" href="/documentation/tools/index.html">Command-line tools</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdfs/">Data with RDFS Inferencing</a></li> |
| <li><a class="dropdown-item" href="/documentation/geosparql/index.html">GeoSPARQL</a></li> |
| <li><a class="dropdown-item" href="/documentation/inference/index.html">Inference API</a></li> |
| <li><a class="dropdown-item" href="/documentation/ontology/">Ontology API</a></li> |
| <li><a class="dropdown-item" href="/documentation/permissions/index.html">Permissions</a></li> |
| <li><a class="dropdown-item" href="/documentation/extras/querybuilder/index.html">Query Builder</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdf/index.html">RDF API</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdfconnection/">RDF Connection - SPARQL API</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdfstar/index.html">RDF-star</a></li> |
| <li><a class="dropdown-item" href="/documentation/shacl/index.html">SHACL</a></li> |
| <li><a class="dropdown-item" href="/documentation/shex/index.html">ShEx</a></li> |
| <li><a class="dropdown-item" href="/documentation/tdb/index.html">TDB</a></li> |
| <li><a class="dropdown-item" href="/documentation/tdb2/index.html">TDB2</a></li> |
| <li><a class="dropdown-item" href="/documentation/query/text-query.html">Text Search</a></li> |
| </ul> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false"><span class="bi-journal-code"></span> Javadoc <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a class="dropdown-item" href="/documentation/javadoc.html">All Javadoc</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/arq/">ARQ</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/fuseki2/">Fuseki</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/geosparql/">GeoSPARQL</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/jena/">Jena Core</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/permissions/">Permissions</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/extras/querybuilder/">Query Builder</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/shacl/">SHACL</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/tdb/">TDB</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/text/">Text Search</a></li> |
| </ul> |
| </li> |
| </ul> |
| <form class="d-flex" role="search" action="/search" method="GET"> |
| <div class="input-group"> |
| <input class="form-control border-end-0 border m-0" type="search" name="q" id="search-query" placeholder="Search...." aria-label="Search" style="width: 10rem;"> |
| <button class="btn btn-outline-secondary border-start-0 border" type="submit"> |
| <i class="bi-search"></i> |
| </button> |
| </div> |
| </form> |
| <ul class="navbar-nav"> |
| <li id="ask" class="nav-item"><a class="nav-link" href="/help_and_support/index.html" title="Ask"><span class="bi-patch-question"></span><span class="text-body d-none d-xxl-inline"> Ask</span></a></li> |
| |
| <li class="nav-item dropdown"> |
| <a href="#" title="Get involved" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false"><span class="bi-megaphone"></span><span class="text-body d-none d-xxl-inline"> Get involved </span><b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a class="dropdown-item" href="/getting_involved/index.html">Contribute</a></li> |
| <li><a class="dropdown-item" href="/help_and_support/bugs_and_suggestions.html">Report a bug</a></li> |
| <li class="dropdown-divider"></li> |
| <li class="dropdown-header">Project</li> |
| <li><a class="dropdown-item" href="/about_jena/about.html">About Jena</a></li> |
| <li><a class="dropdown-item" href="/about_jena/architecture.html">Architecture</a></li> |
| <li><a class="dropdown-item" href="/about_jena/citing.html">Citing</a></li> |
| <li><a class="dropdown-item" href="/about_jena/team.html">Project team</a></li> |
| <li><a class="dropdown-item" href="/about_jena/contributions.html">Related projects</a></li> |
| <li><a class="dropdown-item" href="/about_jena/roadmap.html">Roadmap</a></li> |
| <li><a class="dropdown-item" href="/about_jena/security-advisories.html">Security Advisories</a></li> |
| <li class="dropdown-divider"></li> |
| <li class="dropdown-header">ASF</li> |
| <li><a class="dropdown-item" href="https://www.apache.org/">Apache Software Foundation</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/licenses/LICENSE-2.0">License</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/security/">Security</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| </ul> |
| </li> |
| |
| |
| |
| |
| <li class="nav-item" id="edit"><a class="nav-link" href="https://github.com/apache/jena-site/edit/main/source/documentation/query/library-function.md" title="Edit this page on GitHub"><span class="bi-pencil-square"></span><span class="text-body d-none d-xxl-inline"> Edit this page</span></a></li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-12"> |
| |
| <div id="breadcrumbs"> |
|
|
|
|
|
|
|
|
|
|
|
|
| <ol class="breadcrumb mt-4 p-2 bg-body-tertiary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="breadcrumb-item"><a href='/documentation'>DOCUMENTATION</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="breadcrumb-item"><a href='/documentation/query'>QUERY</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="breadcrumb-item active">LIBRARY FUNCTION</li>
|
|
|
|
|
|
|
|
|
| </ol>
|
|
|
|
|
|
|
| |
| </div> |
| <h1 class="title">Functions in ARQ</h1> |
| |
| |
| <main class="d-flex flex-xl-row flex-column"> |
| |
| <aside class="text-muted align-self-start mb-3 p-0 d-xl-none d-block"> |
| <h2 class="h6 sticky-top m-0 p-2 bg-body-tertiary">On this page</h2> |
| <nav id="TableOfContents"> |
| <ul> |
| <li> |
| <ul> |
| <li><a href="#xqueryxpath-functions-and-operators-supported">XQuery/XPath Functions and Operators supported</a></li> |
| <li><a href="#function-library">Function Library</a></li> |
| <li><a href="#custom-aggregates">Custom Aggregates</a></li> |
| <li><a href="#additional-functions-provided-by-arq">Additional Functions Provided by ARQ</a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </aside> |
| <article class="flex-column me-lg-4"> |
| <p>The regular expressions for fan:localname and afn:namespace were incorrect. |
| SPARQL allows custom functions in expressions so that |
| queries can be used on domain-specific data. SPARQL defines a |
| function by URI (or prefixed name) in FILTER expressions. ARQ |
| provides a function library and supports application-provided |
| functions. Functions and property functions can be |
| <a href="extension.html">registered or dynamically loaded</a>.</p> |
| <p>Applications can also |
| <a href="writing_functions.html">provide their own functions</a>.</p> |
| <p>ARQ also provides an implementation the |
| <a href="http://www.dotnetrdf.org/leviathan">Leviathan Function Library</a>.</p> |
| <h3 id="xqueryxpath-functions-and-operators-supported">XQuery/XPath Functions and Operators supported</h3> |
| <p>ARQ supports the scalar functions and operators from |
| “<a href="https://www.w3.org/TR/xpath-functions-3/">XQuery 1.0 and XPath 2.0 Functions and Operators v3.1</a>”.</p> |
| <p>Functions in involving sequences are not supported.</p> |
| <p>See <a href="xsd-support.html">XSD Support</a> for details of datatypes and functions |
| currently supported. To check the exact current registrations, see |
| <tt><a href="https://github.com/apache/jena/blob/main/jena-arq/src/main/java/org/apache/jena/sparql/function/StandardFunctions.java">function/StandardFunctions.java</a></tt>.</p> |
| <p>See also the <a href="library-propfunc.html">property functions</a> library |
| page.</p> |
| <h3 id="function-library">Function Library</h3> |
| <p>The prefix <code>afn</code> is <code><http://jena.apache.org/ARQ/function#></code>. |
| (The old prefix of <code><http://jena.hpl.hp.com/ARQ/function#></code> continues to |
| work. Applications are encouraged to switch.)</p> |
| <p>Direct loading using a URI prefix of |
| <code><java:org.apache.jena.sparql.function.library.></code> (note the final |
| dot) is deprecated.</p> |
| <p>The prefix <code>fn</code> is <code><http://www.w3.org/2005/xpath-functions#></code> (the |
| XPath and XQuery function namespace).</p> |
| <p>The prefix <code>math</code> is <code><http://www.w3.org/2005/xpath-functions/math#></code>.</p> |
| <h3 id="custom-aggregates">Custom Aggregates</h3> |
| <p>The prefix <code>agg:</code> is <code><http://jena.apache.org/ARQ/function/aggregate#></code>.</p> |
| <p>The statistical aggregates are provided are:</p> |
| <p><code>agg:stdev</code>, <code>agg:stdev_samp</code>, <code>agg:stdev_pop</code>, |
| <code>agg:variance</code>, <code>agg:var_samp</code>, <code>agg:var_pop</code></p> |
| <p>These are modelled after SQL aggregate functions <code>STDEV</code>, <code>STDEV_SAMP</code>, <code>STDEV_POP</code>, |
| <code>VARIANCE</code>, <code>VAR_SAMP</code>, <code>VAR_POP</code>.</p> |
| <p>These, as keywords, are available in ARQ’s extended SPARQL (parse using <code>Syntax.syntaxARQ</code>).</p> |
| <h3 id="additional-functions-provided-by-arq">Additional Functions Provided by ARQ</h3> |
| <p>Most of these have equivalents, or near equivalents, in SPARQL or as an |
| XQuery function and are to be preferred. These ARQ-specific versions remain |
| for compatibility.</p> |
| <p><strong>RDF Graph Functions</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Function name</th> |
| <th>Description</th> |
| <th>Alternative</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>afn:bnode(?x)</code></td> |
| <td>Return the blank node label if ?x is a blank node.</td> |
| <td><code>STR(?x)</code></td> |
| </tr> |
| <tr> |
| <td><code>afn:localname(?x)</code></td> |
| <td>The local name of ?x</td> |
| <td><code>REPLACE(STR(?x), "^(.*)(/|#)([^#/]*)$", "$3")</code></td> |
| </tr> |
| <tr> |
| <td><code>afn:namespace(?x)</code></td> |
| <td>The namespace of ?x</td> |
| <td><code>REPLACE(STR(?x), "^(.*)(/|#)([^#/]*)$", "$1")</code></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The prefix and local name of a IRI is based on splitting the IRI, not on any prefixes in the query or dataset.</p> |
| <p><strong>String Functions</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Function name</th> |
| <th>Description</th> |
| <th>Alternative</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>afn:sprintf(format, v1, v2, ...)</code></td> |
| <td>Make a string from the format string and the RDF terms.</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><code>afn:substr(string, startIndex [,endIndex])</code></td> |
| <td>Substring, Java style using <em><code>startIndex</code></em> and <em><code>endIndex</code></em>.</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><code>afn:substring</code></td> |
| <td>Synonym for afn:substr</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><code>afn:strjoin(sep, string ...)</code></td> |
| <td>Concatenate string together, with a separator.</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><code>afn:sha1sum(resource)</code></td> |
| <td>Calculate the SHA1 checksum of a literal or URI</td> |
| <td><code>SHA1(STR(resource))</code></td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Notes:</p> |
| <ol> |
| <li>Strings in |
| “<a href="http://www.w3.org/TR/xpath-functions-3/">XQuery 1.0 and XPath 2.0 Functions and Operators</a>” |
| start from character position one, unlike Java and C# where |
| strings start from zero.</li> |
| <li>The <code>fn:substring</code> operation takes an optional length, like C# |
| but different from Java, where it is the <em>endIndex</em> of the first |
| character after the substring.</li> |
| <li><code>afn:substr</code> uses Java-style <em><code>startIndex</code></em> and <em><code>endIndex</code></em>.</li> |
| </ol> |
| <p><strong>Mathematical Functions</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Function name</th> |
| <th>Description</th> |
| <th>Alternative</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>afn:min(num1, num2)</code></td> |
| <td>Return the minimum of two numbers</td> |
| <td><code>fn:min</code></td> |
| </tr> |
| <tr> |
| <td><code>afn:max(num1, num2)</code></td> |
| <td>Return the maximum of two numbers</td> |
| <td><code>fn:max</code></td> |
| </tr> |
| <tr> |
| <td><code>afn:pi()</code></td> |
| <td>The value of pi, as an XSD double</td> |
| <td><code>math:pi()</code></td> |
| </tr> |
| <tr> |
| <td><code>afn:e()</code></td> |
| <td>The value of e, as an XSD double</td> |
| <td><code>math:exp(1)</code></td> |
| </tr> |
| <tr> |
| <td><code>afn:sqrt(num)</code></td> |
| <td>The square root of num</td> |
| <td><code>math:sqrt</code></td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Miscellaneous Functions</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Function name</th> |
| <th>Description</th> |
| <th>Alternative</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>afn:now()</code></td> |
| <td>Current time. Actually, the time the query started.</td> |
| <td><code>NOW()</code></td> |
| </tr> |
| <tr> |
| <td><code>afn:sha1sum(resource)</code></td> |
| <td>Calculate the SHA1 checksum</td> |
| <td><code>SHASUM</code></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| </article> |
| |
| <aside class="text-muted align-self-start mb-3 mb-xl-5 p-0 d-none d-xl-flex flex-column sticky-top"> |
| <h2 class="h6 sticky-top m-0 p-2 bg-body-tertiary">On this page</h2> |
| <nav id="TableOfContents"> |
| <ul> |
| <li> |
| <ul> |
| <li><a href="#xqueryxpath-functions-and-operators-supported">XQuery/XPath Functions and Operators supported</a></li> |
| <li><a href="#function-library">Function Library</a></li> |
| <li><a href="#custom-aggregates">Custom Aggregates</a></li> |
| <li><a href="#additional-functions-provided-by-arq">Additional Functions Provided by ARQ</a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </aside> |
| </main> |
| |
| </div> |
| </div> |
| </div> |
| |
| <footer class="bd-footer py-4 py-md-5 mt-4 mt-lg-5 bg-body-tertiary"> |
| <div class="container" style="font-size:80%" > |
| <p> |
| Copyright © 2011–2024 The Apache Software Foundation, Licensed under the |
| <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. |
| </p> |
| <p> |
| Apache Jena, Jena, the Apache Jena project logo, Apache and the Apache feather logos are trademarks of |
| The Apache Software Foundation. |
| <br/> |
| <a href="https://privacy.apache.org/policies/privacy-policy-public.html" |
| >Apache Software Foundation Privacy Policy</a>. |
| </p> |
| </div> |
| </footer> |
| |
| <script src="/js/popper.min.js.js" type="text/javascript"></script> |
| <script src="/js/bootstrap.min.js" type="text/javascript"></script> |
| <script src="/js/improve.js" type="text/javascript"></script> |
| |
| <script type="text/javascript"> |
| (function() { |
| 'use strict' |
| |
| |
| |
| const links = document.querySelectorAll(`a[href="${window.location.pathname}"]`) |
| if (links !== undefined && links !== null) { |
| for (const link of links) { |
| |
| link.classList.add('active') |
| let parentElement = link.parentElement |
| let count = 0 |
| const levelsLimit = 4 |
| |
| |
| |
| |
| |
| while (['UL', 'LI'].includes(parentElement.tagName) && count <= levelsLimit) { |
| if (parentElement.tagName === 'LI') { |
| |
| |
| |
| parentElement.querySelector('a:first-child').classList.add('active') |
| } |
| parentElement = parentElement.parentElement |
| count++ |
| } |
| } |
| } |
| })() |
| </script> |
| |
| </body> |
| </html> |
