| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>UserDefinedFunctionFactory (Apache Jena ARQ)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: org.apache.jena.arq, package: org.apache.jena.sparql.function.user, class: UserDefinedFunctionFactory"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/UserDefinedFunctionFactory.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../../module-summary.html">org.apache.jena.arq</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jena.sparql.function.user</a></div> |
| <h1 title="Class UserDefinedFunctionFactory" class="title">Class UserDefinedFunctionFactory</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.jena.sparql.function.user.UserDefinedFunctionFactory</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../FunctionFactory.html" title="interface in org.apache.jena.sparql.function">FunctionFactory</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">UserDefinedFunctionFactory</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../FunctionFactory.html" title="interface in org.apache.jena.sparql.function">FunctionFactory</a></span></div> |
| <div class="block">A function factory for managing user defined functions aka function macros. |
| <p> |
| User defined functions provide a simple mechanism for a user to inject custom |
| functions into SPARQL processing without the need to write any code. These |
| functions essentially act as macros/aliases for another SPARQL expression and |
| serve as a means to aid users in simplifying their SPARQL queries. |
| </p> |
| <p> |
| For example we can define a <strong>square</strong> function like so: |
| </p> |
| |
| <pre> |
| List<Var> args = new ArrayList<Var>(Var.alloc("x")); |
| UserDefinedFunctionFactory.getFactory().add("http://example/square", "?x * ?x", args); |
| </pre> |
| <p> |
| We can then use this in queries like so: |
| </p> |
| |
| <pre> |
| SELECT (<http://example/square>(3) AS ?ThreeSquared) { } |
| </pre> |
| <p> |
| Internally the call to the <strong>square</strong> function is translated |
| into its equivalent SPARQL expression and executed in that form. |
| </p> |
| <p> |
| User defined functions may rely on each other but this has some risks, |
| therefore the default behaviour is to not preserve these dependencies but |
| rather to expand the function definitions to give the resulting expression |
| associated with a function. Please see <a href="#getPreserveDependencies()"><code>getPreserveDependencies()</code></a> for |
| more information on this. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,java.lang.String,java.util.List)" class="member-name-link">add</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> expr, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../core/Var.html" title="class in org.apache.jena.sparql.core">Var</a>> args)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a function</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.jena.sparql.expr.Expr,java.util.List)" class="member-name-link">add</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri, |
| <a href="../../expr/Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a> e, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../core/Var.html" title="class in org.apache.jena.sparql.core">Var</a>> args)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a function</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clears all function definitions</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Function.html" title="interface in org.apache.jena.sparql.function">Function</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#create(java.lang.String)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a function for the given URI</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UserDefinedFunctionDefinition.html" title="class in org.apache.jena.sparql.function.user">UserDefinedFunctionDefinition</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.String)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the definition of the function (if registered)</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="UserDefinedFunctionFactory.html" title="class in org.apache.jena.sparql.function.user">UserDefinedFunctionFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getFactory()" class="member-name-link">getFactory</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets the static instance of the factory</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPreserveDependencies()" class="member-name-link">getPreserveDependencies</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets whether user defined functions may preserve dependencies on each |
| other (default false)</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRegistered(java.lang.String)" class="member-name-link">isRegistered</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets whether a function with the given URI has been registered</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(java.lang.String)" class="member-name-link">remove</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes a function definition</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPreserveDependencies(boolean)" class="member-name-link">setPreserveDependencies</a><wbr>(boolean allow)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets whether user functions may explicitly depend on each other, see |
| <a href="#getPreserveDependencies()"><code>getPreserveDependencies()</code></a> for explanation of this behavior</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getFactory()"> |
| <h3>getFactory</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="UserDefinedFunctionFactory.html" title="class in org.apache.jena.sparql.function.user">UserDefinedFunctionFactory</a></span> <span class="element-name">getFactory</span>()</div> |
| <div class="block">Gets the static instance of the factory</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Function Factory</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPreserveDependencies()"> |
| <h3>getPreserveDependencies</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getPreserveDependencies</span>()</div> |
| <div class="block">Gets whether user defined functions may preserve dependencies on each |
| other (default false) |
| <p> |
| When this is disabled (as it is by default) function definitions are |
| fully expanded at registration time. So if you add a function that |
| references an existing user defined function it will be expanded to |
| include the resulting expression rather than left with a reference to |
| another function. This protects the user from depending on other |
| functions whose definitions are later removed or changed. |
| </p> |
| <p> |
| However it may sometimes be desirable to have dependencies preserved |
| in which case this option may be disabled with the corresponding |
| <a href="#setPreserveDependencies(boolean)"><code>setPreserveDependencies(boolean)</code></a> setter |
| </p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Whether explicit dependencies are allowed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPreserveDependencies(boolean)"> |
| <h3>setPreserveDependencies</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPreserveDependencies</span><wbr><span class="parameters">(boolean allow)</span></div> |
| <div class="block">Sets whether user functions may explicitly depend on each other, see |
| <a href="#getPreserveDependencies()"><code>getPreserveDependencies()</code></a> for explanation of this behavior</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>allow</code> - Whether to preserve dependencies</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(java.lang.String)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Function.html" title="interface in org.apache.jena.sparql.function">Function</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</span></div> |
| <div class="block">Creates a function for the given URI</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../FunctionFactory.html#create(java.lang.String)">create</a></code> in interface <code><a href="../FunctionFactory.html" title="interface in org.apache.jena.sparql.function">FunctionFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - URI</dd> |
| <dt>Returns:</dt> |
| <dd>Function</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../sse/builders/SSE_ExprBuildException.html" title="class in org.apache.jena.sparql.sse.builders">SSE_ExprBuildException</a></code> - Thrown if the given URI is not a known function</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.jena.sparql.expr.Expr,java.util.List)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri, |
| <a href="../../expr/Expr.html" title="interface in org.apache.jena.sparql.expr">Expr</a> e, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../core/Var.html" title="class in org.apache.jena.sparql.core">Var</a>> args)</span></div> |
| <div class="block">Adds a function</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - URI</dd> |
| <dd><code>e</code> - Expression</dd> |
| <dd><code>args</code> - Arguments</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,java.lang.String,java.util.List)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> expr, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../core/Var.html" title="class in org.apache.jena.sparql.core">Var</a>> args)</span></div> |
| <div class="block">Adds a function |
| <p> |
| This method will build the expression to use based on the expression |
| string given, strings must match the SPARQL expression syntax e.g. |
| </p> |
| |
| <pre> |
| (?x * ?y) + 5 |
| </pre></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - URI</dd> |
| <dd><code>expr</code> - Expression String (in SPARQL syntax)</dd> |
| <dd><code>args</code> - Arguments</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../query/QueryParseException.html" title="class in org.apache.jena.query">QueryParseException</a></code> - Thrown if the expression string is not valid syntax</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(java.lang.String)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">remove</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</span></div> |
| <div class="block">Removes a function definition</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - URI</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/NoSuchElementException.html" title="class or interface in java.util" class="external-link">NoSuchElementException</a></code> - Thrown if a function with the given URI does not exist</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(java.lang.String)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UserDefinedFunctionDefinition.html" title="class in org.apache.jena.sparql.function.user">UserDefinedFunctionDefinition</a></span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</span></div> |
| <div class="block">Gets the definition of the function (if registered)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - URI</dd> |
| <dt>Returns:</dt> |
| <dd>Function Definition if registered, null otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRegistered(java.lang.String)"> |
| <h3>isRegistered</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRegistered</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> uri)</span></div> |
| <div class="block">Gets whether a function with the given URI has been registered</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - URI</dd> |
| <dt>Returns:</dt> |
| <dd>True if registered, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block">Clears all function definitions</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |